ObjectUIObjectUI

Pagination

Navigate through pages of content

The Pagination component allows users to navigate through pages of data.

Basic Usage

Basic Pagination

On a Later Page

With Item Count

pagination has no page-size or item-count keys: the page state it reads is currentPage and totalPages.

Schema

interface PaginationSchema {
  type: 'pagination';
  currentPage: number;            // Current page (1-based)
  totalPages: number;             // Total number of pages
  
  // Events
  // RUNTIME SLOT (objectui#6124): a React host supplies it; JSON refuses it
  // by name. Author behaviour as a node type, e.g. an action:button node.
  onPageChange?: (page: number) => void;
  
  // Styling
  className?: string;
}

On this page