Pagination分页
采用分页的形式分隔长列表,每次只加载一个页面。
何时使用
当加载/渲染所有数据将花费很多时间时;
可切换页码浏览数据。
代码演示
基础分页。
import { Pagination } from 'antd';
ReactDOM.render(<Pagination defaultCurrent={1} total={50} />, mountNode);
更多分页。
import { Pagination } from 'antd';
ReactDOM.render(<Pagination defaultCurrent={6} total={500} />, mountNode);
改变每页显示条目数。
import { Pagination } from 'antd';
function onShowSizeChange(current, pageSize) {
console.log(current, pageSize);
}
ReactDOM.render(
<div>
<Pagination
showSizeChanger
onShowSizeChange={onShowSizeChange}
defaultCurrent={3}
total={500}
/>
<br />
<Pagination
showSizeChanger
onShowSizeChange={onShowSizeChange}
defaultCurrent={3}
total={500}
disabled
/>
</div>,
mountNode,
);
快速跳转到某一页。
import { Pagination } from 'antd';
function onChange(pageNumber) {
console.log('Page: ', pageNumber);
}
ReactDOM.render(
<div>
<Pagination showQuickJumper defaultCurrent={2} total={500} onChange={onChange} />
<br />
<Pagination showQuickJumper defaultCurrent={2} total={500} onChange={onChange} disabled />
</div>,
mountNode,
);
迷你版本。
import { Pagination } from 'antd';
function showTotal(total) {
return `Total ${total} items`;
}
ReactDOM.render(
<div>
<Pagination size="small" total={50} />
<Pagination size="small" total={50} showSizeChanger showQuickJumper />
<Pagination size="small" total={50} showTotal={showTotal} />
</div>,
mountNode,
);
简单的翻页。
import { Pagination } from 'antd';
ReactDOM.render(<Pagination simple defaultCurrent={2} total={50} />, mountNode);
受控制的页码。
import { Pagination } from 'antd';
class App extends React.Component {
state = {
current: 3,
};
onChange = page => {
console.log(page);
this.setState({
current: page,
});
};
render() {
return <Pagination current={this.state.current} onChange={this.onChange} total={50} />;
}
}
ReactDOM.render(<App />, mountNode);
通过设置 showTotal
展示总共有多少数据。
import { Pagination } from 'antd';
ReactDOM.render(
<div>
<Pagination
total={85}
showTotal={total => `Total ${total} items`}
pageSize={20}
defaultCurrent={1}
/>
<br />
<Pagination
total={85}
showTotal={(total, range) => `${range[0]}-${range[1]} of ${total} items`}
pageSize={20}
defaultCurrent={1}
/>
</div>,
mountNode,
);
展示所有配置选项。
import { Pagination } from 'antd';
ReactDOM.render(
<div>
<Pagination
total={85}
showSizeChanger
showQuickJumper
showTotal={total => `Total ${total} items`}
/>
</div>,
mountNode,
);
修改上一步和下一步为文字链接。
import { Pagination } from 'antd';
function itemRender(current, type, originalElement) {
if (type === 'prev') {
return <a>Previous</a>;
}
if (type === 'next') {
return <a>Next</a>;
}
return originalElement;
}
ReactDOM.render(<Pagination total={500} itemRender={itemRender} />, mountNode);
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 大于 100 时默认为 true | boolean | - | |
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 |