Pagination

Components/Navigation

Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/pagination

Overview

Copy

Pagination splits up large amounts of content into multiple pages.

Do

  • Use it to let users navigate between content on multiple pages.
  • Use it to show small chunks of content at a time.

Don't

  • Don't use it to navigate between content on the same page. Use <Tabs/> instead.
  • Don't use it to illustrate progress in a task or process. Use <Stepper/> instead.

Feature examples

Number of pages

Control the total number of pages available with the totalPages prop.

This number starts from two and has no maximum value.

Copy

Current page

Specify which page is currently selected with the currentPage prop.

The first page will be selected, if not specified otherwise.

Copy

Code

Copy

Props

NameTypeDefaultDescription
currentPagenumber1Specifies a currently selected page.
dataHookstring—Applies a data-hook HTML attribute that can be used in the tests.
disabledboolean—
nextLabelstring—Sets next page label.
onBlur(event: FocusEvent, triggers: Triggers) => void—
onChange(event: { event: SyntheticEvent<Element, Event>; page: number; }) => void—Defines a callback function which returns a selected page or an arrow ({event,page})
onFocus(event: FocusEvent, triggers: Triggers) => void—
pageUrl(pageNumber: number) => string—Get pageNumber and returns url.
previousLabelstring—Sets previous page label.
refRefObject—
totalPagesnumber—Sets a number of available pages to show in the component.

Testkit

Import the driver matching your test environment:

Copy

Driver methods

MethodDescription
isVisibleCheck if element is rendered
getCurrentPageReturns currently selected page
getTotalPagesReturns a total amount of pages available
clickOnPageClicks on gives page number
clickNextButtonClicks on next button
clickPreviousButtonClicks on previous button
existsChecks whether the component found with the given data hook.
elementGets the component root element.
clickClicks on the component root element.
baseReturns UniDriver for the base element.

Changelog

  • 1.339.0 (2026-10-19) — maintenance release, no component-specific changes
  • 1.338.0 (2026-10-15) — maintenance release, no component-specific changes
  • 1.330.0 (2026-09-28) — maintenance release, no component-specific changes
  • 1.329.0 (2026-09-24) — maintenance release, no component-specific changes
  • 1.325.0 (2026-09-17) — maintenance release, no component-specific changes
  • 1.323.0 (2026-09-10) — maintenance release, no component-specific changes
  • 1.310.0 (2026-08-10) — maintenance release, no component-specific changes
  • 1.292.0 (2026-06-22) — maintenance release, no component-specific changes
  • 1.290.0 (2026-06-18) — fix: harmony dark current page background and arrow fill token (#16412) — has visual changes
  • 1.278.0 (2026-05-08) — maintenance release, no component-specific changes
  • 1.273.0 (2026-04-30) — maintenance release, no component-specific changes
  • 1.271.0 (2026-04-22) — maintenance release, no component-specific changes
  • 1.266.0 (2026-04-07) — maintenance release, no component-specific changes
  • 1.260.0 (2026-03-17) — maintenance release, no component-specific changes
  • 1.254.0 (2026-02-03) — maintenance release, no component-specific changes
  • 1.250.0 (2026-01-27) — maintenance release, no component-specific changes
  • 1.212.0 (2025-08-11) — maintenance release, no component-specific changes
  • 1.165.0 (2025-02-27) — maintenance release, no component-specific changes
  • 1.155.0 (2025-01-23) — maintenance release, no component-specific changes
  • 1.138.1 (2024-10-30) — maintenance release, no component-specific changes
  • 1.115.0 (2024-07-17) — maintenance release, no component-specific changes
  • 1.102.0 (2024-04-16) — maintenance release, no component-specific changes
  • 1.98.0 (2024-03-15) — maintenance release, no component-specific changes
  • 1.93.0 (2024-02-08) — maintenance release, no component-specific changes
  • 1.92.1 (2024-02-05) — maintenance release, no component-specific changes

Last updated: 21 October 2026

Did this help?