UI components · Data display

Tag

A framed, toned label; closable. Group: Data display · component 12 of 17, new in silverpoint 0.3.

size="lg"

mode="precision"

substrate="green"

States

The 2 reference states silverpoint declares for Tag, 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.

`tone-1`

silverpoint · cream

cyanotype · prussian

tsx

import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import '@silverpoint/grounds/ui.css';
import { SpTag } from '@silverpoint/react/ui/tag';

<SpTag tone={1}>draft</SpTag>

vue

<script setup lang="ts">
import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import '@silverpoint/grounds/ui.css';
import { SpTag } from '@silverpoint/vue/ui/tag';
</script>

<template>
  <SpTag :tone="1">
    draft
  </SpTag>
</template>

// src/styles.css:
//   @import '@silverpoint/fonts/fonts.css';
//   @import '@silverpoint/grounds/styles.css';
//   @import '@silverpoint/grounds/ui.css';

import { Component } from '@angular/core';
import { SpTag } from '@silverpoint/angular/ui/tag';

@Component({
  selector: 'app-root',
  imports: [SpTag],
  template: `
    <sp-tag [tone]="1">
      draft
    </sp-tag>
  `,
})
export class App {}

python

from reflex_silverpoint_react import sp_tag

sp_tag(
    "draft",
    tone=1,
)

`closable`

silverpoint · cream

cyanotype · prussian

tsx

import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import '@silverpoint/grounds/ui.css';
import { SpTag } from '@silverpoint/react/ui/tag';

<SpTag tone={3} closable>review</SpTag>

vue

<script setup lang="ts">
import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import '@silverpoint/grounds/ui.css';
import { SpTag } from '@silverpoint/vue/ui/tag';
</script>

<template>
  <SpTag :tone="3" closable>
    review
  </SpTag>
</template>

// src/styles.css:
//   @import '@silverpoint/fonts/fonts.css';
//   @import '@silverpoint/grounds/styles.css';
//   @import '@silverpoint/grounds/ui.css';

import { Component } from '@angular/core';
import { SpTag } from '@silverpoint/angular/ui/tag';

@Component({
  selector: 'app-root',
  imports: [SpTag],
  template: `
    <sp-tag [tone]="3" [closable]="true">
      review
    </sp-tag>
  `,
})
export class App {}

python

from reflex_silverpoint_react import sp_tag

sp_tag(
    "review",
    tone=3,
    closable=True,
)

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.

Framework	Import
React	`import { SpTag } from '@silverpoint/react/ui/tag';`
Vue	`import { SpTag } from '@silverpoint/vue/ui/tag';`
Angular	`import { SpTag } from '@silverpoint/angular/ui/tag'; // <sp-tag>`
Reflex	`from reflex_silverpoint_react import sp_tag`

Props

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

React / Angular	Vue	Reflex	Type	Description
`tone`	`tone`	`tone`	`Literal[1, 2, 3, 4]`	Tonal level 1 to 4 (1 by default).
`closable`	`closable`	`closable`	`bool`	Adds a native close button, which fires on_close.
`closeLabel`	`close-label`	`close_label`	`str`	Accessible name of the close button (Remove <text> by default).
`onClose`	`on-close`	`on_close`	`event`	The close button was clicked.

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 / 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.

Report it

Found something wrong with SpTag? Open an issue on GitHub — the form comes pre-filled with the component and the version.