<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="https://raw.githubusercontent.com/github/custom-element-boilerplate/main/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.