Skip to content
silverpoint
Documentation menu

UI components · Data display

Card

A framed card with header, body and footer. Group: Data display · component 11 of 17, new in silverpoint 0.3.
Hits per hour rose through the afternoon and eased at night.
size="lg"
Hits per hour rose through the afternoon and eased at night.
mode="precision"
Hits per hour rose through the afternoon and eased at night.
substrate="green"

States

The 2 reference states silverpoint declares for Card, live on both grounds, with their code. As in upstream's documentation the examples are uncontrolled: the state's value is the default value. Pick a framework once and every example on the site follows it.

plain

Hits per hour rose through the afternoon and eased at night.
silverpoint · cream
Hits per hour rose through the afternoon and eased at night.
cyanotype · prussian
tsx
import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import '@silverpoint/grounds/ui.css';
import { SpCard } from '@silverpoint/react/ui/card';

<SpCard>Hits per hour rose through the afternoon and eased at night.</SpCard>

titled

Revenue

Q3
128 thousands, up 6.4 on the quarter.
silverpoint · cream

Revenue

Q3
128 thousands, up 6.4 on the quarter.
cyanotype · prussian
tsx
import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import '@silverpoint/grounds/ui.css';
import { SpCard } from '@silverpoint/react/ui/card';

<SpCard title="Revenue" extra="Q3">128 thousands, up 6.4 on the quarter.</SpCard>

Import

Each component has its own subpath under ui/, and every adapter exports them all from ui. Import @silverpoint/grounds/ui.css once, beside styles.css; Reflex adds it for you.

FrameworkImport
Reactimport { SpCard } from '@silverpoint/react/ui/card';
Vueimport { SpCard } from '@silverpoint/vue/ui/card';
Angularimport { SpCard } from '@silverpoint/angular/ui/card'; // <sp-card>
Reflexfrom reflex_silverpoint_react import sp_card

Props

The props Card adds to the ones every UI component takes.

React / AngularVueReflexTypeDescription
titletitletitlestrHeading of the card.
headingLevelheading-levelheading_levelLiteral[2, 3, 4, 5, 6]Level of the heading, 2 to 6 (3 by default).
extraextraextraComponent | strContent at the end of the header, e.g. a period or a tag.
footerfooterfooterComponent | strContent of the footer.

Common props

Every UI component also takes these. Like a chart's, they fall back to the dashboard the component sits in, then to the provider. Read more about the UI components.

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.
Report it
Found something wrong with SpCard? Open an issue on GitHub — the form comes pre-filled with the component and the version.