Skip to main content

Pagination Facet

Pagination Facet controls the current page for a target. It renders hidden offset state and receives pagination metadata from facet responses.

Props

GroupPropDefaultMeaning
SettingstargetemptyShared target ID.
Settingssibling_count1Numeric page buttons shown on each side of the current page.
SettingstagnavRoot wrapper tag.
Settingsaria_labelPaginationAccessible navigation label.
Settingshide_when_single_pagetrueHides pagination when only one page exists.
Settingsscroll_to_topfalseScrolls to the target after pagination changes.
Labelsprev_labelPreviousPrevious button label.
Labelsnext_labelNextNext button label.
Rangeshow_rangetrueShows the live range summary.
Rangerange_labelShowingPrefix for the range summary.
Stylingclass, range_classcomponent defaultsRoot and range summary classes.

Runtime Notes

  • Pagination sends offset for the target.
  • Responses update current page, total pages, total items, per-page, and offset.
  • Changing a normal facet resets pagination to page 1.
  • Pagination hides on zero results even when hide_when_single_page is false.

The multi-facet E2E scenario verifies pagination reset after a facet value changes.