Skip to content
silverpoint
Documentation menu

UI components · Composed · new in 0.7

SpPagination

Previous and next, first and last, a window around the current page (heightened); on_change(page). Group: Composed · new in silverpoint 0.7, in React, Vue, Angular and Reflex (sp_pagination).

Live

Drawn here with the Reflex version, sp_pagination, on the ground you pick:

Ground
Substrate
Mode
Palette

Page 3

Code

The same example in each framework; pick one once and every example on the site follows it.

tsx
import { useState } from 'react';
import { SpPagination } from '@silverpoint/react/ui/pagination';

export function Pages() {
  const [page, setPage] = useState(3);
  // total: items in all pages; pageSize defaults to 10. onChange receives the page number.
  return <SpPagination total={240} current={page} onChange={setPage} showTotal />;
}

Import

Import @silverpoint/grounds/ui.css once, beside styles.css; Reflex adds it for you. Every adapter also exports it from the ui barrel.

FrameworkImport
Reactimport { SpPagination } from '@silverpoint/react/ui/pagination';
Vueimport { SpPagination } from '@silverpoint/vue/ui/pagination';
Angularimport { SpPagination } from '@silverpoint/angular/ui/pagination'; · sp-pagination
Reflexfrom reflex_silverpoint_react import sp_pagination

Events, values and slots

Each framework's own way. A change carries the new value itself (a key, a page, a number, a bool), never a DOM event.

ReactVueAngularReflex
Pagecurrent + onChange(page), or defaultCurrentv-model:current[(current)]current + on_change

Props

React / AngularVueTypeDescription
total requiredtotalnumberThe number of items paged over.
pageSize page-sizenumberDefault 10.
siblings siblingsnumberPages shown on each side of the current one. Default 1.
showTotal show-totalbooleanDefault false.
totalTemplate total-templatestringDefault '{start}–{end} of {total}'.
label labelstringDefault 'Pagination'.
previousLabel previous-labelstringDefault 'Previous page'.
nextLabel next-labelstringDefault 'Next page'.
pageLabel page-labelstringDefault 'Page'.
disabled disabledbooleanEvery page button disabled.

In Reflex the names are snake_case; the Reflex column of Composed components shows the builder's arguments.

Common props

Every UI component also takes these, falling back to the dashboard it sits in, then to the provider. In Reflex they read silverpoint_provider too; only sp_trigger does not: pass them to it.

React / AngularVueReflexTypeDescription
idididstrThe frame variant and every related id derive from it.
groundgroundgroundLiteral['silverpoint', 'cyanotype'] | str | dict[str, Any]Style ground: "silverpoint" or "cyanotype", or a ground object. Defaults to the dashboard's, then the provider's, or silverpoint.
substratesubstratesubstrateLiteral['cream', 'green', 'blue', 'ochre', 'prussian']Prepared substrate within the ground.
modemodemodeLiteral['ink', 'precision']ink by default; precision disables inking.
seedseedseedstr | intSeed of the frame's hand; overrides id for the frame variant only.
sizesizesizeLiteral['sm', 'md', 'lg']Control size: sm, md (default) or lg.
palettepalettepalettedict[str, str]Colours over the ground's (set with palette=), merged over the dashboard's and the provider's.
classNameclass-nameclass_namestrAdded to the component's root element, after its own classes.
palettepalettepalettePaletteColours over the ground's, merged over the dashboard's and the provider's.
Report it
Found something wrong with SpPagination? Open an issue on GitHub — the form comes pre-filled with the component and the version.