thewebplatform / x-carousel

touch carousel for x-tag
Apache License 2.0
0 stars 0 forks source link

<x-carousel>

My awesome Custom Element

Demo

Check it live!

Install

Install the component using Bower:

$ bower install x-carousel --save

Or download as ZIP.

Usage

  1. Import Web Components' polyfill:

    <script src="https://github.com/thewebplatform/x-carousel/raw/master/bower_components/webcomponentsjs/webcomponents.min.js"></script>
  2. Import Custom Element:

    <link rel="import" href="https://github.com/thewebplatform/x-carousel/blob/master/bower_components/x-carousel/dist/x-carousel.html">
  3. Start using it!

    <x-carousel></x-carousel>

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.

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