1
1
# rc-pagination
2
+
2
3
---
3
4
4
5
React Pagination Component.
@@ -34,7 +35,7 @@ online example: http://react-component.github.io/pagination/examples/
34
35
35
36
## Feature
36
37
37
- * support ie9,ie9+,chrome,firefox,safari
38
+ - support ie9,ie9+,chrome,firefox,safari
38
39
39
40
## Install
40
41
@@ -50,34 +51,33 @@ React.render(<Pagination />, container);
50
51
51
52
## API
52
53
53
- | Parameter | Description | Type | Default |
54
- | ------------------| ------------------------------------| ---------------| --------------------------|
55
- | disabled | disable pagination | Bool | - |
56
- | defaultCurrent | uncontrolled current page | Number | 1 |
57
- | current | current page | Number | undefined |
58
- | total | items total count | Number | 0 |
59
- | defaultPageSize | default items per page | Number | 10 |
60
- | pageSize | items per page | Number | 10 |
61
- | onChange | page change callback | Function(current, pageSize) | - |
62
- | showSizeChanger | show pageSize changer | Bool | false |
63
- | pageSizeOptions | specify the sizeChanger selections | Array<String > | [ '10', '20', '30', '40'] |
64
- | onShowSizeChange | pageSize change callback | Function(current, size) | - |
65
- | hideOnSinglePage | hide on single page | Bool | false |
66
- | showPrevNextJumpers | show jump-prev, jump-next | Bool | true |
67
- | showQuickJumper | show quick goto jumper | Bool / Object | false / {goButton: true} |
68
- | showTotal | show total records and range | Function(total, [ from, to] ) | - |
69
- | className | className of pagination | String | - |
70
- | simple | when set, show simple pager | Object | null |
71
- | locale | to set l10n config | Object | [ zh_CN] ( https://github.com/react-component/pagination/blob/master/src/locale/zh_CN.js ) |
72
- | style | the style of pagination | Object | {} |
73
- | showLessItems | show less page items | Bool | false |
74
- | showTitle | show page items title | Bool | true |
75
- | itemRender | custom page item renderer | Function(current, type: 'page' | 'prev' | 'next' | 'jump-prev' | 'jump-next', element): React.ReactNode| ` (current, type, element) => element ` |
76
- | prevIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
77
- | nextIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
78
- | jumpPrevIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
79
- | jumpNextIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
80
-
54
+ | Parameter | Description | Type | Default |
55
+ | ------------------- | ----------------------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------------- |
56
+ | disabled | disable pagination | Bool | - |
57
+ | defaultCurrent | uncontrolled current page | Number | 1 |
58
+ | current | current page | Number | undefined |
59
+ | total | items total count | Number | 0 |
60
+ | defaultPageSize | default items per page | Number | 10 |
61
+ | pageSize | items per page | Number | 10 |
62
+ | onChange | page change callback | Function(current, pageSize) | - |
63
+ | showSizeChanger | show pageSize changer | Bool | false |
64
+ | pageSizeOptions | specify the sizeChanger selections | Array<String > | [ '10', '20', '30', '40'] |
65
+ | onShowSizeChange | pageSize change callback | Function(current, size) | - |
66
+ | hideOnSinglePage | hide on single page | Bool | false |
67
+ | showPrevNextJumpers | show jump-prev, jump-next | Bool | true |
68
+ | showQuickJumper | show quick goto jumper | Bool / Object | false / {goButton: true} |
69
+ | showTotal | show total records and range | Function(total, [ from, to] ) | - |
70
+ | className | className of pagination | String | - |
71
+ | simple | when set, show simple pager | Object | null |
72
+ | locale | to set l10n config | Object | [ zh_CN] ( https://github.com/react-component/pagination/blob/master/src/locale/zh_CN.js ) |
73
+ | style | the style of pagination | Object | {} |
74
+ | showLessItems | show less page items | Bool | false |
75
+ | showTitle | show page items title | Bool | true |
76
+ | itemRender | custom page item renderer | Function(current, type: 'page' | 'prev' | 'next' | 'jump-prev' | 'jump-next', element): React.ReactNode | ` (current, type, element) => element ` |
77
+ | prevIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
78
+ | nextIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
79
+ | jumpPrevIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
80
+ | jumpNextIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
81
81
82
82
## License
83
83
0 commit comments