ant-design/components/pagination/index.zh-CN.md
Arvin Xu dda650cc7b
docs: Update components cover ()
* docs: Update components cover



* docs: Update components cover
2020-06-05 13:50:09 +08:00

2.0 KiB
Raw Blame History

category subtitle type title cols cover
Components 分页 导航 Pagination 1 https://gw.alipayobjects.com/zos/alicdn/1vqv2bj68/Pagination.svg

采用分页的形式分隔长列表,每次只加载一个页面。

何时使用

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

API

<Pagination onChange={onChange} total={50} />
参数 说明 类型 默认值 版本
current 当前页数 number -
defaultCurrent 默认的当前页数 number 1
defaultPageSize 默认的每页条数 number 10
disabled 禁用分页 boolean -
hideOnSinglePage 只有一页时是否隐藏分页器 boolean false
itemRender 用于自定义页码的结构,可用于优化 SEO (page, type: 'page' | 'prev' | 'next', originalElement) => React.ReactNode -
pageSize 每页条数 number -
pageSizeOptions 指定每页可以显示多少条 string[] ['10', '20', '50', '100']
showLessItems 是否显示较少页面内容 boolean false
showQuickJumper 是否可以快速跳转至某页 boolean | { goButton: ReactNode } false
showSizeChanger 是否展示 pageSize 切换器,当 total 大于 50 时默认为 true boolean -
showTitle 是否显示原生 tooltip 页码提示 boolean true
showTotal 用于显示数据总量和当前数据顺序 Function(total, range) -
simple 当添加该属性时,显示为简单分页 boolean -
size 当为「small」时是小尺寸分页 'default' | 'small' ""
responsive 当 size 未指定时,根据屏幕宽度自动调整尺寸 boolean -
total 数据总数 number 0
onChange 页码改变的回调,参数是改变后的页码及每页条数 Function(page, pageSize) noop
onShowSizeChange pageSize 变化的回调 Function(current, size) noop