@commercetools-uikit/pagination

Pagination

Description

Components for navigating through pages of items

Installation

yarn add @commercetools-uikit/pagination

npm --save install @commercetools-uikit/pagination

Additionally install the peer dependencies (if not present)

yarn add react react-intl

npm --save install react react-intl

Usage

import React from 'react';
import { Pagination } from '@commercetools-uikit/pagination';

const Example = ({ items }) => (
  <Pagination
    totalItems={items.length}
    currentPage={1}
    onPageChange={() => {}}
    onPageSizeChange={() => {}}
  />
);

export default Example;

Properties

Props	Type	Required	Default	Description
totalItems	number	✅		Total number of items across all pages
currentPage	number	✅		The currently selected page
onPageChange	func	✅		A callback function, called when the page is changed. Signature: (page: number) => void Signature: (page: number) => void
pageSize	number		20	Number of items per page, according to the pre-defined range values.
pageSizeRange	enum Possible values: 's', 'm', 'l'		's'	Range of items per page. s: 20,50 m: 20,50,100 l: 200,500
onPageSizeChange	func	✅		A callback function, called when pageSize is changed. Signature: (pageSize: number) => void