| 名称 | 类型 | 默认值 | 说明 |
|---|
page | number | 1 | 当前页码,从 1 开始。 |
pageSize | number | 10 | 每页条目数。 |
total | number | 0 | 总条目数。 |
totalItems | number | — | 总条目数,total 的原版名字。同时设置时优先于 total 和 totalPages。 |
label | string | Pagination / 分页 | 导航区的无障碍名称。 |
showSizeChanger | boolean | false | 是否显示每页数量选择器。 |
pageSizeOptions | number[] | [10, 20, 50, 100] | 每页数量选项。 |
showTotal | boolean | false | 是否显示总条目数。 |
isDisabled | boolean | false | 是否禁用。 |
disabled | boolean | false | isDisabled 的旧名字,任一为真即禁用。 |
prevLabel | string | Previous / 上一页 | 上一页按钮文字。未设置语言时为英文,提供 zh-CN 后为中文。 |
nextLabel | string | Next / 下一页 | 下一页按钮文字。未设置语言时为英文,提供 zh-CN 后为中文。 |
pageSizeLabel | string | Per page / 每页 | 每页数量选择器的标签。未设置语言时为英文,提供 zh-CN 后为中文。 |
variant | 'pages' | 'count' | 'compact' | 'dots' | 'input' | 'none' | 'pages' | 中间区域。 input 是可输入的页码。 |
siblingCount | number | 1 | 页码形态下,当前页两侧各留几个页码。窄容器会再收一档。 |
step | number | 1 | 上一页和下一页每次跳几页。 |
hasMore | boolean | — | 总数未知时,后面是否还有内容。total 大于 0 时以总条目数为准。 |
pageLabel | string | Page / 页 | input 形态里,输入框前面的名词。 |
hasFirstLast | boolean | 仅 input 且总页数已知 | 是否在上一页和下一页外侧放跳到首尾的按钮。 |
changeAction | (page: number) => void | Promise<void> | — | 页码提交后再跑的动作。结束前控件标成忙碌,失败也不会把页码改回去。 |
| 名称 | 载荷 | 说明 |
|---|
update:page | page: number | 页码变化时触发。 |
update:pageSize | pageSize: number | 每页数量变化时触发。 |
pageSizeChange | pageSize: number | 每页数量变化时触发,在页码回到第一页之前发出。 |
change | page: number, pageSize: number | 页码或每页数量变化时触发。 |
| 名称 | 参数 | 说明 |
|---|
total | { total, from, to } | 自定义总数显示。 |