Skip to content
silverpoint
Documentation menu

UI components · Composed · new in 0.7

SpCollapse · SpCollapseItem

Panels that open and close, on native <details>; accordion=True keeps one open. Group: Composed · new in silverpoint 0.7, in React, Vue, Angular and Reflex (sp_collapse · sp_collapse_item).

Live

Drawn here with the Reflex version, sp_collapse · sp_collapse_item, on the ground you pick:

Ground
Substrate
Mode
Palette
What is silverpoint?

A fine silver line on a prepared ground.

And cyanotype?

A white line on Prussian blue; tone is its weight.

Precision mode

The inking switched off: exact rules only.

Code

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

tsx
import { SpCollapse, SpCollapseItem } from '@silverpoint/react/ui/collapse';

<SpCollapse accordion> {/* native exclusive <details name> */}
  <SpCollapseItem title="What is silverpoint?" defaultOpen>
    <p>A fine silver line on a prepared ground.</p>
  </SpCollapseItem>
  <SpCollapseItem title="And cyanotype?">
    <p>A white line on Prussian blue; tone is its weight.</p>
  </SpCollapseItem>
</SpCollapse>

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 { SpCollapse, SpCollapseItem } from '@silverpoint/react/ui/collapse';
Vueimport { SpCollapse, SpCollapseItem } from '@silverpoint/vue/ui/collapse';
Angularimport { SpCollapse, SpCollapseItem } from '@silverpoint/angular/ui/collapse'; · sp-collapse · sp-collapse-item
Reflexfrom reflex_silverpoint_react import sp_collapse, sp_collapse_item

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
Items<SpCollapseItem> childrendefault slotprojected sp-collapse-itemsp_collapse(*items)
Item openopen + onToggle(open), or defaultOpenv-model:open, @toggle[(open)], (toggle)open=

Props

SpCollapse

React / AngularVueTypeDescription
accordion accordionbooleanOne item open at a time, natively (<details name>). Default false.
bordered borderedbooleanDefault true.

SpCollapseItem

React / AngularVueTypeDescription
title requiredtitlestring—
disabled disabledboolean—

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