Home

Awesome

<my-repo>

A bare minimum custom element starter-kit using X-Tag.

Like Yeoman? Use the generator-element instead.

Looking for a working example? Check hello-world-xtag.

Demo

Check it live!

Install

Install the component using Bower:

$ bower install my-repo --save

Or download as ZIP.

Usage

  1. Import polyfill:

    <script src="bower_components/webcomponentsjs/webcomponents.min.js"></script>
    
  2. Import custom element:

    <link rel="import" href="bower_components/my-repo/my-element.html">
    
  3. Start using it!

    <my-element></my-element>
    

Options

AttributeOptionsDefaultDescription
foostringbarLorem ipsum dolor.

Methods

MethodParametersReturnsDescription
unicorn()None.Nothing.Magic stuff appears.

Events

EventDescription
onsomethingTriggers when something happens.

Development

In order to run it locally you'll need to fetch some dependencies and a basic server setup.

  1. Install bower & polyserve:

    $ npm install -g bower polyserve
    
  2. Install local dependencies:

    $ bower install
    
  3. Start development server and open http://localhost:8080/components/my-repo/.

    $ polyserve
    

History

For detailed changelog, check Releases.

License

MIT License