0.0.9 • Published 7 years ago

dsc-polymer-carousel v0.0.9

Weekly downloads
-
License
MIT
Repository
-
Last release
7 years ago

<dsc-polymer-carousel>

Build Status Bower version NPM Version npm.io

A slideshow polymer component for cycling through elements, like a carousel. Similar to the carousel component of the bootstrap.

Commonly used at the top of the homepage of sites.

demo

Differential:

  • Easy to use
  • Optional parallax scroll effect
  • Custom content
  • Modern style
  • Swipe suport
  • Customizable style

Demo

$ git clone https://github.com/discovery-tecnologia/dsc-polymer-carousel.git
$ cd dsc-polymer-carousel
$ npm install
$ node install -g polymer-cli
$ polymer serve

Open browser: http://localhost:8080/components/dsc-polymer-carousel/demo/

Usage

Install with:

$ bower i dsc-polymer-carousel --save

Example usage:

<dsc-polymer-carousel interval="5" parallax>
  <section background="http://localhost:8080/components/dsc-polymer-carousel/demo/images/slide-2.jpg">
    <h1>Banner 1</h1>
    <p>Nam mattis porta mattis. Donec et neque scelerisque, pretium arcu sed, vehicula diam. Nam a arcu eu sapien porta<br>posuere id id arcu. Fusce rhoncus erat ut nisl pharetra.</p>
    <a href="#">View more</a>
  </section>
  <section background="http://localhost:8080/components/dsc-polymer-carousel/demo/images/slide-2.jpg">
    <h1>Banner 2</h1>
    <p>In aliquam orci ligula, nec tempus metus laoreet eget.<br>Proin ornare nibh condimentum leo elementum, at hendrerit turpis ultrices.</p>
    <a href="#">View more</a>
  </section>
</dsc-polymer-carousel>

API

PropertyDescriptionDefault
intervalTime in seconds for transition5
parallaxActive parallax scroll effectfalse

Content should be section tags. The optional "background" attribute of the section defines the background image.

Styling

Custom propertyDescriptionDefault
--carousel-heightCarousel height600px
--carousel-controlControl arrows{}
--carousel-control-leftLeft control arrow{}
--carousel-control-rightRight control arrow{}
--carousel-indicatorsBottom indicator container style{}
--carousel-indicators-liBottom indicator item style{}
--carousel-indicators-li-activeBottom indicator active item style{}

The sections should be stylized in the component where they were created.

Test

Check sintax and execute selenium tests.

$ npm test