UI components · Composed · new in 0.7
SpDescriptions
A label–value grid (a <dl>), optionally card-framed; one column on narrow containers. Group: Composed · new in silverpoint 0.7, in React, Vue, Angular and Reflex (sp_descriptions).
Live
Drawn here with the Reflex version, sp_descriptions, on the ground you pick:
Code
The same example in each framework; pick one once and every example on the site follows it.
import { SpDescriptions } from '@silverpoint/react/ui/descriptions';
const release = [
{ label: 'Ground', value: 'silverpoint' },
{ label: 'Substrate', value: 'cream' },
{ label: 'Charts', value: '60' },
];
<SpDescriptions title="The release" items={release} columns={3} /><script setup lang="ts">
import { SpDescriptions } from '@silverpoint/vue/ui/descriptions';
const release = [
{ label: 'Ground', value: 'silverpoint' },
{ label: 'Substrate', value: 'cream' },
{ label: 'Charts', value: '60' },
];
</script>
<template>
<SpDescriptions title="The release" :items="release" :columns="3" />
</template>import { Component } from '@angular/core';
import { SpDescriptions } from '@silverpoint/angular/ui/descriptions';
@Component({
selector: 'app-release',
imports: [SpDescriptions],
template: `<sp-descriptions title="The release" [items]="release" [columns]="3" />`,
})
export class Release {
protected readonly release = [
{ label: 'Ground', value: 'silverpoint' },
{ label: 'Substrate', value: 'cream' },
{ label: 'Charts', value: '60' },
];
}sp_descriptions(
[
{"label": "Ground", "value": "silverpoint"},
{"label": "Substrate", "value": "cream"},
{"label": "Charts", "value": "60"},
],
title="The release",
columns=3,
)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 { SpDescriptions } from '@silverpoint/react/ui/descriptions'; |
| Vue | import { SpDescriptions } from '@silverpoint/vue/ui/descriptions'; |
| Angular | import { SpDescriptions } from '@silverpoint/angular/ui/descriptions'; · sp-descriptions |
| Reflex | from reflex_silverpoint_react import sp_descriptions |
Props
| React / Angular | Vue | Type | Description |
|---|---|---|---|
items required | items | readonly DescriptionItem[] | The label–value pairs, a <dl>. Keys, when given, are unique. |
title | title | string | A heading above the list, at headingLevel. |
columns | columns | number | Default 3, in 1..6. |
bordered | bordered | boolean | Default true. |
headingLevel | heading-level | 2 | 3 | 4 | 5 | 6 | Default 3. |
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 SpDescriptions? Open an issue on GitHub — the form comes pre-filled with the component and the version.