Skip to content
silverpoint
Documentation menu

UI components · Composed · new in 0.7

SpInputNumber

A number field with exact − and + steppers, clamped to min and max; on_change receives the number. Group: Composed · new in silverpoint 0.7, in React, Vue, Angular and Reflex (sp_input_number).

Live

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

Ground
Substrate
Mode
Palette

Value 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 { SpInputNumber } from '@silverpoint/react/ui/input-number';

export function Copies() {
  const [copies, setCopies] = useState<number | null>(3); // null is an empty field
  return <SpInputNumber label="Copies" value={copies} onChange={setCopies} min={1} max={10} />;
}

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 { SpInputNumber } from '@silverpoint/react/ui/input-number';
Vueimport { SpInputNumber } from '@silverpoint/vue/ui/input-number';
Angularimport { SpInputNumber } from '@silverpoint/angular/ui/input-number'; · sp-input-number
Reflexfrom reflex_silverpoint_react import sp_input_number

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
Valuevalue + onChange(number | null), or defaultValuev-model[(value)], ngModel, formControlvalue + on_change

Props

React / AngularVueTypeDescription
min minnumberThe lowest value; the value is clamped to it.
max maxnumberThe highest value; the value is clamped to it.
step stepnumberDefault 1.
precision precisionnumberDecimals.
placeholder placeholderstringHint shown while empty; not a substitute for the accessible name.
label labelstringAccessible name, when no <label for> names the control.
message messagestringHelp or error text under the control, referenced by aria-describedby.
invalid invalidbooleanSets aria-invalid and draws the exact ⚠ glyph.
disabled disabledbooleanNot focusable and not submitted; the steppers are disabled too.
readOnly read-onlybooleanFocusable and submitted, but not editable.
name namestringForm field name; the native input submits under it.
decrementLabel decrement-labelstringDefault 'Decrease'.
incrementLabel increment-labelstringDefault 'Increase'.

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