# custom-element-boilerplate

**Repository Path**: mirrors_github/custom-element-boilerplate

## Basic Information

- **Project Name**: custom-element-boilerplate
- **Description**: Boilerplate for creating a custom element.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# <custom-element> element

Boilerplate for creating a custom element.

## Installation
Available on [npm](https://www.npmjs.com/) as [**@github/custom-element-element**](https://www.npmjs.com/package/@github/custom-element-element).
```
$ npm install --save @github/custom-element-element
```

## Usage

### Script

Import as ES modules:

```js
import '@github/custom-element-element'
```

Include with a script tag:

```html
<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][support] require a [polyfill][].
- Chrome
- Firefox
- Safari
- Microsoft Edge

[support]: https://caniuse.com/custom-elementsv1
[polyfill]: https://github.com/webcomponents/custom-elements

## License

Distributed under the MIT license. See LICENSE for details.