پرش به محتوا

صفحه‌بندی

پیوندهای صفحات شماره‌گذاری‌شده با کنترل‌های قبلی/بعدی برای نتایج جستجو، جداول و آرشیوها — به سبک نئوبروتالیست مرزها و سایه‌ها.

import {
  Pagination,
  PaginationContent,

Pagination یک مجموعهٔ نتیجهٔ بلند را به لینک‌های شمارهٔ صفحه با کنترل‌های قبلی و بعدی می‌شکند. primitive زیرین ندارد — یک landmarkِ nav تگ‌های anchor ساده را می‌پیچد که هر کدام از طریق Button رندر شده و با دستور پخت نئوبروتالیستی استایل شده‌اند: حاشیه‌های ضخیم، سایه‌های سخت و تایپوگرافی پررنگ.

برای این موارد از آن استفاده کنید:

  • صفحات جستجو و فهرست — شبکهٔ محصول، job board، دایرکتوری جایی که کاربر مستقیم به صفحهٔ 12 می‌پرد.
  • جدول داده — variant فقط‌آیکون را با انتخابگر rows-per-page در نمای ادمین جفت کنید.
  • آرشیو وبلاگ و docs — لینک‌های واقعی <a> به هر صفحه URL قابل‌خزش می‌دهند که infinite scroll نمی‌تواند.

نصب

pnpm dlx shadcn@latest add https://neobrutalism.com/r/base/pagination.json
npx shadcn@latest add https://neobrutalism.com/r/base/pagination.json
yarn dlx shadcn@latest add https://neobrutalism.com/r/base/pagination.json
bunx --bun shadcn@latest add https://neobrutalism.com/r/base/pagination.json

کد زیر را کپی کرده و در پروژهٔ خود جای‌گذاری کنید.

components/ui/pagination.tsx
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 را مطابق با پیکربندی پروژهٔ خود به‌روزرسانی کنید.

استفاده

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 /> رندر می‌کند.

برای استفاده از کامپوننت <Link /> مربوط به Next.js، تغییرات زیر را در 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>
)
 

RTL

برای فعال‌سازی پشتیبانی RTL در Neobrutalism، راهنمای پیکربندی 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>
    )
  }

دسترسی‌پذیری

Pagination ناوبری مبتنی بر لینک است نه ویجت ترکیبی، پس الگوی اختصاصی WAI-ARIA ندارد — semantics بومی لینک کار را می‌کند. ریشه یک landmarkِ <nav> با aria-label="pagination" رندر می‌کند، PaginationLink فعال aria-current="page" دارد، کنترل‌های قبلی/بعدی aria-label صریح دارند، و PaginationEllipsis با aria-hidden و متن فقط‌صفحه‌خوان «More pages» است.

تعاملات صفحه‌کلید همان رفتار بومی لینک مرورگر است:

کلیدعمل
Tab / Shift + Tabحرکت فوکوس بین لینک‌های صفحه و خارج
Enterدنبال کردن لینک فوکوس‌شده