# bplokjs-pagination

> 生成pagination数据对象

Latest version **1.0.0** (published 2018-11-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install bplokjs-pagination
pnpm add bplokjs-pagination
yarn add bplokjs-pagination
bun add bplokjs-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 | 1.0.0 |
| Published | 2018-11-17 |
| First published | 2018-11-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | nobo.zhou@foxmail.com |
| Maintainers | bplok20010 |

## Links

- npm: https://www.npmjs.com/package/bplokjs-pagination
- Repository: https://github.com/bplokjs/pagination
- Homepage: https://github.com/bplokjs/pagination#readme
- Issues: https://github.com/bplokjs/pagination/issues
- npm.io page: https://npm.io/package/bplokjs-pagination

## Dependencies (1)

- [pagination-store](https://npm.io/package/pagination-store.md) ^1.0.0

## Recent versions

- 1.0.0 (latest) — 2018-11-17

## README

# bplokjs-pagination
生成pagination数据对象

## 安装

`npm install --save bplokjs-pagination`

## 构造函数

`Pagination({
    total: 100,
    current: 1,
    pageSize: 10,
    pageRange: 5
})`

## 属性

- `total` 总数
- `current` 当前页 默认为1
- `pageSize` 页码大小 默认为10
- `pageRange` 分页按钮显示的最大数 默认为5

## 方法

- `getCurrentRange( fn )` 获取当前分页的列表。

    该方法接收一个函数作为结果項进行处理

- `getPageTotal()` 获取页面总数
- `isFirstPage(pn)`  判断是否第一页
- `isLastPage(pn)` 作用同上
- `getNext()` 获取下一页的页码，如果不存在则返回null
- `getPrevious()` 作用同上
- `previous()` 翻页，上一页，如果失败则返回false
- `next()` 翻页，下一页，如果失败则返回false

## 示例

```
const pagination = new Pagination({
    total: 161,
    pageSize: 10,
    pageRange: 5
});

console.log( pagination.getCurrentRange() );

pagination.current = 8;

console.log( pagination.getCurrentRange() );

pagination.next();

console.log( pagination.getCurrentRange() );

```

```
//getCurrentRange() 返回示例
[ { page: 1, isCurrent: false },
  { page: null, isPreviousMore: true },
  { page: 7, isCurrent: false },
  { page: 8, isCurrent: false },
  { page: 9, isCurrent: true },
  { page: 10, isCurrent: false },
  { page: 11, isCurrent: false },
  { page: null, isNextMore: true },
  { page: 17, isCurrent: false } ]
```

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