Skip to content
silverpoint
Documentation menu

UI components · Overlays · new in 0.7

SpModal

A dialog on a card frame over a hatched backdrop: focus trapped, Escape closes it. Group: Overlays · new in silverpoint 0.7, in React, Vue, Angular and Reflex (sp_modal).

Live

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

Ground
Substrate
Mode
Palette

Apply changes

The geometry of the data does not move.

Apply the new ground to every chart on the page?

Code

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

tsx
import { useState } from 'react';
import { SpButton } from '@silverpoint/react/ui/button';
import { SpModal } from '@silverpoint/react/ui/modal';

export function ApplyChanges() {
  const [open, setOpen] = useState(false);
  return (
    <SpModal
      title="Apply changes"
      description="The geometry of the data does not move."
      trigger={<button type="button">Open the modal</button>} // any element you write
      footer={<SpButton variant="primary" onClick={() => setOpen(false)}>Apply</SpButton>}
      open={open}
      onOpenChange={setOpen}
    >
      <p>Apply the new ground to every chart on the page?</p>
    </SpModal>
  );
}

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

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'.
width widthstringCSS length. Default '520px' (from ui.css).
dismissible dismissiblebooleanEscape and a backdrop click close it. 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 SpModal? Open an issue on GitHub — the form comes pre-filled with the component and the version.