章节
组件
import {
Pagination,
PaginationContent,分页把长结果集拆成带页码的链接,并配上上一页与下一页控件。底下没有基元——一个 nav 地标包裹普通锚点,每个锚点通过 Button 渲染,并按新粗野主义配方设计:粗边框、硬阴影、加粗字体。
适合以下场景:
- 搜索与列表页——商品网格、招聘板、目录,用户需要直接跳到第 12 页。
- 数据表格——在管理视图里与仅图标变体、每页行数选择器搭配。
- 博客与文档归档——真正的
<a>链接让每一页都有可抓取的 URL,无限滚动做不到这一点。
安装#
pnpm dlx shadcn@latest add https://neobrutalism.com/r/base/pagination.jsonnpx shadcn@latest add https://neobrutalism.com/r/base/pagination.jsonyarn dlx shadcn@latest add https://neobrutalism.com/r/base/pagination.jsonbunx --bun shadcn@latest add https://neobrutalism.com/r/base/pagination.json
将以下代码复制并粘贴到您的项目中。
import * as React from "react"
import {
ChevronLeftIcon,
ChevronRightIcon,
MoreHorizontalIcon,
} from "lucide-react"
import { cn } from "@/lib/utils"
import { Button } from "@/components/ui/button"
function Pagination({ className, ...props }: React.ComponentProps<"nav">) {
return (
<nav
role="navigation"
aria-label="pagination"
data-slot="pagination"
className={cn("mx-auto flex w-full justify-center", className)}
{...props}
/>
)
}
function PaginationContent({
className,
...props
}: React.ComponentProps<"ul">) {
return (
<ul
data-slot="pagination-content"
className={cn("flex items-center gap-0.5", className)}
{...props}
/>
)
}
function PaginationItem({ ...props }: React.ComponentProps<"li">) {
return <li data-slot="pagination-item" {...props} />
}
type PaginationLinkProps = {
isActive?: boolean
} & Pick<React.ComponentProps<typeof Button>, "size"> &
React.ComponentProps<"a">
function PaginationLink({
className,
isActive,
size = "icon",
...props
}: PaginationLinkProps) {
return (
<Button
asChild
variant={isActive ? "default" : "ghost"}
size={size}
className={cn(className)}
>
<a
aria-current={isActive ? "page" : undefined}
data-slot="pagination-link"
data-active={isActive}
{...props}
/>
</Button>
)
}
function PaginationPrevious({
className,
text = "Previous",
...props
}: React.ComponentProps<typeof PaginationLink> & { text?: string }) {
return (
<PaginationLink
aria-label="Go to previous page"
size="default"
className={cn("pl-1.5!", className)}
{...props}
>
<ChevronLeftIcon data-icon="inline-start" className="cn-rtl-flip" />
<span className="hidden sm:block">{text}</span>
</PaginationLink>
)
}
function PaginationNext({
className,
text = "Next",
...props
}: React.ComponentProps<typeof PaginationLink> & { text?: string }) {
return (
<PaginationLink
aria-label="Go to next page"
size="default"
className={cn("pr-1.5!", className)}
{...props}
>
<span className="hidden sm:block">{text}</span>
<ChevronRightIcon data-icon="inline-end" className="cn-rtl-flip" />
</PaginationLink>
)
}
function PaginationEllipsis({
className,
...props
}: React.ComponentProps<"span">) {
return (
<span
aria-hidden
data-slot="pagination-ellipsis"
className={cn(
"flex size-8 items-center justify-center [&_svg:not([class*='size-'])]:size-4",
className
)}
{...props}
>
<MoreHorizontalIcon />
<span className="sr-only">More pages</span>
</span>
)
}
export {
Pagination,
PaginationContent,
PaginationEllipsis,
PaginationItem,
PaginationLink,
PaginationNext,
PaginationPrevious,
}
更新导入路径以匹配您的项目结构。
用法#
import {
Pagination,
PaginationContent,
PaginationEllipsis,
PaginationItem,
PaginationLink,
PaginationNext,
PaginationPrevious,
} from "@/components/ui/pagination"<Pagination>
<PaginationContent>
<PaginationItem>
<PaginationPrevious href="#" />
</PaginationItem>
<PaginationItem>
<PaginationLink href="#">1</PaginationLink>
</PaginationItem>
<PaginationItem>
<PaginationLink href="#" isActive>
2
</PaginationLink>
</PaginationItem>
<PaginationItem>
<PaginationLink href="#">3</PaginationLink>
</PaginationItem>
<PaginationItem>
<PaginationEllipsis />
</PaginationItem>
<PaginationItem>
<PaginationNext href="#" />
</PaginationItem>
</PaginationContent>
</Pagination>组合#
使用以下组合来构建 Pagination:
Pagination
└── PaginationContent
├── PaginationItem
│ └── PaginationPrevious
├── PaginationItem
│ └── PaginationLink
├── PaginationItem
│ └── PaginationEllipsis
└── PaginationItem
└── PaginationNext示例#
简单#
只有页码的简单分页。
import {
Pagination,
PaginationContent,仅图标#
不使用页码,只使用上一页和下一页按钮。这对于带有每页行数选择器的数据表格很有用。
import { Field, FieldLabel } from "@/components/ui/field"
import {
Pagination,Next.js#
默认情况下,<PaginationLink /> 组件会渲染一个 <a /> 标签。
若要使用 Next.js 的 <Link /> 组件,请对 pagination.tsx 做以下修改。
+ import Link from "next/link"
- type PaginationLinkProps = ... & React.ComponentProps<"a">
+ type PaginationLinkProps = ... & React.ComponentProps<typeof Link>
const PaginationLink = ({...props }: ) => (
<PaginationItem>
- <a>
+ <Link>
// ...
- </a>
+ </Link>
</PaginationItem>
)
**注意:**我们正在更新 CLI,以便自动为您完成此操作。
RTL#
若要在 Neobrutalism 中启用 RTL 支持,请参阅 RTL 配置指南。
"use client"
import * as React from "react"更新日志#
RTL 支持#
如果您从旧版本的 Pagination 组件升级,则需要应用以下修改来添加 text 属性:
更新 PaginationPrevious。
function PaginationPrevious({
className,
+ text = "Previous",
...props
- }: React.ComponentProps<typeof PaginationLink>) {
+ }: React.ComponentProps<typeof PaginationLink> & { text?: string }) {
return (
<PaginationLink
aria-label="Go to previous page"
size="default"
className={cn("cn-pagination-previous", className)}
{...props}
>
<ChevronLeftIcon />
<span className="cn-pagination-previous-text hidden sm:block">
- Previous
+ {text}
</span>
</PaginationLink>
)
}更新 PaginationNext。
function PaginationNext({
className,
+ text = "Next",
...props
- }: React.ComponentProps<typeof PaginationLink>) {
+ }: React.ComponentProps<typeof PaginationLink> & { text?: string }) {
return (
<PaginationLink
aria-label="Go to next page"
size="default"
className={cn("cn-pagination-next", className)}
{...props}
>
- <span className="cn-pagination-next-text hidden sm:block">Next</span>
+ <span className="cn-pagination-next-text hidden sm:block">{text}</span>
<ChevronRightIcon />
</PaginationLink>
)
}无障碍#
分页是基于链接的导航,而不是复合小组件,因此没有专属 WAI-ARIA 模式——原生链接语义就够了。根节点渲染带 aria-label="pagination" 的 <nav> 地标,当前页的 PaginationLink 带 aria-current="page",上一页 / 下一页控件带有明确的 aria-label,PaginationEllipsis 为 aria-hidden 并配有仅屏幕阅读器可见的「更多页」文案。
键盘交互即浏览器原生链接行为:
| 按键 | 操作 |
|---|---|
Tab / Shift + Tab | 在各页链接之间移动焦点或移出 |
Enter | 跟随当前聚焦的链接 |