Pagination
A simplified wrapper for Shadcn Pagination with flexible option handling and automatic type conversion
Installation
npx shadcn@latest add @glrk-ui/paginationIf you haven't set up the prerequisites yet, check out Prerequest section.
Upade the following changes in pagination.tsx
"use client"
import Link from "next/link"
import { cn, getKey, isSeparator } from "@/lib/utils"type PaginationLinkProps = Pick<React.ComponentProps<typeof Button>, "size"> &
React.ComponentProps<typeof Link> & { isActive?: boolean }
function PaginationLink({
className,
isActive,
size = "icon",
...props
}: PaginationLinkProps) {
return (
<Link
aria-current={isActive ? "page" : undefined}
data-slot="pagination-link"
data-active={isActive}
className={cn(
buttonVariants({
variant: isActive ? "outline" : "ghost",
size,
}),
className
)}
{...props}
/>
)
}Copy and paste the following code into shadcn pagination component.
type PaginationWrapperProps = {
total: number
page?: number
wrapperCls?: string
contentCls?: string
itemCls?: string
linkCls?: string
siblingCount?: number
onPageChange?: (page: number) => void
};
function PaginationWrapper({
total,
page: o_page,
onPageChange: o_onPageChange,
siblingCount = 1,
wrapperCls,
contentCls,
itemCls,
linkCls,
}: PaginationWrapperProps) {
const [i_page, setIPage] = React.useState(1)
const page = o_page ?? i_page
const onPageChange = o_onPageChange ?? setIPage
const paginationRange = React.useMemo(() => {
if (total <= 1) return [1]
const pages: (number | "---")[] = []
const start = Math.max(2, page - siblingCount)
const end = Math.min(total - 1, page + siblingCount)
pages.push(1)
if (start > 2) pages.push("---")
for (let i = start; i <= end; i++) pages.push(i)
if (end < total - 1) pages.push("---")
if (total > 1) pages.push(total)
return pages
}, [page, siblingCount, total])
return (
<Pagination className={wrapperCls}>
<PaginationContent className={contentCls}>
<PaginationItem className={itemCls}>
<PaginationPrevious
href=""
onClick={() => page > 1 && onPageChange(page - 1)}
className={cn(linkCls, page === 1 && "pointer-events-none opacity-50")}
/>
</PaginationItem>
{paginationRange.map((p, i) => {
const key = getKey(p, i)
if (isSeparator(p)) {
return (
<PaginationItem key={key} className={itemCls}>
<PaginationEllipsis />
</PaginationItem>
)
}
return (
<PaginationItem key={key} className={itemCls}>
<PaginationLink
href=""
onClick={() => onPageChange(p as number)}
isActive={p === page}
className={linkCls}
>
{p}
</PaginationLink>
</PaginationItem>
)
})}
<PaginationItem className={itemCls}>
<PaginationNext
href=""
onClick={() => page < total && onPageChange(page + 1)}
className={cn(linkCls, page === total && "pointer-events-none opacity-50")}
/>
</PaginationItem>
</PaginationContent>
</Pagination>
)
}export {
Pagination,
PaginationContent,
PaginationLink,
PaginationItem,
PaginationPrevious,
PaginationNext,
PaginationEllipsis,
PaginationWrapper,
}pagination.tsx
Copy and paste the following code into your project.
"use client"
import * as React from "react"
import { ChevronLeftIcon, ChevronRightIcon, MoreHorizontalIcon } from "lucide-react"
import Link from "next/link"
import { cn, getKey, isSeparator } from "@/lib/utils"
import { Button, buttonVariants } 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 flex-row items-center gap-1", className)}
{...props}
/>
)
}
function PaginationItem({ ...props }: React.ComponentProps<"li">) {
return <li data-slot="pagination-item" {...props} />
}
type PaginationLinkProps = Pick<React.ComponentProps<typeof Button>, "size"> &
React.ComponentProps<typeof Link> & { isActive?: boolean }
function PaginationLink({
className,
isActive,
size = "icon",
...props
}: PaginationLinkProps) {
return (
<Link
aria-current={isActive ? "page" : undefined}
data-slot="pagination-link"
data-active={isActive}
className={cn(
buttonVariants({
variant: isActive ? "outline" : "ghost",
size,
}),
className
)}
{...props}
/>
)
}
function PaginationPrevious({
className,
...props
}: React.ComponentProps<typeof PaginationLink>) {
return (
<PaginationLink
aria-label="Go to previous page"
size="default"
className={cn("gap-1 px-2.5 sm:pl-2.5", className)}
{...props}
>
<ChevronLeftIcon />
<span className="hidden sm:block">Previous</span>
</PaginationLink>
)
}
function PaginationNext({
className,
...props
}: React.ComponentProps<typeof PaginationLink>) {
return (
<PaginationLink
aria-label="Go to next page"
size="default"
className={cn("gap-1 px-2.5 sm:pr-2.5", className)}
{...props}
>
<span className="hidden sm:block">Next</span>
<ChevronRightIcon />
</PaginationLink>
)
}
function PaginationEllipsis({
className,
...props
}: React.ComponentProps<"span">) {
return (
<span
aria-hidden
data-slot="pagination-ellipsis"
className={cn("flex size-9 items-center justify-center", className)}
{...props}
>
<MoreHorizontalIcon className="size-4" />
<span className="sr-only">More pages</span>
</span>
)
}
type PaginationWrapperProps = {
total: number
page?: number
wrapperCls?: string
contentCls?: string
itemCls?: string
linkCls?: string
siblingCount?: number
onPageChange?: (page: number) => void
};
function PaginationWrapper({
total,
page: o_page,
onPageChange: o_onPageChange,
siblingCount = 1,
wrapperCls,
contentCls,
itemCls,
linkCls,
}: PaginationWrapperProps) {
const [i_page, setIPage] = React.useState(1)
const page = o_page ?? i_page
const onPageChange = o_onPageChange ?? setIPage
const paginationRange = React.useMemo(() => {
if (total <= 1) return [1]
const pages: (number | "---")[] = []
const start = Math.max(2, page - siblingCount)
const end = Math.min(total - 1, page + siblingCount)
pages.push(1)
if (start > 2) pages.push("---")
for (let i = start; i <= end; i++) pages.push(i)
if (end < total - 1) pages.push("---")
if (total > 1) pages.push(total)
return pages
}, [page, siblingCount, total])
return (
<Pagination className={wrapperCls}>
<PaginationContent className={contentCls}>
<PaginationItem className={itemCls}>
<PaginationPrevious
href=""
onClick={() => page > 1 && onPageChange(page - 1)}
className={cn(linkCls, page === 1 && "pointer-events-none opacity-50")}
/>
</PaginationItem>
{paginationRange.map((p, i) => {
const key = getKey(p, i)
if (isSeparator(p)) {
return (
<PaginationItem key={key} className={itemCls}>
<PaginationEllipsis />
</PaginationItem>
)
}
return (
<PaginationItem key={key} className={itemCls}>
<PaginationLink
href=""
onClick={() => onPageChange(p as number)}
isActive={p === page}
className={linkCls}
>
{p}
</PaginationLink>
</PaginationItem>
)
})}
<PaginationItem className={itemCls}>
<PaginationNext
href=""
onClick={() => page < total && onPageChange(page + 1)}
className={cn(linkCls, page === total && "pointer-events-none opacity-50")}
/>
</PaginationItem>
</PaginationContent>
</Pagination>
)
}
export {
Pagination,
PaginationContent,
PaginationLink,
PaginationItem,
PaginationPrevious,
PaginationNext,
PaginationEllipsis,
PaginationWrapper,
}Done
You can now use PaginationWrapper
Usage
Basic
import { PaginationWrapper } from "../ui/pagination";
export function Basic() {
return (
<PaginationWrapper
total={20}
/>
)
}Controlled
import { useState } from "react"
import { PaginationWrapper } from "../ui/pagination";
export function Controlled() {
const [value, setValue] = useState(5)
return (
<PaginationWrapper
total={20}
page={value}
onPageChange={setValue}
/>
)
}Reference
PaginationWrapper
Prop
Type