Skip to content
silverpoint
Documentation menu

UI components · Composed · new in 0.7

SpGlyph

One exact 16×16 mark of UI_GLYPHS — tick, cross, chevrons, arrows, sort marks… — stroked with the text colour, never inked. Group: Composed · new in silverpoint 0.7, in React, Vue, Angular and Reflex (sp_glyph).

Live

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

Ground
Substrate
Mode
Palette
tickcrosswarninginfopluschevronDownarrowUpsortellipsis

Code

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

tsx
import { SpGlyph } from '@silverpoint/react/ui/glyph';

<SpGlyph glyph="tick" />
<SpGlyph glyph="chevronDown" />
<SpGlyph glyph="sort" /> {/* any key of UI_GLYPHS, from '@silverpoint/core/ui' */}

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 { SpGlyph } from '@silverpoint/react/ui/glyph';
Vueimport { SpGlyph } from '@silverpoint/vue/ui/glyph';
Angularimport { SpGlyph } from '@silverpoint/angular/ui/glyph'; · sp-glyph
Reflexfrom reflex_silverpoint_react import sp_glyph

Props

React / AngularVueTypeDescription
glyph requiredglyphstringA key of UI_GLYPHS.

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