Taroify

Pagination 分页

介绍

数据量过多时，采用分页的形式将数据分隔，每次只加载一个页面。

引入

import { Pagination } from "@taroify/core"

代码演示

基础用法

通过 current 来绑定当前页码。

export default function BasicPagination() {
  const [current, setCurrent] = useState<number>(1)
  return <Pagination current={current} count={10} onChange={(page) => setCurrent(page)} />
}

简单模式

将 mode 设置为 simple 来切换到简单模式，此时分页器不会展示具体的页码按钮。

export default function BasicPagination() {
  const [current, setCurrent] = useState<number>(1)
  return (
    <Pagination current={current} count={10} mode="simple" onChange={(page) => setCurrent(page)} />
  )
}

显示省略号

设置 Pagination.Item.type 为 start-ellipsis 或者 end-ellipsis 展示省略号按钮，点击后可以快速跳转。

function PaginationWithEllipses() {
  const [current, setCurrent] = useState<number>(1)
  return (
    <Pagination current={current} siblingCount={1} count={13} onChange={(page) => setCurrent(page)}>
      <Pagination.Item type="start-ellipsis" />
      <Pagination.Item type="end-ellipsis" />
    </Pagination>
  )
}

自定义按钮

通过 Pagination.Item 组件来自定义分页按钮的内容。

function PaginationWithCustomButton() {
  const [current, setCurrent] = useState<number>(1)
  return (
    <Pagination current={current} count={6} onChange={(page) => setCurrent(page)}>
      <Pagination.Item type="previous">
        <ArrowLeft />
      </Pagination.Item>
      <Pagination.Item type="next">
        <ArrowRight />
      </Pagination.Item>
    </Pagination>
  )
}

API

Props

参数	说明	类型	默认值
current	当前页码	number	-
mode	显示模式，可选值为 simple	string	multi
prevText	上一页按钮文字	string	上一页
nextText	下一页按钮文字	string	下一页
siblingCount	当前页码两侧显示的数字个数	number	`2`
count	总页数	number	-

Events

事件名	说明	回调参数
onChange	页码改变时触发	-

主题定制

样式变量

组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 ConfigProvider 组件。

名称	默认值	描述
—pagination-height	40px $hd*	-
—pagination-font-size	var(—font-size-md)	-
—pagination-background-color	var(—white)	-
—pagination-item-min-width	36px $hd*	-
—pagination-item-color	var(—blue)	-
—pagination-item-active-color	var(—white)	-
—pagination-item-active-background-color	var(—pagination-item-color)	-
—pagination-item-disabled-color	var(—gray-7)	-
—pagination-item-disabled-background-color	var(—background-color)	-
—pagination-item-disabled-opacity	var(—disabled-opacity)	-
—pagination-button-padding	0 var(—padding-base)	-
—pagination-desc-color	var(—gray-7)	-