Back to Ant Design

Pagination

components/pagination/index.en-US.md

6.3.73.5 KB
Original Source

When To Use

  • When it will take a long time to load/render all items.
  • If you want to browse the data by navigating through pages.

Examples

<!-- prettier-ignore -->

<code src="./demo/basic.tsx">Basic</code> <code src="./demo/align.tsx" version="5.19.0">Align</code> <code src="./demo/more.tsx">More</code> <code src="./demo/changer.tsx">Changer</code> <code src="./demo/jump.tsx">Jumper</code> <code src="./demo/mini.tsx">Size</code> <code src="./demo/simple.tsx">Simple mode</code> <code src="./demo/controlled.tsx">Controlled</code> <code src="./demo/total.tsx">Total number</code> <code src="./demo/all.tsx">Show All</code> <code src="./demo/itemRender.tsx">Prev and next</code> <code src="./demo/wireframe.tsx" debug>Wireframe</code> <code src="./demo/component-token.tsx" debug>component Token</code> <code src="./demo/style-class.tsx" version="6.0.0">Custom semantic dom styling</code>

API

Common props ref:Common props

jsx
<Pagination onChange={onChange} total={50} />
PropertyDescriptionTypeDefaultVersion
alignAlignstart | center | end-5.19.0
classNamesCustomize class for each semantic structure inside the component. Supports object or functionRecord<SemanticDOM, string> | (info: { props }) => Record<SemanticDOM, string>-
currentCurrent page numbernumber-
defaultCurrentDefault initial page numbernumber1
defaultPageSizeDefault number of data items per pagenumber10
disabledDisable paginationboolean-
hideOnSinglePageWhether to hide pager on single pagebooleanfalse
itemRenderTo customize item's innerHTML(page, type: 'page' | 'prev' | 'next', originalElement) => React.ReactNode-
pageSizeNumber of data items per pagenumber-
pageSizeOptionsSpecify the sizeChanger optionsnumber[][10, 20, 50, 100]
responsiveIf size is not specified, Pagination would resize according to the width of the windowboolean-
showLessItemsShow less page itemsbooleanfalse
showQuickJumperDetermine whether you can jump to pages directlyboolean | { goButton: ReactNode }false
showSizeChangerDetermine whether to show pageSize selectboolean | SelectProps-SelectProps: 5.21.0
totalBoundaryShowSizeChangerWhen total larger than it, showSizeChanger will be truenumber50
showTitleShow page item's titlebooleantrue
showTotalTo display the total number and rangefunction(total, range)-
simpleWhether to use simple modeboolean | { readOnly?: boolean }-
sizeComponent sizelarge | medium | smallmedium
stylesCustomize inline style for each semantic structure inside the component. Supports object or functionRecord<SemanticDOM, CSSProperties> | (info: { props }) => Record<SemanticDOM, CSSProperties>-
totalTotal number of data itemsnumber0
onChangeCalled when the page number or pageSize is changed, and it takes the resulting page number and pageSize as its argumentsfunction(page, pageSize)-
onShowSizeChangeCalled when pageSize is changedfunction(current, size)-

Semantic DOM

<code src="./demo/_semantic.tsx" simplify="true"></code>

Design Token

<ComponentTokenTable component="Pagination"></ComponentTokenTable>