# @uiw/react-pagination

> Pagination component

Latest version **4.22.3** (published 2023-11-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @uiw/react-pagination
pnpm add @uiw/react-pagination
yarn add @uiw/react-pagination
bun add @uiw/react-pagination
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; has provenance.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 4.22.3 |
| Published | 2023-11-29 |
| First published | 2020-05-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 36.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 740 |
| Author | Kenny Wong |
| Maintainers | uiwjs, wcjiang |
| Keywords | pagination, react-pagination, design, uiw, uiw-react, react.js, react, react-component, component, components, ui, css, uikit, react-ui, framework, front-end, frontend |

## Links

- npm: https://www.npmjs.com/package/@uiw/react-pagination
- Repository: https://github.com/uiwjs/uiw
- Homepage: https://uiwjs.github.io/#/components/pagination
- Issues: https://github.com/uiwjs/uiw/issues
- Funding: https://jaywcjlove.github.io/#/sponsor
- npm.io page: https://npm.io/package/@uiw/react-pagination

## Dependencies (2)

- [@uiw/utils](https://npm.io/package/@uiw/utils.md) ^4.22.3
- [@uiw/react-select](https://npm.io/package/@uiw/react-select.md) ^4.22.3

## Alternatives

- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@progress/kendo-vue-listbox](https://npm.io/package/@progress/kendo-vue-listbox.md) — 932 weekly downloads

## Recent versions

- 4.22.3 (latest) — 2023-11-29
- 5.0.0-bate.2.1 (bate) — 2023-03-10
- 4.22.2 — 2023-11-09
- 4.22.1 — 2023-11-08
- 4.22.0 — 2023-09-19
- 4.21.28 — 2023-05-05
- 4.21.27 — 2023-04-21
- 4.21.26 — 2023-04-20
- 4.21.25 — 2023-03-14
- 4.21.24 — 2023-03-08
- 5.0.0-bate.2.0 — 2023-03-02
- 4.21.23 — 2022-12-21
- 4.21.22 — 2022-12-19
- 4.21.21 — 2022-12-19
- 5.0.0-bate-19 — 2022-12-12
- … 156 more at https://npm.io/package/@uiw/react-pagination/versions

## README

Pagination 分页
===

[![Buy me a coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee-048754?logo=buymeacoffee)](https://jaywcjlove.github.io/#/sponsor)
[![Open in unpkg](https://img.shields.io/badge/Open%20in-unpkg-blue)](https://uiwjs.github.io/npm-unpkg/#/pkg/@uiw/react-pagination/file/README.md)
[![NPM Downloads](https://img.shields.io/npm/dm/@uiw/react-pagination.svg?style=flat)](https://www.npmjs.com/package/@uiw/react-pagination)
[![npm version](https://img.shields.io/npm/v/@uiw/react-pagination.svg?label=@uiw/react-pagination)](https://npmjs.com/@uiw/react-pagination)

当数据量较多时，使用分页可以快速进行数据切换，每次只加载一个页面。

```jsx
import { Pagination } from 'uiw';
// or
import Pagination from '@uiw/react-pagination';
```

### 基本用法

```jsx mdx:preview&bg=#fff
import React from 'react';
import { Pagination, Divider } from 'uiw';

export default function Demo() {
  const [pageObj, setPageObj] = React.useState({
    current: 2,
    pageSize: 10
  });
  return (
    <div>
      <Pagination
        current={pageObj.current}
        pageSize={pageObj.pageSize}
        total={30}
        divider
        pageSizeOptions={[5, 10, 20, 30]}
        onShowSizeChange={(current, pageSize) => setPageObj({
          current: current,
          pageSize: pageSize
        })}
      />
      <Divider />
      <Pagination current={2} pageSize={10} total={38} divider />
      <Divider />
      <Pagination current={1} pageSize={5} total={249} pageSizeOptions={[5, 10, 20, 30]} />
      <Divider />
      <Pagination current={1} alignment="center" pageSize={10} total={50} />
      <Divider />
      <Pagination current={1} pageSize={10} total={60} divider />
      <Divider />
      <Pagination current={1} pageSize={10} total={70} divider />
    </div>
  )
}
```

### 迷你分页

```jsx mdx:preview&bg=#fff
import React from 'react';
import { Pagination, Divider } from 'uiw';

export default function Demo() {
  return (
    <div>
      <Pagination size="small" current={1} pageSize={5} pageSizeOptions={[5, 10, 20, 30]} total={249} />
      <Divider />
      <Pagination size="small" current={1} pageSize={10} total={50} />
    </div>
  );
}
```

### 对齐

目前有三种对齐方式 `左边(left)`、`中间(center)`、`右边(right)`。

```jsx mdx:preview&bg=#fff
import React from 'react';
import { Pagination, Divider } from 'uiw';

export default function Demo() {
  return (
    <div>
      <Pagination
        current={5}
        total={250}
        onChange={(pageNumber) => { 
          console.log(`pageNumber:${pageNumber}`)
        }}
      />
      <Divider />
      <Pagination
        current={1}
        alignment="center"
        total={250}
        onChange={(pageNumber) => { 
          console.log(`pageNumber:${pageNumber}`)
        }}
      />
      <Divider />
      <Pagination
        current={25}
        alignment="right"
        total={250}
        onChange={(pageNumber) => { 
          console.log(`pageNumber:${pageNumber}`)
        }}
      />
    </div>
  );
}
```

### Props

| 参数 | 说明 | 类型 | 默认值 |
|------ |-------- |---------- |-------- |
| current | 当前页数，选中的页数 | Number | 1 |
| total | 数据总数 | Number | 0 |
| pageSize | 每页条数 | Number | 10 |
| pageSizeOptions | 指定每页可以显示多少条 | Number[] | - |
| divider | 页码之间是否间隔 | Boolean | - |
| size | 当为 `small` 时，是小尺寸分页 | Enum{`small`, `default`} | - |
| alignment | 对齐 | Enum{`left`, `center`, `right`} | `left` |
| onChange | 页码改变的回调，返回改变后的页码 | Function(current, total, pageSize) | - |
| onShowSizeChange | pageSize 变化的回调 | Function(current, pageSize) | - |

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