Skip to content
silverpoint
Documentation menu

UI components · Composed · new in 0.7

SpTimelineList

A vertical list of events: done (hatched), current (heightened), pending and error. Group: Composed · new in silverpoint 0.7, in React, Vue, Angular and Reflex (sp_timeline_list).

Live

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

Ground
Substrate
Mode
Palette
  1. 09:12DrawnThe ground is prepared.
  2. 10:40InkedHatching and heightening.
  3. 11:05ReviewedPrecision mode checked.
  4. —PublishedWaiting for the release.

Code

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

tsx
import { SpTimelineList } from '@silverpoint/react/ui/timeline-list';

const steps = [
  { title: 'Drawn', time: '09:12', description: 'The ground is prepared.', status: 'done' },
  { title: 'Reviewed', time: '11:05', description: 'Precision mode checked.', status: 'current' },
  { title: 'Published', time: '—', description: 'Waiting for the release.', status: 'pending' },
] as const;

<SpTimelineList items={steps} label="Release steps" />

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 { SpTimelineList } from '@silverpoint/react/ui/timeline-list';
Vueimport { SpTimelineList } from '@silverpoint/vue/ui/timeline-list';
Angularimport { SpTimelineList } from '@silverpoint/angular/ui/timeline-list'; · sp-timeline-list
Reflexfrom reflex_silverpoint_react import sp_timeline_list

Props

React / AngularVueTypeDescription
items requireditemsreadonly TimelineListItem[]The events, in reading order.
label labelstringAccessible name of the list.

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 SpTimelineList? Open an issue on GitHub — the form comes pre-filled with the component and the version.