Skip to content
silverpoint
Documentation menu

UI components · Overlays · new in 0.7

SpDrawer

The same dialog, sliding in from any edge (side='end', the default, 'start', 'top' or 'bottom'). Group: Overlays · new in silverpoint 0.7, in React, Vue, Angular and Reflex (sp_drawer).

Live

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

Ground
Substrate
Mode
Palette

Settings

A panel that slides in from any edge, over a hatched backdrop.

Code

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

tsx
import { SpDrawer } from '@silverpoint/react/ui/drawer';

// side: start, end (the default), top or bottom; uncontrolled here
<SpDrawer title="Settings" side="end" trigger={<button type="button">Open the drawer</button>}>
  <p>A panel that slides in from any edge, over a hatched backdrop.</p>
</SpDrawer>

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

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 …/>}#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
Footerfooter#footer slot<ng-template spFooter>footer=

Props

React / AngularVueTypeDescription
title titlestringThe heading, ${id}--title, that names the dialog.
description descriptionstringA paragraph, ${id}--description, that describes the dialog.
label labelstringAccessible name without a title.
closable closablebooleanDefault true.
closeLabel close-labelstringDefault 'Close'.
dismissible dismissiblebooleanEscape and a backdrop click close it. Default true.
side side'start' | 'end' | 'top' | 'bottom'Default 'end'.
extent extentstringCSS length across the side. Default '380px' (start/end) or '320px' (top/bottom).
modal modalbooleanfalse opens with show(). Default true.

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