Pagination
Move through long collections with bounded numbered links.
Preview
Choose an example destination. The preview updates locally without leaving this page.
Example
<.pagination page={@page} total_pages={@total_pages} path={fn page -> ~p"/projects?page=#{page}" end} />
API contract
pagination/1
uses declared Phoenix attributes and slots. This table is generated from the compiled component metadata.
| Attribute | Type | Required | Default | Accepted values |
|---|---|---|---|---|
page |
:integer |
Yes | — |
Any value matching the declared type |
total_pages |
:integer |
Yes | — |
Any value matching the declared type |
path |
:any |
Yes | — |
Any value matching the declared type |
label |
:string |
No | "Pagination" |
Any value matching the declared type |
class |
:any |
No | nil |
Any value matching the declared type |
States and behavior
Current, disabled, loading, or active state is exposed where the component supports it.
Keyboard and accessibility
Behavioral tests
These automated checks are applied to this component by the package and documentation test suites.
-
ExUnit
Bounded page navigation
Renders previous and next labels, numbered destinations, and aria-current for the selected page.
test/vaylan_ui/components_test.exs -
Docs
Preview behavior contract
Classified as navigation. Choose an example destination. The preview updates locally without leaving this page.
examples/docs/test/vaylan_ui_docs_web/controllers/page_controller_test.exs -
Docs
Stable public component page
Renders the component name, example, API contract, accepted values, and keyboard and accessibility guidance at its stable URL.
examples/docs/test/vaylan_ui_docs_web/controllers/page_controller_test.exs