Skip to content

Commit 7632736

Browse files
author
刘欢
committed
feat: update onChange signature to include recommendPage in info object
1 parent f9b453b commit 7632736

5 files changed

Lines changed: 100 additions & 72 deletions

File tree

‎README.md‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -68,41 +68,41 @@ Then open `http://localhost:8000`.
6868

6969
### Pagination
7070

71-
| Property | Type | Default | Description |
72-
| ---------------------------- | ------------------------------------------ | -------------------------------------- | ----------------------------------------------- |
73-
| align | `'start' \| 'center' \| 'end'` | - | Align pagination items. |
74-
| className | `string` | - | Class name for the root element. |
75-
| classNames | `Partial<Record<'item', string>>` | - | Semantic class names. |
76-
| current | `number` | - | Controlled current page. |
77-
| defaultCurrent | `number` | `1` | Initial current page. |
78-
| defaultPageSize | `number` | `10` | Initial page size. |
79-
| disabled | `boolean` | `false` | Disable pagination interactions. |
80-
| hideOnSinglePage | `boolean` | `false` | Hide when there is only one page. |
81-
| itemRender | `(page, type, element) => ReactNode` | - | Customize page, previous, next, and jump items. |
82-
| jumpNextIcon | `ReactNode \| ComponentType` | - | Custom next-jump icon. |
83-
| jumpPrevIcon | `ReactNode \| ComponentType` | - | Custom previous-jump icon. |
84-
| locale | `PaginationLocale` | `zh_CN` | Locale text. |
85-
| nextIcon | `ReactNode \| ComponentType` | - | Custom next icon. |
86-
| pageSize | `number` | - | Controlled page size. |
87-
| pageSizeOptions | `number[]` | - | Page-size options. |
88-
| prefixCls | `string` | `rc-pagination` | Class name prefix. |
89-
| prevIcon | `ReactNode \| ComponentType` | - | Custom previous icon. |
90-
| role | `React.AriaRole` | - | WAI-ARIA role. |
91-
| selectPrefixCls | `string` | `rc-select` | Prefix for the size changer select. |
92-
| showLessItems | `boolean` | `false` | Show fewer page items. |
93-
| showPrevNextJumpers | `boolean` | `true` | Show previous and next jumpers. |
94-
| showQuickJumper | `boolean \| object` | `false` | Show quick page jumper. |
95-
| showSizeChanger | `boolean` | `total > totalBoundaryShowSizeChanger` | Show page-size changer. |
96-
| showTitle | `boolean` | `true` | Show title on page items. |
97-
| showTotal | `(total, range) => ReactNode` | - | Render total text. |
98-
| simple | `boolean \| { readOnly?: boolean }` | `false` | Use simple pager. |
99-
| sizeChangerRender | `SizeChangerRender` | - | Customize the size changer. |
100-
| style | `React.CSSProperties` | - | Root inline style. |
101-
| styles | `Partial<Record<'item', CSSProperties>>` | - | Semantic styles. |
102-
| total | `number` | `0` | Total item count. |
103-
| totalBoundaryShowSizeChanger | `number` | `50` | Boundary for default `showSizeChanger`. |
104-
| onChange | `(page: number, pageSize: number) => void` | - | Triggered when page or page size changes. |
105-
| onShowSizeChange | `(current: number, size: number) => void` | - | Triggered when page size changes. |
71+
| Property | Type | Default | Description |
72+
| ---------------------------- | ----------------------------------------------------------------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
73+
| align | `'start' \| 'center' \| 'end'` | - | Align pagination items. |
74+
| className | `string` | - | Class name for the root element. |
75+
| classNames | `Partial<Record<'item', string>>` | - | Semantic class names. |
76+
| current | `number` | - | Controlled current page. |
77+
| defaultCurrent | `number` | `1` | Initial current page. |
78+
| defaultPageSize | `number` | `10` | Initial page size. |
79+
| disabled | `boolean` | `false` | Disable pagination interactions. |
80+
| hideOnSinglePage | `boolean` | `false` | Hide when there is only one page. |
81+
| itemRender | `(page, type, element) => ReactNode` | - | Customize page, previous, next, and jump items. |
82+
| jumpNextIcon | `ReactNode \| ComponentType` | - | Custom next-jump icon. |
83+
| jumpPrevIcon | `ReactNode \| ComponentType` | - | Custom previous-jump icon. |
84+
| locale | `PaginationLocale` | `zh_CN` | Locale text. |
85+
| nextIcon | `ReactNode \| ComponentType` | - | Custom next icon. |
86+
| pageSize | `number` | - | Controlled page size. |
87+
| pageSizeOptions | `number[]` | - | Page-size options. |
88+
| prefixCls | `string` | `rc-pagination` | Class name prefix. |
89+
| prevIcon | `ReactNode \| ComponentType` | - | Custom previous icon. |
90+
| role | `React.AriaRole` | - | WAI-ARIA role. |
91+
| selectPrefixCls | `string` | `rc-select` | Prefix for the size changer select. |
92+
| showLessItems | `boolean` | `false` | Show fewer page items. |
93+
| showPrevNextJumpers | `boolean` | `true` | Show previous and next jumpers. |
94+
| showQuickJumper | `boolean \| object` | `false` | Show quick page jumper. |
95+
| showSizeChanger | `boolean` | `total > totalBoundaryShowSizeChanger` | Show page-size changer. |
96+
| showTitle | `boolean` | `true` | Show title on page items. |
97+
| showTotal | `(total, range) => ReactNode` | - | Render total text. |
98+
| simple | `boolean \| { readOnly?: boolean }` | `false` | Use simple pager. |
99+
| sizeChangerRender | `SizeChangerRender` | - | Customize the size changer. |
100+
| style | `React.CSSProperties` | - | Root inline style. |
101+
| styles | `Partial<Record<'item', CSSProperties>>` | - | Semantic styles. |
102+
| total | `number` | `0` | Total item count. |
103+
| totalBoundaryShowSizeChanger | `number` | `50` | Boundary for default `showSizeChanger`. |
104+
| onChange | `(page: number, pageSize: number, info?: { recommendPage?: number }) => void` | - | Triggered when page or page size changes. The `info.recommendPage` is only provided when pageSize changes, indicating the recommended page number based on the new page size. |
105+
| onShowSizeChange | `(current: number, size: number) => void` | - | Triggered when page size changes. |
106106

107107
## Development
108108

0 commit comments

Comments
 (0)