Skip to content

Commit c1ad179

Browse files
afc163afc163
committed
docs: refine bilingual README branding
1 parent f8e1490 commit c1ad179

2 files changed

Lines changed: 40 additions & 42 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<div align="center">
22
<h1>@rc-component/pagination</h1>
3-
<p><sub>Part of the Ant Design ecosystem.</sub></p>
4-
<img alt="Ant Design" height="32" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" />
3+
<p><sub><img alt="Ant Design" height="14" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" style="vertical-align: -0.125em;" /> Part of the Ant Design ecosystem.</sub></p>
54
<p>📄 React pagination primitives for page navigation, size changing, quick jumping, and locale-aware controls.</p>
65
</div>
76

‎README.zh-CN.md‎

Lines changed: 39 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<div align="center">
22
<h1>@rc-component/pagination</h1>
3-
<p><sub>Ant Design 生态的一部分。</sub></p>
4-
<img alt="Ant Design" height="32" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" />
3+
<p><sub><img alt="Ant Design" height="14" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" style="vertical-align: -0.125em;" /> Ant Design 生态的一部分。</sub></p>
54
<p>📄 React 分页组件，支持页码、快速跳转、尺寸切换和本地化。</p>
65
</div>
76

@@ -22,11 +21,11 @@
2221

2322
## 特性
2423

25-
- Controlled and uncontrolled pagination state.
26-
- Page-size changer, quick jumper, simple mode, compact item count, and custom item rendering.
27-
- Locale packages exposed from `@rc-component/pagination/locale/*`.
28-
- Semantic `classNames` and `styles` for item-level customization.
29-
- TypeScript definitions for props, locale, callbacks, and state.
24+
- 受控和非受控分页状态。
25+
- 页面大小更改器、快速跳转、简单模式、紧凑项目计数和自定义项目渲染。
26+
- 从 `@rc-component/pagination/locale/*` 公开的语言环境包。
27+
- 用于项目级自定义的语义 `classNames` 和 `styles`。
28+
- 属性、本地化、回调和状态的 TypeScript 定义。
3029
- 被 Ant Design 用作共享的 pagination 基础能力。
3130

3231
## 安装
@@ -75,39 +74,39 @@ npm start
7574

7675
| 参数 | 类型 | 默认值 | 说明 |
7776
| ---------------------------- | ------------------------------------------ | -------------------------------------- | ----------------------------------------------- |
78-
| align | `'start' \| 'center' \| 'end'` | - | Align pagination items. |
79-
| className | `string` | - | Class name for the root element. |
80-
| classNames | `Partial<Record<'item', string>>` | - | Semantic class names. |
81-
| current | `number` | - | Controlled current page. |
82-
| defaultCurrent | `number` | `1` | Initial current page. |
83-
| defaultPageSize | `number` | `10` | Initial page size. |
84-
| disabled | `boolean` | `false` | Disable pagination interactions. |
85-
| hideOnSinglePage | `boolean` | `false` | Hide when there is only one page. |
86-
| itemRender | `(page, type, element) => ReactNode` | - | Customize page, previous, next, and jump items. |
87-
| jumpNextIcon | `ReactNode \| ComponentType` | - | Custom next-jump icon. |
88-
| jumpPrevIcon | `ReactNode \| ComponentType` | - | Custom previous-jump icon. |
89-
| locale | `PaginationLocale` | `zh_CN` | Locale text. |
90-
| nextIcon | `ReactNode \| ComponentType` | - | Custom next icon. |
91-
| pageSize | `number` | - | Controlled page size. |
92-
| pageSizeOptions | `number[]` | - | Page-size options. |
93-
| prefixCls | `string` | `rc-pagination` | Class name prefix. |
94-
| prevIcon | `ReactNode \| ComponentType` | - | Custom previous icon. |
77+
| align | `'start' \| 'center' \| 'end'` | - | 对齐分页项目。 |
78+
| className | `string` | - | 根元素的className。 |
79+
| classNames | `Partial<Record<'item', string>>` | - | 语义className。 |
80+
| 当前的 | `number` | - | 控制当前页面。 |
81+
| defaultCurrent | `number` | `1` | 初始当前页面。 |
82+
| defaultPageSize | `number` | `10` | 初始页面大小。 |
83+
| disabled | `boolean` | `false` | 禁用分页交互。 |
84+
| hideOnSinglePage | `boolean` | `false` | 当只有一页时隐藏。 |
85+
| itemRender | `(page, type, element) => ReactNode` | - | 自定义页面、上一个、下一个和跳转项目。 |
86+
| jumpNextIcon | `ReactNode \| ComponentType` | - | 自定义下一跳图标。 |
87+
| jumpPrevIcon | `ReactNode \| ComponentType` | - | 自定义上一跳转图标。 |
88+
| 语言环境 | `PaginationLocale` | `zh_CN` | 区域设置文本。 |
89+
| nextIcon | `ReactNode \| ComponentType` | - | 自定义下一个图标。 |
90+
| pageSize | `number` | - | 受控的页面大小。 |
91+
| pageSizeOptions | `number[]` | - | 页面大小选项。 |
92+
| prefixCls | `string` | `rc-pagination` | className前缀。 |
93+
| prevIcon | `ReactNode \| ComponentType` | - | 自定义上一个图标。 |
9594
| role | `React.AriaRole` | - | WAI-ARIA role. |
96-
| selectPrefixCls | `string` | `rc-select` | Prefix for the size changer select. |
97-
| showLessItems | `boolean` | `false` | Show fewer page items. |
98-
| showPrevNextJumpers | `boolean` | `true` | Show previous and next jumpers. |
99-
| showQuickJumper | `boolean \| object` | `false` | Show quick page jumper. |
100-
| showSizeChanger | `boolean` | `total > totalBoundaryShowSizeChanger` | Show page-size changer. |
101-
| showTitle | `boolean` | `true` | Show title on page items. |
102-
| showTotal | `(total, range) => ReactNode` | - | Render total text. |
95+
| selectPrefixCls | `string` | `rc-select` | 尺寸变换器选择的前缀。 |
96+
| showLessItems | `boolean` | `false` | 显示较少的页面项目。 |
97+
| showPrevNextJumpers | `boolean` | `true` | 显示上一个和下一个跳线。 |
98+
| showQuickJumper | `boolean \| object` | `false` | 显示快速跳页。 |
99+
| showSizeChanger | `boolean` | `total > totalBoundaryShowSizeChanger` | 显示页面大小更改器。 |
100+
| showTitle | `boolean` | `true` | 在页面项目上显示标题。 |
101+
| showTotal | `(total, range) => ReactNode` | - | 渲染总文本。 |
103102
| simple | `boolean \| { readOnly?: boolean }` | `false` | Use simple pager. |
104-
| sizeChangerRender | `SizeChangerRender` | - | Customize the size changer. |
105-
| style | `React.CSSProperties` | - | Root inline style. |
106-
| styles | `Partial<Record<'item', CSSProperties>>` | - | Semantic styles. |
107-
| total | `number` | `0` | Total item count. |
108-
| totalBoundaryShowSizeChanger | `number` | `50` | Boundary for default `showSizeChanger`. |
109-
| onChange | `(page: number, pageSize: number) => void` | - | Triggered when page or page size changes. |
110-
| onShowSizeChange | `(current: number, size: number) => void` | - | Triggered when page size changes. |
103+
| sizeChangerRender | `SizeChangerRender` | - | 定制尺寸变换器。 |
104+
| 风格 | `React.CSSProperties` | - | 根内联样式。 |
105+
| styles | `Partial<Record<'item', CSSProperties>>` | - | 语义化样式。 |
106+
| total | `number` | `0` | 项目总数。 |
107+
| totalBoundaryShowSizeChanger | `number` | `50` | 默认的边界 `showSizeChanger`。 |
108+
| onChange | `(page: number, pageSize: number) => void` | - | 当页面或页面大小更改时触发。 |
109+
| onShowSizeChange | `(current: number, size: number) => void` | - | 当页面大小改变时触发。 |
111110

112111
## 本地开发
113112

@@ -127,11 +126,11 @@ npm run build
127126
npm run prepublishOnly
128127
```
129128

130-
The release flow is handled by `@rc-component/np` through the `rc-np` command after the package build.
129+
包构建完成后，发布流程由 `@rc-component/np` 通过 `rc-np` 命令处理。
131130

132131
## 许可证
133132

134-
@rc-component/pagination is released under the [MIT](./LICENSE.md) license.
133+
@rc-component/pagination 基于 [MIT](./LICENSE.md) 许可证发布。
135134

136135
[npm-image]: https://img.shields.io/npm/v/@rc-component/pagination.svg?style=flat-square
137136
[npm-url]: https://npmjs.org/package/@rc-component/pagination

0 commit comments

Comments
 (0)