/paper-carousel

Web component to build a responsive carousel

Primary LanguageHTMLMIT LicenseMIT

Published on webcomponents.org

Paper-carousel

Description

Polymer element for displaying a responsive carousel

Install

First you need bower, see their site for details

bower install --save Redbility/paper-carousel

Examples

A simple example of its use:

<paper-carousel items="3" responsive="600:2, 460:1" controls="true" dots="true" dotText="false">
	<div class="paper-carousel-demo-indigo" data-text="#1"></div>
	<div class="paper-carousel-demo-pink" data-text="#2"></div>
	<div class="paper-carousel-demo-teal" data-text="#3"></div>
	<div class="paper-carousel-demo-amber" data-text="#4"></div>
	<div class="paper-carousel-demo-blue" data-text="#5"></div>
	<div class="paper-carousel-demo-green" data-text="#6"></div>
</paper-carousel>

Image gallery example:

<paper-carousel items="1" dotText="false">
	<img src="https://unsplash.it/800/500/?image=257" draggable="false"/>
	<img src="https://unsplash.it/800/500/?image=250" draggable="false"/>
	<img src="https://unsplash.it/800/500/?image=399" draggable="false"/>
	<img src="https://unsplash.it/800/500/?image=146" draggable="false"/>
	<img src="https://unsplash.it/800/500/?image=248" draggable="false"/>
</paper-carousel>

Attributes

Attribute Name Functionality Type Default
items Number of slides shown on each page Number 1
responsive String that contains information about breakpoints String null
controls Shows or hides the forward and backward page controls Boolean true
dots Shows or hides the navigation dots Boolean true
dotText Shows or hides numbers inside dots Boolean true
prevIcon Allows customize the prev arrow icon String image:navigate-before
nextIcon Allows customize the next arrow icon String image:navigate-next

Methods

Method Name Explanation
getTotalItems() Gets the number of total items inside carousel
getTotalPages() Gets the number of total pages of carousel
getCurrentItem() Gets the active item
goToItem(number) Moves carousel to the item position
goToNextItem() Moves carousel to the next item
goToPrevItem() Moves carousel to the prev item
getCurrentPage() Gets the active page
goToPage(number) Moves carousel to the page position
goToNextPage() Moves carousel to the next page
goToPrevPage() Moves carousel to the prev page
refresh() Forces carousel reload