https://github.com/vaadin-component-factory/vcf-paginator
Web Component for displaying a full functioning paginator on a webpage
https://github.com/vaadin-component-factory/vcf-paginator
Last synced: 3 months ago
JSON representation
Web Component for displaying a full functioning paginator on a webpage
- Host: GitHub
- URL: https://github.com/vaadin-component-factory/vcf-paginator
- Owner: vaadin-component-factory
- License: apache-2.0
- Created: 2019-04-30T13:21:25.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-10T10:50:23.000Z (over 4 years ago)
- Last Synced: 2025-02-10T02:47:53.902Z (3 months ago)
- Language: HTML
- Size: 82 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vcf-paginator Web Component
[](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[](https://vaadin.com/directory/component/vaadin-component-factoryvcf-paginator)
<vcf-paginator> is a Web Component providing an easy way to display a full functioning paginator on a webpage.
[Live Demo ↗](https://incubator.app.fi/paginator-demo/paginator)
[
](https://vaadin.com/directory/component/vaadinvcf-paginator)
## Usage
Add `` component to page. Set `total-pages` and `current-page` attributes for the component.
```html
```
## Installation
This components is distributed as Bower packages.
### Polymer 2 and HTML Imports compatible version
Install `vcf-paginator`:
```sh
bower i vaadin/vcf-paginator --save
```
Once installed, import it in your application:
```html
```
## Getting Started
Vaadin components use the Lumo theme by default.
## The file structure for Vaadin components
- `src/vcf-paginator.html`
Unstyled component.
- `theme/lumo/vcf-paginator.html`
Component with Lumo theme.
- `vcf-paginator.html`
Alias for theme/lumo/vcf-paginator.html
## Running demos and tests in browser
1. Fork the `vcf-paginator` repository and clone it locally.
1. Make sure you have [npm](https://www.npmjs.com/) installed.
1. When in the `vcf-paginator` directory, run `npm install` and then `bower install` to install dependencies.
1. Run `polymer serve --open`, browser will automatically open the component API documentation.
1. You can also open demo or in-browser tests by adding **demo** or **test** to the URL, for example:
- http://127.0.0.1:8080/components/vcf-paginator/demo
- http://127.0.0.1:8080/components/vcf-paginator/test
## Running tests from the command line
1. When in the `vcf-paginator` directory, run `polymer test`
## Following the coding style
We are using [ESLint](http://eslint.org/) for linting JavaScript code. You can check if your code is following our standards by running `gulp lint`, which will automatically lint all `.js` files as well as JavaScript snippets inside `.html` files.
## Contributing
- Make sure your code is compliant with our code linters: `gulp lint`
- Check that tests are passing: `polymer test`
- [Submit a pull request](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) with detailed title and description
- Wait for response from one of Vaadin components team members
## License & Author
This Add-on is distributed under Apache 2.0
Component Factory Paginator is written by Vaadin Ltd.
### Sponsored development
Major pieces of development of this add-on has been sponsored by multiple customers of Vaadin. Read more about Expert on Demand at: [Support](https://vaadin.com/support) and [Pricing](https://vaadin.com/pricing)