UI components · Data entry

Rate

Native radios 1..count, each an exact lozenge. Group: Data entry · component 7 of 17, new in silverpoint 0.3.

States

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

`three`

tsx

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

<SpRate label="Quality" name="quality" count={5} defaultValue={3} />

vue

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

<template>
  <SpRate label="Quality" name="quality" :count="5" :default-value="3" />
</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 { SpRate } from '@silverpoint/angular/ui/rate';

@Component({
  selector: 'app-root',
  imports: [SpRate],
  template: `
    <sp-rate label="Quality" name="quality" [count]="5" [defaultValue]="3" />
  `,
})
export class App {}

python

from reflex_silverpoint_react import sp_rate

sp_rate(
    label="Quality",
    name="quality",
    count=5,
    default_value=3,
)

`read-only`

tsx

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

<SpRate label="Quality" name="quality" count={5} readOnly defaultValue={3} />

vue

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

<template>
  <SpRate label="Quality" name="quality" :count="5" read-only :default-value="3" />
</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 { SpRate } from '@silverpoint/angular/ui/rate';

@Component({
  selector: 'app-root',
  imports: [SpRate],
  template: `
    <sp-rate
      label="Quality"
      name="quality"
      [count]="5"
      [readOnly]="true"
      [defaultValue]="3"
    />
  `,
})
export class App {}

python

from reflex_silverpoint_react import sp_rate

sp_rate(
    label="Quality",
    name="quality",
    count=5,
    read_only=True,
    default_value=3,
)

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 { SpRate } from '@silverpoint/react/ui/rate';`
Vue	`import { SpRate } from '@silverpoint/vue/ui/rate';`
Angular	`import { SpRate } from '@silverpoint/angular/ui/rate'; // <sp-rate>`
Reflex	`from reflex_silverpoint_react import sp_rate`

Binding the value

Controlled or uncontrolled, the way each framework does it. The change event carries the new value itself (a string, a bool or a number), never a DOM event.

Framework	Controlled	Uncontrolled
React	`value / onChange`	`defaultValue`
Vue	`v-model="x"`	`default-value`
Angular	`[(value)]="x", ngModel, formControl`	`[defaultValue]`
Reflex	`value=State.x, on_change=State.set_x`	`default_value=…`

Props

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

React / Angular	Vue	Reflex	Type	Description
`label`	`label`	`label`	`str`	The group's name, its <legend>. Required.
`count`	`count`	`count`	`int`	Number of marks, 1..10 (5 by default).
`name`	`name`	`name`	`str`	Form field name; the native radios submit under it.
`disabled`	`disabled`	`disabled`	`bool`	Not focusable and not submitted.
`readOnly`	`read-only`	`read_only`	`bool`	Shows the value; the keyboard and the pointer do not change it.
`value`	`value`	`value`	`int`	Controlled value.
`defaultValue`	`default-value`	`default_value`	`int`	Initial value of an uncontrolled rate (0 by default).
`onChange`	`on-change`	`on_change`	`event`	The new value (a number).

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