---
title: "Pagination"
description: "Pagination with accessible presentation and local state."
---

# Pagination

Pagination with accessible presentation and local state.

## Installation

Install the shared package once in your Exact app. This version is a beta.

```sh
bun add --exact @rightui/ui@0.4.0-beta.4
```

Or choose another package manager:

```sh
npm install --save-exact @rightui/ui@0.4.0-beta.4
pnpm add --save-exact @rightui/ui@0.4.0-beta.4
yarn add --exact @rightui/ui@0.4.0-beta.4
```

Exact compilation uses Bun 1.4.2. Register Geist and Newsreader, declare the font marker and add the root provider using [Installation](/docs/installation).

### Manual source setup

Install an editable copy of the complete package:

```sh
mkdir -p vendor/rightui vendor/rightui-ui
npm pack @rightui/ui@0.4.0-beta.4 --pack-destination vendor/rightui
tar -xzf ./vendor/rightui/rightui-ui-0.4.0-beta.4.tgz -C vendor/rightui-ui --strip-components=1
bun add file:./vendor/rightui-ui
```

Keep package.json, the Contract files, ui.tamber, assets and licenses together.

### Import

```contract
use Pagination from "@rightui/ui"
```

## Usage

Import Pagination from @rightui/ui. Store its value in state and update it through the provided action callback.

## Example

```contract
use FontWeights from "@rightui/ui"
use uiFontFamily, Pagination from "@rightui/ui"

component Demo
  props
    width: number
    reduced: bool
  inject
    uiWeights: FontWeights
    uiFont: string
  derive narrow = width < 600
  state page = 1
  action changePage(v: number)
    page = v
  state lastPage = 6
  action changeLastPage(v: number)
    lastPage = v
  view
    column gap="ui.space-16" min-width=0 max-width="100%"
      Pagination(id="catalog-pages", page=page, total=6, change=changePage)
      text "Last page boundary" font-size="ui.text-sm" font-weight=uiWeights.semibold font-family=uiFontFamily(uiFont) data-rightui-font="body"
      Pagination(id="variation-pagination-last", page=lastPage, total=6, change=changeLastPage)

```

## API Reference

| Property | Type |
| --- | --- |
| Pagination.id | string |
| Pagination.page | number |
| Pagination.total | number |
| Pagination.change | action |

## Source

File: packages/ui/navigation.contract

```contract
use FontWeights from "./typography-context.contract"
use uiFontFamily from "./typography-context.contract"
use Control from "./styles.contract"
use Button from "./button.contract"
use BreadcrumbRoot, BreadcrumbList, BreadcrumbItem, BreadcrumbLink, BreadcrumbPage, BreadcrumbSeparator from "./breadcrumb-parts.contract"
component Breadcrumb
  props
    id: string
    labels: string[]
    choose: action
  view
    BreadcrumbOptions(id=id, labels=labels, choose=choose, hrefs=[], separator="chevron", label="Breadcrumb", direction="inherit")

component BreadcrumbOptions
  props
    id: string
    labels: string[]
    choose: action
    hrefs: string[]
    separator: string
    label: string
    direction: string
  inject
    uiWeights: FontWeights
    uiFont: string
  view
    BreadcrumbRoot(id=id, label=label, direction=direction)
      BreadcrumbList()
        for item, i in labels key=i
          if i > 0
            BreadcrumbSeparator(kind=separator, direction=direction)
          BreadcrumbItem()
            if i == labels.length - 1
              BreadcrumbPage(label=item)
            else if i < hrefs.length and (match hrefs.at(i) { case some(href) => href, case none => "" }) != ""
              BreadcrumbLink(id=id + "-" + i.toString(), href=(match hrefs.at(i) { case some(href) => href, case none => "" }), label=item)
            else
              button id=(id + "-" + i.toString()) testId=(id + "-" + i.toString()) class=Control font-weight=uiWeights.medium press=choose(i) padding="0px" min-height="ui.space-20" border="0" background-color="transparent" color="ui.muted-foreground"
                :hover
                  color="ui.foreground"
                text item font-size="ui.text-sm" font-family=uiFontFamily(uiFont) data-rightui-font="body"

component Pagination
  props
    id: string
    page: number
    total: number
    change: action
  inject
    uiWeights: FontWeights
    uiFont: string
  derive count = max(1, floor(total))
  derive current = max(1, min(count, floor(page)))
  derive start = max(1, min(current - 2, count - 4))
  view
    nav id=id testId=id aria-label="Pagination"
      row gap="ui.space-4" flex-wrap="wrap" align-items="center" justify-content="center"
        Button(id=id + "-previous", label="Previous", variant="outline", disabled=current == 1, press=change(current - 1))
        for i in range(min(5, count)) key=i
          button id=(id + "-page-" + (start + i).toString()) testId=(id + "-page-" + (start + i).toString()) class=Control font-weight=uiWeights.medium
            aria-label=("Page " + (start + i).toString()) aria-current=(current == start + i ? "page" : "false") press=change(start + i)
            min-width="ui.space-36" height="ui.space-36" padding="ui.space-8 ui.space-12" border-width=(current == start + i ? "ui.border-width" : "ui.border-width") border-style=(current == start + i ? "solid" : "solid") border-color=(current == start + i ? "ui.border" : "transparent") background-color="ui.background" color="ui.foreground"
            text (start + i).toString() font-family=uiFontFamily(uiFont) data-rightui-font="body"
        Button(id=id + "-next", label="Next", variant="outline", disabled=current == count, press=change(current + 1))

component ButtonGroup
  props
    label: string
  slot
  view
    row role="group" aria-label=label gap="ui.space-4" flex-wrap="wrap"
      children

```
