Documentation

Pagination

Allows the user to select a specific page from a range of pages.

Examples

import { Pagination } from 'kalki-design'

<Pagination>Click me</Pagination>

Installation

npx kalki-design add pagination

Usage

import { Pagination } from 'kalki-design'

export default function Example() {
  return <Pagination />
}

API Reference

NameTypeDefaultDescription
NametotalTypenumberDefault—DescriptionTotal number of data items.
NamepageTypenumberDefault—DescriptionThe current active page.
NameonChangeType(page: number) => voidDefault—DescriptionCallback fired when page changes.
NamepageSizeTypenumberDefault10DescriptionNumber of items per page.
NamesiblingCountTypenumberDefault1DescriptionNumber of pages to show around current page before folding.
NamesizeType'sm' | 'md' | 'lg'Default'md'DescriptionSize of the pagination items.
NameshowEdgesTypebooleanDefaulttrueDescriptionWhether to show previous/next buttons.