Skip to content

Commit 0e75525

Browse files
hengkxhengkx
authored
docs: pageSizeOptions default value (#261)
* fix: pageSizeOptions default value * Revert "fix: pageSizeOptions default value" This reverts commit 66b8ecf. * Update README.md
1 parent 2435542 commit 0e75525

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

‎README.md‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -48,34 +48,34 @@ ReactDOM.render(<Pagination />, container);
4848

4949
## API
5050

51-
| Parameter | Description | Type | Default |
52-
| ------------------- | ----------------------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------------- |
53-
| disabled | disable pagination | Bool | - |
54-
| defaultCurrent | uncontrolled current page | Number | 1 |
55-
| current | current page | Number | undefined |
56-
| total | items total count | Number | 0 |
57-
| defaultPageSize | default items per page | Number | 10 |
58-
| pageSize | items per page | Number | 10 |
59-
| onChange | page change callback | Function(current, pageSize) | - |
60-
| showSizeChanger | show pageSize changer | Bool | `false` when total less then `totalBoundaryShowSizeChanger`, `true` when otherwise |
61-
| totalBoundaryShowSizeChanger | when total larger than it, `showSizeChanger` will be true | number | 50 |
62-
| pageSizeOptions | specify the sizeChanger selections | Array<String> | ['10', '20', '30', '40'] |
63-
| onShowSizeChange | pageSize change callback | Function(current, size) | - |
64-
| hideOnSinglePage | hide on single page | Bool | false |
65-
| showPrevNextJumpers | show jump-prev, jump-next | Bool | true |
66-
| showQuickJumper | show quick goto jumper | Bool / Object | false / {goButton: true} |
67-
| showTotal | show total records and range | Function(total, [from, to]) | - |
68-
| className | className of pagination | String | - |
69-
| simple | when set, show simple pager | Object | null |
70-
| locale | to set l10n config | Object | [zh_CN](https://github.com/react-component/pagination/blob/master/src/locale/zh_CN.js) |
71-
| style | the style of pagination | Object | {} |
72-
| showLessItems | show less page items | Bool | false |
73-
| showTitle | show page items title | Bool | true |
74-
| itemRender | custom page item renderer | Function(current, type: 'page' | 'prev' | 'next' | 'jump-prev' | 'jump-next', element): React.ReactNode | `(current, type, element) => element` |
75-
| prevIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
76-
| nextIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
77-
| jumpPrevIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
78-
| jumpNextIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
51+
| Parameter | Description | Type | Default |
52+
| ---------------------------- | --------------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------------- |
53+
| disabled | disable pagination | Bool | - |
54+
| defaultCurrent | uncontrolled current page | Number | 1 |
55+
| current | current page | Number | undefined |
56+
| total | items total count | Number | 0 |
57+
| defaultPageSize | default items per page | Number | 10 |
58+
| pageSize | items per page | Number | 10 |
59+
| onChange | page change callback | Function(current, pageSize) | - |
60+
| showSizeChanger | show pageSize changer | Bool | `false` when total less then `totalBoundaryShowSizeChanger`, `true` when otherwise |
61+
| totalBoundaryShowSizeChanger | when total larger than it, `showSizeChanger` will be true | number | 50 |
62+
| pageSizeOptions | specify the sizeChanger selections | Array<String> | ['10', '20', '50', '100'] |
63+
| onShowSizeChange | pageSize change callback | Function(current, size) | - |
64+
| hideOnSinglePage | hide on single page | Bool | false |
65+
| showPrevNextJumpers | show jump-prev, jump-next | Bool | true |
66+
| showQuickJumper | show quick goto jumper | Bool / Object | false / {goButton: true} |
67+
| showTotal | show total records and range | Function(total, [from, to]) | - |
68+
| className | className of pagination | String | - |
69+
| simple | when set, show simple pager | Object | null |
70+
| locale | to set l10n config | Object | [zh_CN](https://github.com/react-component/pagination/blob/master/src/locale/zh_CN.js) |
71+
| style | the style of pagination | Object | {} |
72+
| showLessItems | show less page items | Bool | false |
73+
| showTitle | show page items title | Bool | true |
74+
| itemRender | custom page item renderer | Function(current, type: 'page' | 'prev' | 'next' | 'jump-prev' | 'jump-next', element): React.ReactNode | `(current, type, element) => element` |
75+
| prevIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
76+
| nextIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
77+
| jumpPrevIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
78+
| jumpNextIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
7979

8080
## License
8181

0 commit comments

Comments
 (0)