Pagination

Anatomy

1. Page Numbers: Each page has its own page number. All page numbers inherit styling and interactions from our Icon Only Primary Button Variant.
2. Navigational Controls: Allow users to navigate through available pages. These controls inherit styling and interactions from our Icon Only Tertiary Button. Previous/Next uses Small Chevron System Icon and First/Last uses Chevron x2 Small System Icon.
3. Input w/ Label: Shows a box adjacent to the pagination bar where a page can be entered and is submitted when 'Enter' key is pressed. Enables users to jump to specific page. Input uses the Canvas Text Input with browser-specific numeric input override.
4. Additional Details: Communicates the number of pages and total number of items. Page numbers are separated by an en dash. The word “pages” is customizable.

Pagination is a highly configurable component so we’ve intentionally built each piece of this component separately so you may compose it in a variety of ways.

Usage Guidance

• Pagination is a highly configurable navigation component composed of the following elements:
  • Page Numbers: Provide context about what page the user is on in relation to other pages.
  • Page Navigation: Navigational controls allow users to navigate back or forward through pages. If applicable, they are also able to jump to the first or last page.
  • Numeric Input: Enables users to jump to a specific page.
  • Label: Communicates the number of pages and total number of items. The word “items” is customizable.
• Although the component is typically placed below the corresponding content or data, there is flexibility on placement depending on your use case.
• Pagination is typically used with Tables.
• In responsive experiences, Pagination condenses to its most basic elements (Left/Right Controls, Current Page Number).

When to Use

• To divide large quantities of data or content into chunks.
• To improve the loading performance of a system.
• To make user comprehension of data/content less overwhelming.
• To enable all users to navigate to through pages or locate a specific page number.
• To show how many pages of content there are and how many results have been returned.

Best Practices

• Display at least one way for users to navigate through pages. If possible, provide more than one option (eg. Previous/Next controls and a Numeric Input).
• Display the Current Page to provide awareness of location in relation to the other pages.
• If feasible, display additional details (number of pages and total number of items) to communicate even more context about the content or data the user is paging through.

Each element of Pagination has been built separately so you may compose it in a variety of ways. How you decide to put this component together will likely depend on the reality of the technical constraints that exist and your user needs.

Below are some examples of how you can configure Pagination based on screen size or technical considerations. These recommendations are not exhaustive.

Based on Screen Size:

• For smaller screens, it’s recommended to show page navigation controls with no more than 3 pages.
• For larger screens, you can show up to 5 pages, both types of page navigation controls, and a numeric input with additional details.

Based on Technical Considerations:

• If your API is unable to return a total page number, we recommend showing the Previous/Next page navigation controls, the Current Page Number, and up to 4 other Page Numbers (if possible).
• If your API is able to return a known number of pages, composability options are endless. You can essentially pair any combination of elements together to create a solution that is best for your use case.

Examples

Basic Example

Pagination includes a container Pagination component and a number of subcomponents which can be composed in a variety of ways.

In this example, we set up a basic Pagination component with the default range of five pages, as well as step controls (Pagination.StepToPreviousButton and Pagination.StepToNextButton) that allow you to move to the previous page or the next page.

Note that you must include Pagination.AdditionalDetails to meet accessibility standards (with one exception, see Pagination.AdditionalDetails for more information). It is an aria-live region that announces the current page update to screen readers. If you wish to prevent it from displaying (as we've done in the remaining examples), you may set its shouldHideDetails prop to true. The visually hidden region will still be accessible to screen readers.

Hoisted Model

By default, Pagination will create and use its own model internally. Alternatively, you may configure your own model with usePaginationModel and pass it to Pagination via the model prop. This pattern is referred to as hoisting the model and provides direct access to its state and events outside of the Pagination component.

In this example, we set up external observation of the model state and create an external button to trigger an event to change the current page.

Jump Controls

This example adds jump controls (Pagination.JumpToFirstButton and Pagination.JumpToLastButton) that allow you to skip to the first and last pages in the range.

GoTo Form

This example adds a form (Pagination.GoToForm) that allows you to skip to a specific page within the range.

Right-to-Left (RTL)

Pagination supports right-to-left languages when specified in the CanvasProvider theme.

Custom Range

This example uses a custom range that allows you to control the width of the component.

Responsive Range

In some situations, you might want to adjust Pagination's range based on the width of the container. You can use useResizeObserver to accomplish this as in the example below.

Component API

<Pagination
  aria-label="Pagination"
  lastPage={100}
  initialCurrentPage={6}
  rangeSize={3}
  onPageChange={pageNumber => console.log(pageNumber)}
>
  {Child components}
</Pagination>

const model = usePaginationModel({
  lastPage: 100,
  initialCurrentPage: 6,
  rangeSize: 3,
  onPageChange: pageNumber => console.log(pageNumber),
});

return (
  <Pagination aria-label="Pagination" model={model}>
    {Child components}
  </Pagination>
);

<Pagination.Controls>{Child components}</Pagination.Controls>

<Pagination.JumpToFirstButton aria-label="First" />

<Pagination.StepToPreviousButton aria-label="Previous" />

<Pagination.StepToNextButton aria-label="Next" />

<Pagination.JumpToLastButton aria-label="Last" />

<Pagination.PageList>
  {({state}) =>
    state.range.map(pageNumber => (
      <Pagination.PageListItem key={pageNumber}>
        <Pagination.PageButton aria-label={`Page ${pageNumber}`} pageNumber={pageNumber} />
      </Pagination.PageListItem>
    ))
  }
</Pagination.PageList>

<Pagination.PageListItem>{Child element}</Pagination.PageListItem>

<Pagination.PageButton aria-label="Page 2" pageNumber={2} />

<Pagination.GoToForm>{Child elements}</Pagination.GoToForm>

<Pagination.GoToTextInput aria-label="Go to page number" />

<Pagination.GoToLabel>{({state}) => `of ${state.lastPage} pages`}</Pagination.GoToLabel>

<Pagination.AdditionalDetails>
  {({state}) =>
    `${getVisibleResultsMin(state.currentPage, resultCount)}-${getVisibleResultsMax(
      state.currentPage,
      resultCount,
      totalCount
    )} of ${totalCount} results`
  }
</Pagination.AdditionalDetails>

Model

If Pagination was stripped of all its markup, attributes, and styling, what would remain is the model. The model is an object composed of two parts: state which describes the current snapshot in time of the component and events which describes events that can be sent to the model.

By default, Pagination will create a model and share it internally with its subcomponents using React context. You may subscribe to PaginationContext if you wish to create a custom subcomponent for your implementation. Here's a simple example.

import * as React from 'react';
import {Pagination, PaginationContext} from '@workday/canvas-kit-react/pagination';

const CustomButton = (props: React.HTMLAttributes<HTMLButtonElement>) => {
  const model = React.useContext(PaginationContext);

  const handleClick = (e: React.MouseEvent<HTMLButtonElement, MouseEvent>) => {
    // If onClick is provided, pass the event along
    props.onClick?.(e);
    model.events.goTo(10);
  };

  return (
    <button onClick={handleClick} {...props}>
      Go To Page 10
    </button>
  );
};

export const CustomPagination = () => {
  return (
    <Pagination aria-label="Pagination" lastPage={20}>
      <CustomButton aria-label="Page 10" />
      {/* Other subcomponents */}
    </Pagination>
  );
};

Alternatively, if you need direct access to the model's state and events outside of the Pagination component, you may configure your own model with usePaginationModel and pass it to Pagination via a pattern called hoisting the model.

const model = usePaginationModel({
  lastPage,
  onPageChange: number => console.log(number),
});

<Pagination aria-label="Pagination" model={model}>
  {/* Child components */}
</Pagination>;

usePaginationModel

usePaginationModel accepts a configuration object with the following properties and returns a PaginationModel with state and events properties.

Utilities

getLastPage

const lastPage = getLastPage(10, 128); //=> 13

getRangeMin

const range = [1, 2, 3, 4, 5];
const rangeMin = getRangeMin(range); //=> 1

getRangeMax

const range = [1, 2, 3, 4, 5];
const rangeMin = getRangeMax(range); //=> 5

getVisibleResultsMin

const pageMin = getVisibleResultsMin(5, 10); //=> 41

getVisibleResultsMax

const currentPage = 5;
const resultCount = 10;
const totalCount = 42;
const pageMax = getVisibleResultsMax(currentPage, resultCount, totalCount); //=> 42

Accessibility Guidelines

• The actively selected page in the component is conveyed to assistive technology by setting aria-current="page" on the button element.
• Icon only Primary/Secondary/Tertiary buttons inside the component must have accessible names for assistive technologies. For example: “Next,” “Previous,” “First,” “Last.”
• Pagination buttons can be focused with the keyboard and actioned with 'Enter' or 'Spacebar' keys. Please note that aria-disabled is used in this component, so buttons with this attribute will not be actionable using 'Enter' or 'Spacebar'.
• If the browser does not reload a full page of content and change the page title after interacting with pagination, non-visual screen reader users will need to be alerted of the new content revealed on screen. This can be accomplished by setting keyboard focus at the top of the updated content.
• The additional details variant (X - Y of Z items) is inside of a live region and designed to be announced by assistive technologies in real-time.
• For more information on colors and contrast, check out our article on Accessible Color.
• For more information on non-text content, check out our article on Alt-Text and Non-Text Content Labels.

Content Guidelines

• If customizing the label of the total number of items, use a word that accurately describes the items that are being shown.
• Placement of the label is flexible.