Skip to content
silverpoint
Documentation menu

UI components · Overlays · new in 0.7

SpTooltip

A short label shown on hover or keyboard focus, after a delay. Group: Overlays · new in silverpoint 0.7, in React, Vue, Angular and Reflex (sp_tooltip).

Live

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

Ground
Substrate
Mode
Palette

Code

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

tsx
import { SpTooltip } from '@silverpoint/react/ui/tooltip';

<SpTooltip
  text="Drawn on the ground's own frame" // the trigger's accessible description
  trigger={<button type="button">Hover or focus me</button>}
  side="top"
  delay={300}
/>

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

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
Triggertrigger={<button …/>} (required)#trigger slota projected element with spTriggertrigger= (a string or sp_trigger)
Open stateopen + onOpenChange, or defaultOpenv-model:open, or default-open[(open)], or [defaultOpen]open + on_open_change, or default_open

Props

React / AngularVueTypeDescription
text requiredtextstringThe tooltip, the trigger's accessible description.
side side'top' | 'end' | 'bottom' | 'start'Default 'top'.
align align'start' | 'center' | 'end'Default 'center'.
offset offsetnumberDefault 6.
delay delaynumberDefault 300 ms.

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