My awesome Custom Element
Install the component using Bower:
$ bower install x-carousel --save
Or download as ZIP.
Import Web Components' polyfill:
<script src="https://github.com/thewebplatform/x-carousel/raw/master/bower_components/webcomponentsjs/webcomponents.min.js"></script>
Import Custom Element:
<link rel="import" href="https://github.com/thewebplatform/x-carousel/blob/master/bower_components/x-carousel/dist/x-carousel.html">
Start using it!
<x-carousel></x-carousel>
Attribute | Options | Default | Description |
---|---|---|---|
foo |
string | bar |
Lorem ipsum dolor. |
Method | Parameters | Returns | Description |
---|---|---|---|
unicorn() |
None. | Nothing. | Magic stuff appears. |
Event | Description |
---|---|
onsomething |
Triggers when something happens. |
In order to run it locally you'll need to fetch some dependencies and a basic server setup.
$ [sudo] npm install -g bower gulp
Install local dependencies:
$ bower install && npm install
To test your project, start the development server and open http://localhost:8000
.
$ gulp server
To build the distribution files before releasing a new version.
$ gulp build
To provide a live demo, send everything to gh-pages
branch.
$ gulp deploy
git checkout -b my-new-feature
git commit -m 'Add some feature'
git push origin my-new-feature
For detailed changelog, check Releases.