4221bd92ef
Bump braces from 3.0.2 to 3.0.3 |
||
---|---|---|
.devcontainer | ||
.github/workflows | ||
examples | ||
src | ||
test | ||
.eslintignore | ||
.eslintrc.json | ||
.gitattributes | ||
.gitignore | ||
CODEOWNERS | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
LICENSE | ||
README.md | ||
SECURITY.md | ||
custom-elements-manifest.config.js | ||
custom-elements.json | ||
package-lock.json | ||
package.json | ||
tsconfig.json | ||
vscode.html-custom-data.json | ||
web-dev-server.config.js | ||
web-test-runner.config.js |
README.md
<custom-element> element
Boilerplate for creating a custom element.
Installation
Available on npm as @github/custom-element-element.
$ npm install --save @github/custom-element-element
Usage
Script
Import as ES modules:
import '@github/custom-element-element'
Include with a script tag:
<script type="module" src="./node_modules/@github/custom-element-element/dist/index.js">
An example Custom Element. This documentation ends up in the README so describe how this elements works here.
You can event add examples on the element is used with Markdown.
<custom-element></custom-element>
Browser support
Browsers without native custom element support require a polyfill.
- Chrome
- Firefox
- Safari
- Microsoft Edge
License
Distributed under the MIT license. See LICENSE for details.