paper-pager - Vaadin Add-on Directory
A light and accesible Material Design page indicator[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg?style=flat-square)](https://www.webcomponents.org/element/myfrom/paper-pager)
[![Build Status](https://img.shields.io/travis/rust-lang/rust.svg?style=flat-square)](https://travis-ci.org/myfrom/paper-pager)
[![npm](https://img.shields.io/npm/v/@myfrom/paper-pager.svg?style=flat-square)](https://www.npmjs.com/package/@myfrom/paper-pager)
# paper-pager
`paper-pager` is a Material Design page indicator that is easy to customise and allows controlling the selected page by clicking on the pager.
## Installation
Make sure you have installed NPM, then simply run
`$ npm install --save @myfrom/paper-pager`
Newer versions of this element work only with Polymer 3.
For backwards compatibility use versions 1.x
## Usage
Import the element
```js
import '@myfrom/paper-pager';
```
and then just use it as normal element.
```html
```
**If you want it to work on older browsers you must compile it from ES6 to ES5.**
The default item count is 3, you can set it either by specyfing `itemsCount` property (takes a number) or binding an Array of items to `items` property (this will basically set `itemsCount` to length of provided array).
Property `selected` is the index of currently selected page, can be updated by clicking on dots representing each page.
**Check out [documentation](https://www.webcomponents.org/element/myfrom/paper-pager/elements/paper-pager) for more info**
## Contributing
If you found a bug or have an idea for a new feature, be sure to open an issue **but first check if there isn't one open already**. I'm also very happy to see any Pull Requests, but to save you and me some work, comment on issues if you are planning to work on them - that way you make sure two people won't do the same thing :wink:
### Local development and testing
For local development use **[Polymer CLI](https://www.polymer-project.org/3.0/docs/tools/polymer-cli)**. It's a very easy tool for working on Polymer apps and elements. Serve your element with `$ polymer serve` and **before you submit a PR** run
```bash
$ polymer lint
$ polymer test
```
## Credits
Made by me, inspired by Google's Material Design page indicator that can be seen in different places across Android N.
Other resources:
- http://stackoverflow.com/questions/26423335
## License
Shared on MIT license, check [LICENSE](LICENSE)
GitHub HomepageIssue tracker
View on GitHub
License
Online Demo
Documentation
View on NPM
paper-pager version 0.1.0
### Dependencies
* polymer#Polymer/polymer#1.7.0
* iron-selector#PolymerElements/iron-selector#^1.5.2
paper-pager version 1.0.0
### Dependencies
* polymer#Polymer/polymer#1.9 - 2
* iron-selector#PolymerElements/iron-selector#1 - 2
* iron-a11y-keys-behavior#PolymerElements/iron-a11y-keys-behavior#1 - 2
paper-pager version 1.0.1
### Dependencies
* polymer#Polymer/polymer#1.9 - 2
* iron-selector#PolymerElements/iron-selector#1 - 2
* iron-a11y-keys-behavior#PolymerElements/iron-a11y-keys-behavior#1 - 2
paper-pager version 2.0.0
### Dependencies
* @polymer/iron-a11y-keys-behavior#^3.0.1
* @polymer/iron-selector#^3.0.1
* @polymer/polymer#^3.0.5