Skip to content
silverpoint
Documentation menu

UI components · Data entry

Slider

A native range over an exact rail, with marks. Group: Data entry · component 6 of 17, new in silverpoint 0.3.
size="lg"
mode="precision"
substrate="green"

States

The 2 reference states silverpoint declares for Slider, live on both grounds, with their code. As in upstream's documentation the examples are uncontrolled: the state's value is the default value. Pick a framework once and every example on the site follows it.

marks

silverpoint · cream
cyanotype · prussian
tsx
import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import '@silverpoint/grounds/ui.css';
import { SpSlider } from '@silverpoint/react/ui/slider';

<SpSlider label="Volume" name="volume" marks={[0, 25, 50, 75, 100]} defaultValue={30} />

disabled

silverpoint · cream
cyanotype · prussian
tsx
import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import '@silverpoint/grounds/ui.css';
import { SpSlider } from '@silverpoint/react/ui/slider';

<SpSlider label="Volume" name="volume" disabled defaultValue={30} />

Import

Each component has its own subpath under ui/, and every adapter exports them all from ui. Import @silverpoint/grounds/ui.css once, beside styles.css; Reflex adds it for you.

FrameworkImport
Reactimport { SpSlider } from '@silverpoint/react/ui/slider';
Vueimport { SpSlider } from '@silverpoint/vue/ui/slider';
Angularimport { SpSlider } from '@silverpoint/angular/ui/slider'; // <sp-slider>
Reflexfrom reflex_silverpoint_react import sp_slider

Binding the value

Controlled or uncontrolled, the way each framework does it. The change event carries the new value itself (a string, a bool or a number), never a DOM event.

FrameworkControlledUncontrolled
Reactvalue / onChangedefaultValue
Vuev-model="x"default-value
Angular[(value)]="x", ngModel, formControl[defaultValue]
Reflexvalue=State.x, on_change=State.set_xdefault_value=…

Props

The props Slider adds to the ones every UI component takes.

React / AngularVueReflexTypeDescription
labellabellabelstrAccessible name of the range. Required.
minminminint | floatLowest value (0 by default).
maxmaxmaxint | floatHighest value (100 by default).
stepstepstepint | floatStep (1 by default).
namenamenamestrForm field name; the native input submits under it.
disableddisableddisabledboolNot focusable and not submitted.
marksmarksmarkslist[int | float]Values on the rail that get a labelled mark.
valuevaluevalueint | floatControlled value.
defaultValuedefault-valuedefault_valueint | floatInitial value of an uncontrolled slider (min by default).
onChangeon-changeon_changeeventThe new value (a number).

Common props

Every UI component also takes these. Like a chart's, they fall back to the dashboard the component sits in, then to the provider. Read more about the UI components.

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.
Report it
Found something wrong with SpSlider? Open an issue on GitHub — the form comes pre-filled with the component and the version.