Pagination

The page-navigation bar: a `<nav aria-label="pagination">` of anchor links with previous / next / ellipsis parts. It is presentation only — it computes no page numbers and knows no total.

navigationserver320pxuiv1.3.0

Preview

Pagination — live renderprimitives-pagination--default

Rendered from the story the storybook (a11y) CI gate runs axe against — the preview can't show something that hasn't been verified.

Install

Two equivalent paths — the URL works in any shadcn-CLI setup; the alias works once you've registered @interlace in your components.json.

Via shadcn URL
npx shadcn@latest add https://ds.interlace.tools/r/pagination.json
With the @interlace alias
npx shadcn@latest add @interlace/pagination

Behavior

What this component does — the keyboard path, the measured colour, the text equivalent and the states it can be in. Every figure below is read out of the test or the source that enforces it by scripts/build-behavior-map.mjs, so nothing here can outlive the gate that keeps it true.

4 steps, 1 key press — replayed on every PR by the play function of KeyboardFlow. Axe cannot press a key, so this — not the a11y scan — is what proves the component is operable without a mouse.

  1. 1The nav exposes an accessible name
  2. 2Exactly one link is aria-current="page"
  3. 3The gap marker is announced, not hidden
  4. 4Tab walks Previous → 1 → 2 → NextTab

A chart's alt text is not a sentence about the chart — the equivalent of the data is the data. This is what a screen reader gets, read out of the source the install writes into your tree.

Label, not a data equivalentShips sr-only copy

Ships sr-only copy for what the visual carries by position, colour or icon alone — a label, not a full data equivalent.

Where it renders, how narrow it survives, and whether its lines are inside the coverage gate — three answers a consumer needs before the paste, not after the bug.

Render boundary
server component

Renders during SSR / RSC with no hydration cost. It can be imported from a server component without pulling the page into the client.

Minimum viewport
MIN_VIEWPORT = 320

Declared, not assumed. Below 320 CSS px the preflight contract draws a dev-mode outline — how to switch it on.

Coverage gate
100% × 4

Inside the v8 gate: lines 100, statements 100, functions 100, branches 100. A threshold under 100 only records how much you stopped caring, so there isn't one.

History

This component is at v1.3.0, first shipped in @interlace/ui 1.0.0. The version is stamped as a banner into the file the install writes, so the copy in your tree says which one you have — compare it with the number above before deciding whether to re-run the install.

Import

8 named exports — pull the parts you need.

Public API
import { MIN_VIEWPORT, Pagination, PaginationContent, PaginationEllipsis, PaginationItem, PaginationLink, PaginationNext, PaginationPrevious } from '@/components/ui/pagination';

Anatomy

Extracted from the primitive's JSDoc header. The source is the only documentation that can't drift.

Pagination                       (nav — aria-label=pagination, data-min-viewport=320)
    └─ PaginationContent           (ul — flex-wrap)
         └─ PaginationItem         (li)
              ├─ PaginationLink        (a — buttonVariants, active ⇒ outline + aria-current)
              ├─ PaginationPrevious    (a — chevron + label, label hidden below sm)
              ├─ PaginationNext        (a — label + chevron, label hidden below sm)
              └─ PaginationEllipsis    (span — aria-hidden icon + sr-only "More pages")
Links, not buttons: every part renders an `<a>`, so there is no disabled
state. A "previous" on page one has to be omitted by the caller rather than
disabled, and an anchor with no `href` is not keyboard-focusable.
`PaginationLink` also accepts a deprecated `isActive` alias for `active`,
kept only so shadcn-shaped call sites keep working; `active` wins when both
are passed.

API reference

Parsed from the type declarations in the source — the same file the install writes into your tree, so this table can't drift from the component you get.

PaginationLinkProps

Also accepts every <a> attribute. Plus the variant props listed above.

PropTypeDescription
activebooleanMarks the link as the page the reader is on — renders `aria-current="page"` and the outline treatment. @default false
isActiveboolean@deprecated Use `active`. The `is`-prefixed name violates the boolean naming contract (CONVENTIONS.md → Naming) and is kept only so existing shadcn-shaped call sites keep working. Removed in the next major.
sizeVariantProps<typeof buttonVariants>['size']

Accessibility

Every story for this component is rendered headlessly and checked with axe-core (wcag2aa, wcag22aa, best-practice, ACT) on every PR. That gate has no continue-on-error, so what ships has zero known violations.

What follows is what static analysis can see. Axe cannot press a key and never sees an overlay open, so the operable-without-a-mouse claim lives in Behavior instead, where the keyboard path is replayed step by step.

Focus + keyboard behaviour
Native element semantics — no interaction layer to get wrong.
Focus ring (WCAG 2.2 SC 2.4.13)
Not focusable — no focus indicator required.
Reduced motion
No animation to gate.
ARIA in the source
  • aria-current
  • aria-label

Examples

3 more states from the same story file.

R-rule compliance

Every primitive in @interlace/ui models to the portable 26-rule floor enforced by the componentApi ESLint preset. The cells below pin exactly where each rule applies in this file.

RuleConceptWhere
R4Extends native el`React.ComponentProps<'nav'
R6data-slot per partpagination / -content / -item / -link / -ellipsis
R7cn + ...rest`cn(buttonVariants({…}), className)` + `{...props}`
R8No `isXxx``active`; `isActive` survives only as a deprecated alias
R12Reuse over wrapthe link face is `buttonVariants`, not a second class list
R14Declares min viewport`data-min-viewport={String(MIN_VIEWPORT)}` + exported const
R19Tokens onlyall colour arrives via `buttonVariants`
R25Server componentNo hooks → no `'use client'`
R26A11y`aria-current="page"`; the ellipsis hides its ICON, not its wrapper, so the sr-only text survives

Minimum viewport

This primitive declares MIN_VIEWPORT = 320 CSS px (DESIGN_PRINCIPLES #14). When mounted in a container narrower than this, the preflight contract draws a dev-mode outline so the regression is visible during local development.

Opt-in to the dev-mode warning
<body data-interlace-dev>...</body>

Add the data-interlace-dev attribute to the body in development builds only — preflight then outlines any primitive whose container is below its declared data-min-viewport.

Dependencies

Base UI primitive
Native / no Base UI dependency
Lucide icons
  • ChevronLeftIcon
  • ChevronRightIcon
  • MoreHorizontalIcon
NPM dependencies
  • class-variance-authority
  • lucide-react

Source

The full implementation — components/ui/pagination.tsx once installed.

212 lines · TypeScript
import * as React from 'react';

// @interlace/pagination v1.3.0 — Interlace design system.
// Docs, props and live preview: https://ds.interlace.tools/c/pagination
// What changed since: https://ds.interlace.tools/c/pagination#history
// Generated banner — keep it, the upgrade diff reads this version.

/**
 * @interlace/ui — Pagination
 *
 * The page-navigation bar: a `<nav aria-label="pagination">` of anchor links
 * with previous / next / ellipsis parts. It is presentation only — it computes
 * no page numbers and knows no total.
 *
 * The caller renders the items and marks one with `active`, which emits
 * `aria-current="page"` and the outline face.
 *
 * ## Anatomy
 *
 *   Pagination                       (nav — aria-label=pagination, data-min-viewport=320)

…192 more lines…

Registry JSON

The raw registry record — what the shadcn CLI fetches.