Skip to content
UI Brok

Loading…

No results

Browse catalog

Pagination

Page navigation with previous/next controls and page links.

Preview

Controls

Disabled
Theme
Surface
Direction
Viewport

Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.

Installation

terminal 
php artisan ui:add pagination

Registry contract

Install confidence

php artisan ui:add pagination writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version
1.1.0
License
open
Stability
stable
Contract
v2
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/components/ui/pagination.blade.php
blade resources/views/components/ui/pagination/content.blade.php
blade resources/views/components/ui/pagination/item.blade.php
blade resources/views/components/ui/pagination/status.blade.php
blade resources/views/components/ui/pagination/link.blade.php
blade resources/views/components/ui/pagination/previous.blade.php
blade resources/views/components/ui/pagination/next.blade.php
blade resources/views/components/ui/pagination/ellipsis.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Navigation and orientation

Orient users and move between destinations.

Use when

  • Use to orient users and help them move across pages, sections, or commands. Do not hide primary wayfinding in novelty interactions or deep nested structures if straightforward navigation would be clearer.

Avoid when

  • Avoid using pagination as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.
Task length
micro
Interaction cost
low
Interruptiveness
none
Input precision
none
Mobile / touch risk
low
Accessibility risk
medium
Needs background context
No
Comparison needed
No

Preferred alternatives

  • Visible links and local navigation

Anti-patterns

  • Hiding primary wayfinding in novelty interactions

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
disabled false|true false Documented catalog control used by the preview workbench.
align string center Declared by @props in the registry Blade source.
href string # Declared by @props in the registry Blade source.
active bool false Declared by @props in the registry Blade source.
variant string ghost Declared by @props in the registry Blade source.
showLabel bool true Declared by @props in the registry Blade source.
label mixed|null null Declared by @props in the registry Blade source.

Slots

  • default — Primary Blade slot rendered by the component.
  • x-ui.pagination.content — Installed subcomponent from the registry item.
  • x-ui.pagination.item — Installed subcomponent from the registry item.
  • x-ui.pagination.status — Installed subcomponent from the registry item.
  • x-ui.pagination.link — Installed subcomponent from the registry item.
  • x-ui.pagination.previous — Installed subcomponent from the registry item.
  • x-ui.pagination.next — Installed subcomponent from the registry item.
  • x-ui.pagination.ellipsis — Installed subcomponent from the registry item.

Data slots

pagination pagination-content pagination-ellipsis pagination-item pagination-link pagination-next pagination-previous pagination-status

Capabilities

wcag-2.2-aa-target responsive rtl darkMode localized

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Usage

previews.components.pagination.default.blade.php Blade 
<x-ui.pagination>
    <x-ui.pagination.content>
        <x-ui.pagination.item>
            <x-ui.pagination.previous href="#" />
        </x-ui.pagination.item>
        <x-ui.pagination.item>
            <x-ui.pagination.link href="#">1</x-ui.pagination.link>
        </x-ui.pagination.item>
        <x-ui.pagination.item>
            <x-ui.pagination.link href="#" :active="true">2</x-ui.pagination.link>
        </x-ui.pagination.item>
        <x-ui.pagination.item>
            <x-ui.pagination.link href="#">3</x-ui.pagination.link>
        </x-ui.pagination.item>
        <x-ui.pagination.item>
            <x-ui.pagination.ellipsis />
        </x-ui.pagination.item>
        <x-ui.pagination.item>
            <x-ui.pagination.link href="#">10</x-ui.pagination.link>
        </x-ui.pagination.item>
        <x-ui.pagination.item>
            <x-ui.pagination.next href="#" />
        </x-ui.pagination.item>
    </x-ui.pagination.content>
</x-ui.pagination>

Variants

Previous / next only

Compact

Outline buttons

Disabled edges

Results summary

Rows per page

previews.components.pagination.variants.blade.php Blade 
<div class="flex flex-col gap-10">
    {{-- Previous / Next only --}}
    <div class="flex flex-col gap-3">
        <p class="text-sm font-medium text-muted-foreground">{{ __('Previous / next only') }}</p>
        <x-ui.pagination>
            <x-ui.pagination.content>
                <x-ui.pagination.item>
                    <x-ui.pagination.previous href="#" />
                </x-ui.pagination.item>
                <x-ui.pagination.item>
                    <x-ui.pagination.next href="#" />
                </x-ui.pagination.item>
            </x-ui.pagination.content>
        </x-ui.pagination>
    </div>

    {{-- Compact "Page X of Y" --}}
    <div class="flex flex-col gap-3">
        <p class="text-sm font-medium text-muted-foreground">{{ __('Compact') }}</p>
        <x-ui.pagination>
            <x-ui.pagination.content>
                <x-ui.pagination.item>
                    <x-ui.pagination.previous href="#" :show-label="false" />
                </x-ui.pagination.item>
                <x-ui.pagination.status>{{ __('Page :current of :total', ['current' => 2, 'total' => 12]) }}</x-ui.pagination.status>
                <x-ui.pagination.item>
                    <x-ui.pagination.next href="#" :show-label="false" />
                </x-ui.pagination.item>
            </x-ui.pagination.content>
        </x-ui.pagination>
    </div>

    {{-- Outline buttons --}}
    <div class="flex flex-col gap-3">
        <p class="text-sm font-medium text-muted-foreground">{{ __('Outline buttons') }}</p>
        <x-ui.pagination>
            <x-ui.pagination.content>
                <x-ui.pagination.item>
                    <x-ui.pagination.link href="#" variant="outline">1</x-ui.pagination.link>
                </x-ui.pagination.item>
                <x-ui.pagination.item>
                    <x-ui.pagination.link href="#" variant="outline" :active="true">2</x-ui.pagination.link>
                </x-ui.pagination.item>
                <x-ui.pagination.item>
                    <x-ui.pagination.link href="#" variant="outline">3</x-ui.pagination.link>
                </x-ui.pagination.item>
                <x-ui.pagination.item>
                    <x-ui.pagination.link href="#" variant="outline">4</x-ui.pagination.link>
                </x-ui.pagination.item>
            </x-ui.pagination.content>
        </x-ui.pagination>
    </div>

    {{-- Disabled edges (first page) --}}
    <div class="flex flex-col gap-3">
        <p class="text-sm font-medium text-muted-foreground">{{ __('Disabled edges') }}</p>
        <x-ui.pagination>
            <x-ui.pagination.content>
                <x-ui.pagination.item>
                    <x-ui.pagination.previous :disabled="true" />
                </x-ui.pagination.item>
                <x-ui.pagination.item>
                    <x-ui.pagination.link href="#" :active="true">1</x-ui.pagination.link>
                </x-ui.pagination.item>
                <x-ui.pagination.item>
                    <x-ui.pagination.link href="#">2</x-ui.pagination.link>
                </x-ui.pagination.item>
                <x-ui.pagination.item>
                    <x-ui.pagination.link href="#">3</x-ui.pagination.link>
                </x-ui.pagination.item>
                <x-ui.pagination.item>
                    <x-ui.pagination.next href="#" />
                </x-ui.pagination.item>
            </x-ui.pagination.content>
        </x-ui.pagination>
    </div>

    {{-- Result count + pager (spread to edges) --}}
    <div class="flex flex-col gap-3">
        <p class="text-sm font-medium text-muted-foreground">{{ __('Results summary') }}</p>
        <x-ui.pagination align="between">
            <p class="text-sm text-muted-foreground">{{ __('Showing :from–:to of :total results', ['from' => 1, 'to' => 10, 'total' => 97]) }}</p>
            <x-ui.pagination.content>
                <x-ui.pagination.item>
                    <x-ui.pagination.previous href="#" />
                </x-ui.pagination.item>
                <x-ui.pagination.item>
                    <x-ui.pagination.link href="#" :active="true">1</x-ui.pagination.link>
                </x-ui.pagination.item>
                <x-ui.pagination.item>
                    <x-ui.pagination.link href="#">2</x-ui.pagination.link>
                </x-ui.pagination.item>
                <x-ui.pagination.item>
                    <x-ui.pagination.link href="#">3</x-ui.pagination.link>
                </x-ui.pagination.item>
                <x-ui.pagination.item>
                    <x-ui.pagination.next href="#" />
                </x-ui.pagination.item>
            </x-ui.pagination.content>
        </x-ui.pagination>
    </div>

    {{-- Page-size select + status (interactive window) --}}
    <div class="flex flex-col gap-3">
        <p class="text-sm font-medium text-muted-foreground">{{ __('Rows per page') }}</p>
        <x-ui.pagination align="between">
            <div class="flex items-center gap-2">
                <span class="text-sm text-muted-foreground">{{ __('Rows per page') }}</span>
                <x-ui.select size="sm" class="w-20" aria-label="{{ __('Rows per page') }}">
                    <option>10</option>
                    <option>20</option>
                    <option>50</option>
                </x-ui.select>
            </div>
            <x-ui.pagination.content>
                <x-ui.pagination.status>{{ __('Page :current of :total', ['current' => 1, 'total' => 9]) }}</x-ui.pagination.status>
                <x-ui.pagination.item>
                    <x-ui.pagination.previous href="#" :show-label="false" :disabled="true" />
                </x-ui.pagination.item>
                <x-ui.pagination.item>
                    <x-ui.pagination.next href="#" :show-label="false" />
                </x-ui.pagination.item>
            </x-ui.pagination.content>
        </x-ui.pagination>
    </div>
</div>

Accessibility & localization

WCAG 2.2 AA RTL-ready data-slot Keyboard focus-visible Localized labels
  • Accessibility target: wcag-2.2-aa-target.
  • Uses semantic HTML and a stable data-slot attribute for styling/scripting hooks.
  • Focus-visible rings use the ring token so keyboard focus is always visible.
  • Disabled and invalid states are conveyed to assistive tech, not by color alone.
  • Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces above.
  • Labels go through __() and the component uses logical properties (ms-*, text-start, start-*) so it mirrors correctly — flip the preview to RTL to confirm.

Source

The exact, editable file ui:add writes into your app — copy it or own the whole thing. Previews render this same code; there are no preview-only components.

Changelog

Current version: v1.1.0. See the site changelog for the full release history.