JohnsonChung / hello-world-element

Web Component example using VanillaJS

<hello-world>

A Web Component example using VanillaJS.

Looking for a boilerplate? Check element-boilerplate.

Demo

Check it live!

Install

Install the component using Bower:

$ bower install hello-world-element --save

Or download as ZIP.

Usage

1. Import Web Components' polyfill:

   <script src="bower_components/webcomponentsjs/webcomponents.min.js"></script>

2. Import Custom Element:

   <link rel="import" href="bower_components/hello-world-element/src/hello-world.html">

3. Start using it!

   <hello-world></hello-world>

Options

Attribute	Options	Default	Description
who	string	World	Who do you want to say hello?

Development

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

1. Install Bower & Grunt:

   $ [sudo] npm install -g bower grunt-cli

2. Install local dependencies:

   $ bower install && npm install

3. To test your project, start the development server and open http://localhost:8000.

   $ grunt server

4. To provide a live demo, send everything to gh-pages branch.

   $ grunt deploy

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -m 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

History

For detailed changelog, check Releases.

License

MIT License © WebComponents.org