Pagination

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

Overview

We use a large block of connected links for our pagination, making links hard to miss and easily scalable—all while providing large hit areas.

Pagination is built with list HTML elements so screen readers can announce the number of available links.

Use a wrapping Nav component to identify it as a navigation section to screen readers and other assistive technologies.

In addition, as pages likely have more than one such navigation section, it's advisable to provide a descriptive aria-label attribute for the Nav component to reflect its purpose.

For example, if the pagination component is used to navigate between a set of search results, an appropriate label could be aria-label="Search results pages".

vue
<template>
 <nav aria-label="Page navigation example">
  <Pagination>
   <PageItem>
    <PageLink>Previous</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>1</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>2</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>3</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>Next</PageLink>
   </PageItem>
  </Pagination>
 </nav>
</template>

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.

vue
<template>
 <nav aria-label="Page navigation example">
  <Pagination>
   <PageItem>
    <PageLink aria-label="Previous">
     <span aria-hidden="true">&laquo;</span>
    </PageLink>
   </PageItem>
   <PageItem>
    <PageLink>1</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>2</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>3</PageLink>
   </PageItem>
   <PageItem>
    <PageLink aria-label="Next">
     <span aria-hidden="true">&raquo;</span>
    </PageLink>
   </PageItem>
  </Pagination>
 </nav>
</template>

Disabled and active states

Pagination links are customizable for different circumstances. Use disabled attribute for links that appear un-clickable and active attribute to indicate the current page.

While the disabled attribute uses pointer-events: none to _try_ to disable the link functionality of b-a components, that CSS property is not yet standardized and doesn't account for keyboard navigation. As such, you should always add tabindex="-1" attribute on disabled links and use custom JavaScript to fully disable their functionality.

vue
<template>
 <nav aria-label="...">
  <Pagination>
   <PageItem disabled>
    <PageLink>Previous</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>1</PageLink>
   </PageItem>
   <PageItem active>
    <PageLink>2</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>3</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>Next</PageLink>
   </PageItem>
  </Pagination>
 </nav>
</template>

You can optionally swap out active or disabled anchors for `PageLink`, or omit the anchor in the case of the prev/next arrows, to remove click functionality and prevent keyboard focus while retaining intended styles.

vue
<template>
 <nav aria-label="...">
  <Pagination>
   <PageItem disabled>
    <PageLink>Previous</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>1</PageLink>
   </PageItem>
   <PageItem active>
    <PageLink>2</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>3</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>Next</PageLink>
   </PageItem>
  </Pagination>
 </nav>
</template>

Sizing

Fancy larger or smaller pagination? Add size="lg" or size="sm" for additional sizes.

vue
<template>
 <nav aria-label="...">
  <Pagination size="lg">
   <PageItem active>
    <PageLink>1</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>2</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>3</PageLink>
   </PageItem>
  </Pagination>
 </nav>
</template>
vue
<template>
 <nav aria-label="...">
  <Pagination size="sm">
   <PageItem active>
    <PageLink>1</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>2</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>3</PageLink>
   </PageItem>
  </Pagination>
 </nav>
</template>

Alignment

Change the alignment of pagination components with flexbox utilities .

vue
<template>
 <nav aria-label="Page navigation example">
  <Pagination justify-content="center">
   <PageItem disabled>
    <PageLink>Previous</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>1</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>2</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>3</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>Next</PageLink>
   </PageItem>
  </Pagination>
 </nav>
</template>
vue
<template>
 <nav aria-label="Page navigation example">
  <Pagination justify-content="end">
   <PageItem disabled>
    <PageLink>Previous</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>1</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>2</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>3</PageLink>
   </PageItem>
   <PageItem>
    <PageLink>Next</PageLink>
   </PageItem>
  </Pagination>
 </nav>
</template>