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:
Code
The same example in each framework; pick one once and every example on the site follows it.
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><script setup lang="ts">
import { SpDrawer } from '@silverpoint/vue/ui/drawer';
</script>
<template>
<SpDrawer title="Settings" side="end">
<template #trigger><button type="button">Open the drawer</button></template>
<p>A panel that slides in from any edge, over a hatched backdrop.</p>
</SpDrawer>
</template>import { Component } from '@angular/core';
import { SpTrigger } from '@silverpoint/angular/ui';
import { SpDrawer } from '@silverpoint/angular/ui/drawer';
@Component({
selector: 'app-settings',
imports: [SpDrawer, SpTrigger],
template: `
<sp-drawer title="Settings" side="end">
<button type="button" spTrigger>Open the drawer</button>
<p>A panel that slides in from any edge, over a hatched backdrop.</p>
</sp-drawer>
`,
})
export class Settings {}sp_drawer(rx.el.p("A panel that slides in…"), trigger="Open the drawer", title="Settings", side="end")Import
Import @silverpoint/grounds/ui.css once, beside styles.css; Reflex adds it for you. Every adapter also exports it from the ui barrel.
| Framework | Import |
|---|---|
| React | import { SpDrawer } from '@silverpoint/react/ui/drawer'; |
| Vue | import { SpDrawer } from '@silverpoint/vue/ui/drawer'; |
| Angular | import { SpDrawer } from '@silverpoint/angular/ui/drawer'; · sp-drawer |
| Reflex | from 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.
| React | Vue | Angular | Reflex | |
|---|---|---|---|---|
| Trigger | trigger={<button …/>} | #trigger slot | a projected element with spTrigger | trigger= (a string or sp_trigger) |
| Open state | open + onOpenChange, or defaultOpen | v-model:open, or default-open | [(open)], or [defaultOpen] | open + on_open_change, or default_open |
| Footer | footer | #footer slot | <ng-template spFooter> | footer= |
Props
| React / Angular | Vue | Type | Description |
|---|---|---|---|
title | title | string | The heading, ${id}--title, that names the dialog. |
description | description | string | A paragraph, ${id}--description, that describes the dialog. |
label | label | string | Accessible name without a title. |
closable | closable | boolean | Default true. |
closeLabel | close-label | string | Default 'Close'. |
dismissible | dismissible | boolean | Escape and a backdrop click close it. Default true. |
side | side | 'start' | 'end' | 'top' | 'bottom' | Default 'end'. |
extent | extent | string | CSS length across the side. Default '380px' (start/end) or '320px' (top/bottom). |
modal | modal | boolean | false 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 / Angular | Vue | Reflex | Type | Description |
|---|---|---|---|---|
id | id | id | str | The frame variant and every related id derive from it. |
ground | ground | ground | Literal['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. |
substrate | substrate | substrate | Literal['cream', 'green', 'blue', 'ochre', 'prussian'] | Prepared substrate within the ground. |
mode | mode | mode | Literal['ink', 'precision'] | ink by default; precision disables inking. |
seed | seed | seed | str | int | Seed of the frame's hand; overrides id for the frame variant only. |
size | size | size | Literal['sm', 'md', 'lg'] | Control size: sm, md (default) or lg. |
palette | palette | palette | dict[str, str] | Colours over the ground's (set with palette=), merged over the dashboard's and the provider's. |
className | class-name | class_name | str | Added to the component's root element, after its own classes. |
palette | palette | palette | Palette | Colours 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.