Pagination
Pagination with page navigation, next and previous links.
tsx
import { Pagination, PaginationContent, PaginationEllipsis, PaginationItem, PaginationLink, PaginationNext, PaginationPrevious,} from "@/components/ui/pagination"
export function PaginationDemo() { return ( <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> )}
Installation
CLI
bash
npx fivui add pagination
Manual
Copy and paste the following code into your project.
tsx
"use client"
import * as React from "react"import { ChevronLeftIcon, ChevronRightIcon, MoreHorizontalIcon } from "lucide-react"
import { cn } from "@/lib/utils"import { Button, buttonVariants } from "@/components/ui/button"
const Pagination = ({ className, ...props }: React.ComponentProps<"nav">) => ( <nav role="navigation" aria-label="pagination" className={cn("mx-auto flex w-full justify-center", className)} {...props} />)Pagination.displayName = "Pagination"
const PaginationContent = React.forwardRef< HTMLUListElement, React.ComponentProps<"ul">>(({ className, ...props }, ref) => ( <ul ref={ref} className={cn("flex flex-row items-center gap-1", className)} {...props} />))PaginationContent.displayName = "PaginationContent"
const PaginationItem = React.forwardRef< HTMLLIElement, React.ComponentProps<"li">>(({ className, ...props }, ref) => ( <li ref={ref} className={cn("", className)} {...props} />))PaginationItem.displayName = "PaginationItem"
type PaginationLinkProps = { isActive?: boolean size?: "default" | "sm" | "lg" | "icon"} & React.ComponentProps<typeof Link>
const PaginationLink = ({ className, isActive, size = "icon", ...props}: PaginationLinkProps) => ( <Link aria-current={isActive ? "page" : undefined} className={cn( buttonVariants({ variant: isActive ? "outline" : "ghost", size, }), className )} {...props} />)PaginationLink.displayName = "PaginationLink"
const PaginationPrevious = ({ className, ...props}: React.ComponentProps<typeof PaginationLink>) => ( <PaginationLink aria-label="Go to previous page" size="default" className={cn("gap-1 pl-2.5", className)} {...props} > <ChevronLeftIcon className="h-4 w-4" /> <span>Previous</span> </PaginationLink>)PaginationPrevious.displayName = "PaginationPrevious"
const PaginationNext = ({ className, ...props}: React.ComponentProps<typeof PaginationLink>) => ( <PaginationLink aria-label="Go to next page" size="default" className={cn("gap-1 pr-2.5", className)} {...props} > <span>Next</span> <ChevronRightIcon className="h-4 w-4" /> </PaginationLink>)PaginationNext.displayName = "PaginationNext"
const PaginationEllipsis = ({ className, ...props}: React.ComponentProps<"span">) => ( <span aria-hidden className={cn("flex h-9 w-9 items-center justify-center", className)} {...props} > <MoreHorizontalIcon className="h-4 w-4" /> <span className="sr-only">More pages</span> </span>)PaginationEllipsis.displayName = "PaginationEllipsis"
export { Pagination, PaginationContent, PaginationEllipsis, PaginationItem, PaginationLink, PaginationNext, PaginationPrevious,}
Usage
tsx
import { Pagination, PaginationContent, PaginationEllipsis, PaginationItem, PaginationLink, PaginationNext, PaginationPrevious,} from "@/components/ui/pagination"
tsx
<Pagination> <PaginationContent> <PaginationItem> <PaginationPrevious href="#" /> </PaginationItem> <PaginationItem> <PaginationLink href="#">1</PaginationLink> </PaginationItem> <PaginationItem> <PaginationEllipsis /> </PaginationItem> <PaginationItem> <PaginationNext href="#" /> </PaginationItem> </PaginationContent></Pagination>
Examples
Simple Pagination
tsx
export function SimplePaginationDemo() { return ( <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> <PaginationNext href="#" /> </PaginationItem> </PaginationContent> </Pagination> )}
Extended Pagination
tsx
export function ExtendedPaginationDemo() { return ( <Pagination> <PaginationContent> <PaginationItem> <PaginationPrevious href="#" /> </PaginationItem> <PaginationItem> <PaginationLink href="#">1</PaginationLink> </PaginationItem> <PaginationItem> <PaginationEllipsis /> </PaginationItem> <PaginationItem> <PaginationLink href="#">8</PaginationLink> </PaginationItem> <PaginationItem> <PaginationLink href="#" isActive> 9 </PaginationLink> </PaginationItem> <PaginationItem> <PaginationLink href="#">10</PaginationLink> </PaginationItem> <PaginationItem> <PaginationEllipsis /> </PaginationItem> <PaginationItem> <PaginationLink href="#">20</PaginationLink> </PaginationItem> <PaginationItem> <PaginationNext href="#" /> </PaginationItem> </PaginationContent> </Pagination> )}
Next.js
By default the PaginationLink
component will render an a
tag.
To use the Next.js Link
component, make the following updates to pagination.tsx
.
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>)
API Reference
PaginationLink
Prop | Type | Default | Description |
---|---|---|---|
isActive | boolean | false | Whether the link represents the current page. |
size | "default" | "sm" | "lg" | "icon" | "icon" | The size of the pagination link. |
href | string | - | The URL to navigate to. |