11# rc-pagination
2+
23---
34
45React Pagination Component.
56
67[ ![ NPM version] [ npm-image ]] [ npm-url ]
78[ ![ build status] [ travis-image ]] [ travis-url ]
89[ ![ Test coverage] [ coveralls-image ]] [ coveralls-url ]
10+ [ ![ codecov] ( https://codecov.io/gh/react-component/pagination/branch/master/graph/badge.svg )] ( https://codecov.io/gh/react-component/pagination )
911[ ![ Dependencies] ( https://img.shields.io/david/react-component/pagination.svg?style=flat-square )] ( https://david-dm.org/react-component/pagination )
1012[ ![ DevDependencies] ( https://img.shields.io/david/dev/react-component/pagination.svg?style=flat-square )] ( https://david-dm.org/react-component/pagination?type=dev )
1113[ ![ npm download] [ download-image ]] [ download-url ]
@@ -34,7 +36,7 @@ online example: http://react-component.github.io/pagination/examples/
3436
3537## Feature
3638
37- * support ie9,ie9+,chrome,firefox,safari
39+ - support ie9,ie9+,chrome,firefox,safari
3840
3941## Install
4042
@@ -50,34 +52,33 @@ React.render(<Pagination />, container);
5052
5153## API
5254
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-
55+ | Parameter | Description | Type | Default |
56+ | ------------------- | ----------------------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------------- |
57+ | disabled | disable pagination | Bool | - |
58+ | defaultCurrent | uncontrolled current page | Number | 1 |
59+ | current | current page | Number | undefined |
60+ | total | items total count | Number | 0 |
61+ | defaultPageSize | default items per page | Number | 10 |
62+ | pageSize | items per page | Number | 10 |
63+ | onChange | page change callback | Function(current, pageSize) | - |
64+ | showSizeChanger | show pageSize changer | Bool | false |
65+ | pageSizeOptions | specify the sizeChanger selections | Array<String > | [ '10', '20', '30', '40'] |
66+ | onShowSizeChange | pageSize change callback | Function(current, size) | - |
67+ | hideOnSinglePage | hide on single page | Bool | false |
68+ | showPrevNextJumpers | show jump-prev, jump-next | Bool | true |
69+ | showQuickJumper | show quick goto jumper | Bool / Object | false / {goButton: true} |
70+ | showTotal | show total records and range | Function(total, [ from, to] ) | - |
71+ | className | className of pagination | String | - |
72+ | simple | when set, show simple pager | Object | null |
73+ | locale | to set l10n config | Object | [ zh_CN] ( https://github.com/react-component/pagination/blob/master/src/locale/zh_CN.js ) |
74+ | style | the style of pagination | Object | {} |
75+ | showLessItems | show less page items | Bool | false |
76+ | showTitle | show page items title | Bool | true |
77+ | itemRender | custom page item renderer | Function(current, type: 'page' | 'prev' | 'next' | 'jump-prev' | 'jump-next', element): React.ReactNode | ` (current, type, element) => element ` |
78+ | prevIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
79+ | nextIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
80+ | jumpPrevIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
81+ | jumpNextIcon | specifict the default previous icon | ReactNode \| (props: PaginationProps) => ReactNode | |
8182
8283## License
8384
0 commit comments