Skip to main content

Pagination

Moves between pages of results.

In Accessible first

See it live​

Start Storybook to see it live: npm run storybook
Live from StorybookOpen Pagination in StorybookSee it in dark

When to use it​

In Accessible first: A long list or table split across pages, with large targets. Not for the steps of a form.

  • Use it when: A list or table split across pages.
  • Not when: Steps of a task (progress).

Instead:

Words​

  • Use common words. Explain any term you must use.
  • One idea per sentence. Put the action first.
  • Never blame the person.
  • Use: Continue, Change, Start, You. Avoid: Invalid, Utilise, Submit, Error code.

The labels components use, from the voice tokens:

  • content.action.commit: Continue
  • content.action.cancel: Go back
  • content.action.destroy: Delete
  • content.action.retry: Try again
  • content.action.empty-action: Start a new application

See Voice and tone for the whole voice.

Accessibility and keyboard​

Test before you ship:

  • The current page is marked; previous and next have names. undefined

Use it in code​

npx open-ds add pagination

The component reads only component keys and semantic tokens, so it follows the brand and mode on <html>.

Tokens it reads​

Pagination reads 6 tokens of its own, each an alias of a semantic token. Each row is one part: its own token, the semantic it aliases, and the value it ends at. Change a semantic and every component that reads it follows; override one of Pagination's tokens to change Pagination alone.

Changes with theme

Accessible first decides what changes when you switch theme. Here a switch changes colors only, so the marked rows differ between light and dark; everything else holds steady.

PartIts token and the semantic it aliasesValue
Content
Gapcomponent.pagination.content.gapspace.gap.tightvar(--pagination-content-gap)space.12:0.75rem
Pagination
Gapcomponent.pagination.gapspace.gap.tightvar(--pagination-gap)space.12:0.75rem
Padding, left and rightcomponent.pagination.padding-xcomponent-spacing-map.x3var(--pagination-padding-x)space.20:1.25rem
Padding leftcomponent.pagination.padding-leftcomponent-spacing-map.x3var(--pagination-padding-left)space.20:1.25rem
Padding rightcomponent.pagination.padding-rightcomponent-spacing-map.x3var(--pagination-padding-right)space.20:1.25rem
Icon sizecomponent.pagination.icon-sizesize.iconvar(--pagination-icon-size)size.20:1.25rem