Skip to content

eshbeata/polymer-ui-carousel

Repository files navigation

<polymer-ui-carousel>

A Polymer carousel element

Maintained by Addy Osmani.

Demo

Demo 1 and Demo 2.

Install

Install with Bower:

$ bower install --save polymer-ui-carousel

Usage

  1. Import Web Components' polyfill:
<script src="platform.js"></script>
  1. Import Custom Element:
<link rel="import" href="polymer-ui-carousel.html">
  1. Start using it!

With bullet controls:

  <polymer-ui-carousel>
    <div>One</div>
    <div>Two</div>
    <div>Three</div>
    <div>Four</div>
    <div>Five</div>
  </polymer-ui-carousel>

With text label controls:

  <polymer-ui-carousel labels="true">
    <div title="Alpha">One</div>
    <div title="Beta">Two</div>
    <div title="Gamma">Three</div>
    <div title="Delta">Four</div>
    <div title="Epsilon">Five</div>
  </polymer-ui-carousel>

Examples

Setup

In order to run it locally you'll need a basic server setup.

  1. Install Node.js

  2. Install Grunt:

    $ npm install --global grunt-cli
  3. Install local dependencies:

    $ npm install
  4. Run a local server and open http://localhost:8000.

    $ grunt connect

Options

Attribute Options Default Description
textLabels boolean false use custom text labels instead of the default bullet controls

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