# @kano/kwc-pagination

> UI for pagination

Latest version **3.3.14** (published 2020-06-19) · 0 weekly downloads

## Install

```sh
npm install @kano/kwc-pagination
pnpm add @kano/kwc-pagination
yarn add @kano/kwc-pagination
bun add @kano/kwc-pagination
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.3.14 |
| Published | 2020-06-19 |
| First published | 2018-05-22 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 15.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | alexb-kano, alicemarshall, chaitz, charlie-kano, hicksatkano, holographicleah, joe-thom, kanocomputing, onishiweb, rpazdera, ting88003355, tomkano, wassupduck |

## Links

- npm: https://www.npmjs.com/package/@kano/kwc-pagination
- npm.io page: https://npm.io/package/@kano/kwc-pagination

## Dependencies (4)

- [@kano/styles](https://npm.io/package/@kano/styles.md) ^3.3.14
- [@kano/kwc-icons](https://npm.io/package/@kano/kwc-icons.md) ^3.0.0-beta.3
- [@polymer/polymer](https://npm.io/package/@polymer/polymer.md) ^3.0.0
- [@polymer/iron-icon](https://npm.io/package/@polymer/iron-icon.md) ^3.0.1

## Recent versions

- 3.3.14 (latest) — 2020-06-19
- 3.0.18 — 2019-06-04
- 3.0.17 — 2019-05-23
- 3.0.16 — 2019-05-20
- 3.0.15 — 2019-05-03
- 3.0.14 — 2019-03-18
- 3.0.12 — 2019-03-13
- 3.0.6 — 2019-01-28
- 3.0.0-beta.1 — 2018-05-22

## README

# \<kwc-pagination\>

A configurable page navigation bar.

<img width="673" src="https://user-images.githubusercontent.com/169328/58256498-04f85d80-7d67-11e9-84ee-b81c29fcece3.png">


## Installation

Grab it from the NPM repository and add it as a dependency of your project with

```
yarn add @kano/kwc-pagination
```

## Usage

```js
import '@kano/kwc-pagination/kwc-pagination.js';

html`
    <kwc-pagination jump-controls pagination-controls total-pages="360" current-page="7"></kwc-pagination>
`;
```

## API

The following properties are available:

 - `startsOn`: A number defining the start page for the navigation bar
 - `totalPages`: A number defining the total number of pages available
 - `currentPage`: A number defining the selected page
 - `range`: A number defining the number of pages to display between the bar controls
 - `paginationControls`: Turn on or off the next and previous buttons
 - `jumpControls`: Turn on or off the got to last and got to first buttons
 - `lastPage`: Turn on or off showing the last page at the end

This element dispatches one event: `go-to-page`. This event signals that the user chose a page to go to. Use this data to update the selected page

---
_Source: https://npm.io/package/@kano/kwc-pagination · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._