Pagination

• 󰯣
• 1
• 2
• 3
• 󰽵
• 󰯱

导入

import {
  Pagination,
  PaginationContent,
  PaginationItem,
  PaginationLink,
  PaginationPrevious,
  PaginationNext,
  PaginationEllipsis,
} from "@pelagornis/page/components";

示例

上方预览渲染的就是这个文件。把它复制到 src/components/ 即可开始使用。

src/components/PaginationExample.tsx

import { useState } from "react";
import {
  Pagination,
  PaginationContent,
  PaginationEllipsis,
  PaginationItem,
  PaginationLink,
  PaginationNext,
  PaginationPrevious,
} from "@pelagornis/page/components";

const pages = [1, 2, 3];

export default function PaginationDemo() {
  const [page, setPage] = useState(1);

  return (
    <Pagination>
      <PaginationContent>
        <PaginationItem>
          <PaginationPrevious onClick={() => setPage((current) => Math.max(1, current - 1))} />
        </PaginationItem>
        {pages.map((item) => (
          <PaginationItem key={item}>
            <PaginationLink
              href="#"
              isActive={page === item}
              onClick={(event) => {
                event.preventDefault();
                setPage(item);
              }}
            >
              {item}
            </PaginationLink>
          </PaginationItem>
        ))}
        <PaginationItem>
          <PaginationEllipsis />
        </PaginationItem>
        <PaginationItem>
          <PaginationNext onClick={() => setPage((current) => Math.min(3, current + 1))} />
        </PaginationItem>
      </PaginationContent>
    </Pagination>
  );
}

在 MDX 中使用

Pagination 由共享 React 状态的多个部件组成。写在 MDX 中的子元素会各自渲染成独立的岛，部件之间无法互通。请像上面的示例一样在 .tsx 文件中组合，再导入该文件。

src/content/docs/example.mdx

---
title: Example
---

import PaginationExample from "../../components/PaginationExample";

<PaginationExample client:load />

client:load 会在页面加载时水合该岛。位于页面靠下位置的内容请使用 client:visible。

在 Markdoc 中使用

Markdoc 标签渲染的是 Astro 组件，而这个组件需要客户端状态。请把示例包进一个负责水合的 .astro 文件，再把该文件注册为标签。

src/components/markdoc/PaginationExample.astro

---
import PaginationExample from "../PaginationExample";
---

<PaginationExample client:load />

markdoc.config.mjs

import { component, defineMarkdocConfig } from "@astrojs/markdoc/config";
import starlightMarkdoc from "@astrojs/starlight-markdoc";
import pageMarkdoc from "@pelagornis/page/markdoc";

export default defineMarkdocConfig({
  extends: [starlightMarkdoc(), pageMarkdoc()],
  tags: {
    "pagination-example": {
      render: component("./src/components/markdoc/PaginationExample.astro"),
      selfClosing: true,
    },
  },
});

src/content/docs/example.mdoc

{% pagination-example /%}

结构

组件的组成部分，以及每个部分渲染的 data-refineui 角色。

部件	角色
root	pagination

状态

组件会设置样式的状态。组件状态通过 data 属性暴露。

类型	状态
伪类	focus-visible

键盘

组件获得焦点时处理的按键。

按键	动作
Enter	activate
Space	activate

参考

• 设计指南和令牌细节见 RefineUI · Pagination。
• 通用规则见在 MDX 中使用和在 Markdoc 中使用。