Loading...
Skip to main content

Pagination

Documentation and examples for showing pagination to indicate a series of related content exists across multiple pages.

Compose Pagination, PageItem, PageLink, and PageText inside a labelled navigation element. Pagination accepts theme and size; links inherit active and disabled from their PageItem.

Overview

Pagination renders the page links as a list, providing large hit areas and allowing screen readers to announce the available links. Place it inside a navigation landmark so assistive technologies can identify its purpose.

If the page has more than one navigation landmark, give the pagination landmark a descriptive accessible name, such as "Search results pages".

<Stack gap={3}>
<nav aria-label="Page navigation example">
<Pagination>
<PageItem>
<PageLink href="#">
Previous
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
Next
</PageLink>
</PageItem>
</Pagination>
</nav>
</Stack>

Working with icons

Looking to use an icon or symbol in place of text for some pagination links? Be sure to provide proper screen reader support with aria attributes.

<Stack gap={3}>
<nav aria-label="Page navigation example">
<Pagination>
<PageItem>
<PageLink
aria-label="Previous"
href="#"
>
<span aria-hidden="true">
«
</span>
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
<PageItem>
<PageLink
aria-label="Next"
href="#"
>
<span aria-hidden="true">
»
</span>
</PageLink>
</PageItem>
</Pagination>
</nav>
</Stack>

Active

Set active on PageItem to indicate the current page. When PageLink renders as a link, it also sets aria-current="page" for assistive technologies.

<Stack gap={3}>
<nav aria-label="...">
<Pagination>
<PageItem>
<PageLink href="#">
Previous
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem active>
<PageLink href="#">
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
Next
</PageLink>
</PageItem>
</Pagination>
</nav>
</Stack>

For a non-interactive current page, render PageText instead of a link; it does not need aria-current.

Disabled

Set disabled on PageItem to disable its PageLink. The component removes the destination and click handler, supplies aria-disabled, and excludes the link from keyboard focus.

<Stack gap={3}>
<nav aria-label="...">
<Pagination>
<PageItem disabled>
<PageLink>
Previous
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem active>
<PageLink href="#">
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
Next
</PageLink>
</PageItem>
</Pagination>
</nav>
</Stack>

Variants

Set theme on Pagination to apply a semantic theme color across the component, including hover, focus, and the active page item.

<Stack gap={3}>
<nav aria-label="Page navigation example">
<Pagination theme="primary">
<PageItem>
<PageLink href="#">
Previous
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem active>
<PageLink
aria-current="page"
href="#"
>
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
Next
</PageLink>
</PageItem>
</Pagination>
</nav>
<nav aria-label="Page navigation example">
<Pagination theme="accent">
<PageItem>
<PageLink href="#">
Previous
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem active>
<PageLink
aria-current="page"
href="#"
>
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
Next
</PageLink>
</PageItem>
</Pagination>
</nav>
<nav aria-label="Page navigation example">
<Pagination theme="secondary">
<PageItem>
<PageLink href="#">
Previous
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem active>
<PageLink
aria-current="page"
href="#"
>
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
Next
</PageLink>
</PageItem>
</Pagination>
</nav>
<nav aria-label="Page navigation example">
<Pagination theme="success">
<PageItem>
<PageLink href="#">
Previous
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem active>
<PageLink
aria-current="page"
href="#"
>
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
Next
</PageLink>
</PageItem>
</Pagination>
</nav>
<nav aria-label="Page navigation example">
<Pagination theme="danger">
<PageItem>
<PageLink href="#">
Previous
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem active>
<PageLink
aria-current="page"
href="#"
>
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
Next
</PageLink>
</PageItem>
</Pagination>
</nav>
<nav aria-label="Page navigation example">
<Pagination theme="warning">
<PageItem>
<PageLink href="#">
Previous
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem active>
<PageLink
aria-current="page"
href="#"
>
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
Next
</PageLink>
</PageItem>
</Pagination>
</nav>
<nav aria-label="Page navigation example">
<Pagination theme="info">
<PageItem>
<PageLink href="#">
Previous
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem active>
<PageLink
aria-current="page"
href="#"
>
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
Next
</PageLink>
</PageItem>
</Pagination>
</nav>
<nav aria-label="Page navigation example">
<Pagination theme="inverse">
<PageItem>
<PageLink href="#">
Previous
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem active>
<PageLink
aria-current="page"
href="#"
>
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
Next
</PageLink>
</PageItem>
</Pagination>
</nav>
</Stack>

Sizing

Set the size prop to "lg" or "sm" to change the pagination size.

<Stack gap={3}>
<nav aria-label="...">
<Pagination size="lg">
<PageItem active>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
</Pagination>
</nav>
<nav aria-label="...">
<Pagination>
<PageItem active>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
</Pagination>
</nav>
<nav aria-label="...">
<Pagination size="sm">
<PageItem active>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
</Pagination>
</nav>
</Stack>

Alignment

Align pagination by passing flexbox utilities through className, such as className="justify-content-center":

<Stack gap={3}>
<nav aria-label="Page navigation example">
<Pagination className="justify-content-center">
<PageItem disabled>
<PageLink>
Previous
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
Next
</PageLink>
</PageItem>
</Pagination>
</nav>
</Stack>

Or pass className="justify-content-end":

<Stack gap={3}>
<nav aria-label="Page navigation example">
<Pagination className="justify-content-end">
<PageItem disabled>
<PageLink>
Previous
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
1
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
2
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
3
</PageLink>
</PageItem>
<PageItem>
<PageLink href="#">
Next
</PageLink>
</PageItem>
</Pagination>
</nav>
</Stack>

CSS

Variables

Customize the component with the following local CSS variables. Override them through the wrapper’s style prop or your own CSS module.

CSS variableDefault
--bs-pagination-min-heightvar(--bs-btn-input-min-height)
--bs-pagination-padding-xvar(--bs-btn-input-padding-x)
--bs-pagination-padding-yvar(--bs-btn-input-padding-y)
--bs-pagination-font-sizevar(--bs-btn-input-font-size)
--bs-pagination-colorvar(--bs-link-color)
--bs-pagination-bgvar(--bs-bg-body)
--bs-pagination-border-widthvar(--bs-border-width)
--bs-pagination-border-colorvar(--bs-border-color)
--bs-pagination-border-radiusvar(--bs-btn-input-border-radius)
--bs-pagination-hover-colorvar(--bs-link-hover-color)
--bs-pagination-hover-bgvar(--bs-bg-1)
--bs-pagination-hover-border-colorvar(--bs-border-color)
--bs-pagination-active-colorvar(--bs-theme-contrast, var(--bs-primary-contrast))
--bs-pagination-active-bgvar(--bs-theme-bg, var(--bs-primary-bg))
--bs-pagination-active-border-colorvar(--bs-theme-bg, var(--bs-primary-bg))
--bs-pagination-disabled-colorvar(--bs-fg-3)
--bs-pagination-disabled-bgvar(--bs-bg-2)
--bs-pagination-disabled-border-colorvar(--bs-border-color)
Documentation navigation
On this page
On this page