Back to Ant Design

Pagination

components/pagination/index.zh-CN.md

6.4.43.7 KB
Original Source

何时使用 {#when-to-use}

  • 当加载/渲染所有数据将花费很多时间时;
  • 可切换页码浏览数据。

代码演示 {#examples}

<!-- prettier-ignore -->

<code src="./demo/basic.tsx">基本</code> <code src="./demo/align.tsx" version="5.19.0">方向</code> <code src="./demo/more.tsx">更多</code> <code src="./demo/changer.tsx">改变</code> <code src="./demo/jump.tsx">跳转</code> <code src="./demo/mini.tsx">尺寸</code> <code src="./demo/simple.tsx">简洁</code> <code src="./demo/controlled.tsx">受控</code> <code src="./demo/total.tsx">总数</code> <code src="./demo/all.tsx">全部展示</code> <code src="./demo/itemRender.tsx">上一步和下一步</code> <code src="./demo/wireframe.tsx" debug>线框风格</code> <code src="./demo/component-token.tsx" debug>组件 Token</code> <code src="./demo/style-class.tsx" version="6.0.0">自定义语义结构的样式和类</code>

API

通用属性参考:通用属性

jsx
<Pagination onChange={onChange} total={50} />
参数说明类型默认值版本全局配置
align对齐方式start | center | end-5.19.0×
classNames自定义组件内部各语义化结构的类名。支持对象或函数Record<SemanticDOM, string> | (info: { props }) => Record<SemanticDOM, string>-6.0.0
current当前页数number-×
defaultCurrent默认的当前页数number1×
defaultPageSize默认的每页条数number10×
disabled禁用分页boolean-×
hideOnSinglePage只有一页时是否隐藏分页器booleanfalse×
itemRender用于自定义页码的结构,可用于优化 SEO(page, type: 'page' | 'prev' | 'next', originalElement) => React.ReactNode-×
pageSize每页条数number-×
pageSizeOptions指定每页可以显示多少条number[][10, 20, 50, 100]×
responsive当 size 未指定时,根据屏幕宽度自动调整尺寸boolean-×
showLessItems是否显示较少页面内容booleanfalse×
showQuickJumper是否可以快速跳转至某页boolean | { goButton: ReactNode }false×
showSizeChanger是否展示 pageSize 切换器boolean | SelectProps-SelectProps: 5.21.04.21.0,SelectProps: 5.21.0
showTitle是否显示原生 tooltip 页码提示booleantrue×
showTotal用于显示数据总量和当前数据顺序function(total, range)-×
simple当添加该属性时,显示为简单分页boolean | { readOnly?: boolean }-×
size组件尺寸large | medium | smallmedium×
styles自定义组件内部各语义化结构的内联样式。支持对象或函数Record<SemanticDOM, CSSProperties> | (info: { props }) => Record<SemanticDOM, CSSProperties>-6.0.0
total数据总数number0×
totalBoundaryShowSizeChangertotal 大于该值时,showSizeChanger 默认为 truenumber506.2.0
onChange页码或 pageSize 改变的回调,参数是改变后的页码及每页条数function(page, pageSize)-×
onShowSizeChangepageSize 变化的回调function(current, size)-×

Semantic DOM

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

主题变量(Design Token){#design-token}

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