element-boilerplate
element-boilerplate copied to clipboard
Fork this repo if you want to start your own Web Component using VanillaJS
<my-repo>
A bare minimum custom element starter-kit using VanillaJS.
Like Yeoman? Use the generator-element instead.
Looking for a working example? Check hello-world-element.
Demo
Install
Install the component using Bower:
$ bower install my-repo --save
Or download as ZIP.
Usage
-
Import polyfill:
<script src="bower_components/webcomponentsjs/webcomponents.min.js"></script> -
Import custom element:
<link rel="import" href="bower_components/my-repo/my-element.html"> -
Start using it!
<my-element></my-element>
Options
| Attribute | Options | Default | Description |
|---|---|---|---|
foo |
string | bar |
Lorem ipsum dolor. |
Methods
| Method | Parameters | Returns | Description |
|---|---|---|---|
unicorn() |
None. | Nothing. | Magic stuff appears. |
Events
| Event | Description |
|---|---|
onsomething |
Triggers when something happens. |
Development
In order to run it locally you'll need to fetch some dependencies and a basic server setup.
-
$ npm install -g bower polyserve -
Install local dependencies:
$ bower install -
Start development server and open
http://localhost:8080/components/my-repo/.$ polyserve
History
For detailed changelog, check Releases.