UI components · Data entry

Checkbox

A native checkbox with an exact tick or dash. Group: Data entry · component 3 of 17, new in silverpoint 0.3.

size="lg"

mode="precision"

substrate="green"

States

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

`unchecked`

silverpoint · cream

cyanotype · prussian

tsx

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

<SpCheckbox label="Legend" name="legend" />

vue

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

<template>
  <SpCheckbox label="Legend" name="legend" :default-value="false" />
</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 { SpCheckbox } from '@silverpoint/angular/ui/checkbox';

@Component({
  selector: 'app-root',
  imports: [SpCheckbox],
  template: `
    <sp-checkbox label="Legend" name="legend" [defaultValue]="false" />
  `,
})
export class App {}

python

from reflex_silverpoint_react import sp_checkbox

sp_checkbox(
    label="Legend",
    name="legend",
    default_checked=False,
)

`checked`

silverpoint · cream

cyanotype · prussian

tsx

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

<SpCheckbox label="Baseline" name="baseline" defaultChecked />

vue

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

<template>
  <SpCheckbox label="Baseline" name="baseline" :default-value="true" />
</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 { SpCheckbox } from '@silverpoint/angular/ui/checkbox';

@Component({
  selector: 'app-root',
  imports: [SpCheckbox],
  template: `
    <sp-checkbox label="Baseline" name="baseline" [defaultValue]="true" />
  `,
})
export class App {}

python

from reflex_silverpoint_react import sp_checkbox

sp_checkbox(
    label="Baseline",
    name="baseline",
    default_checked=True,
)

`indeterminate`

silverpoint · cream

cyanotype · prussian

tsx

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

<SpCheckbox label="All series" name="all" indeterminate />

vue

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

<template>
  <SpCheckbox label="All series" name="all" indeterminate :default-value="false" />
</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 { SpCheckbox } from '@silverpoint/angular/ui/checkbox';

@Component({
  selector: 'app-root',
  imports: [SpCheckbox],
  template: `
    <sp-checkbox
      label="All series"
      name="all"
      [indeterminate]="true"
      [defaultValue]="false"
    />
  `,
})
export class App {}

python

from reflex_silverpoint_react import sp_checkbox

sp_checkbox(
    label="All series",
    name="all",
    indeterminate=True,
    default_checked=False,
)

`disabled`

silverpoint · cream

cyanotype · prussian

tsx

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

<SpCheckbox label="Baseline" name="baseline" disabled defaultChecked />

vue

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

<template>
  <SpCheckbox label="Baseline" name="baseline" disabled :default-value="true" />
</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 { SpCheckbox } from '@silverpoint/angular/ui/checkbox';

@Component({
  selector: 'app-root',
  imports: [SpCheckbox],
  template: `
    <sp-checkbox
      label="Baseline"
      name="baseline"
      [disabled]="true"
      [defaultValue]="true"
    />
  `,
})
export class App {}

python

from reflex_silverpoint_react import sp_checkbox

sp_checkbox(
    label="Baseline",
    name="baseline",
    disabled=True,
    default_checked=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 { SpCheckbox } from '@silverpoint/react/ui/checkbox';`
Vue	`import { SpCheckbox } from '@silverpoint/vue/ui/checkbox';`
Angular	`import { SpCheckbox } from '@silverpoint/angular/ui/checkbox'; // <sp-checkbox>`
Reflex	`from reflex_silverpoint_react import sp_checkbox`

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	`checked / onChange`	`defaultChecked`
Vue	`v-model="x"`	`default-value`
Angular	`[(value)]="x", ngModel, formControl`	`[defaultValue]`
Reflex	`checked=State.x, on_change=State.set_x`	`default_checked=…`

Props

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

React / Angular	Vue	Reflex	Type	Description
`label`	`label`	`label`	`str`	The visible text and accessible name. Required.
`name`	`name`	`name`	`str`	Form field name; submitted as on when checked.
`disabled`	`disabled`	`disabled`	`bool`	Not focusable and not submitted.
`indeterminate`	`indeterminate`	`indeterminate`	`bool`	Draws the exact dash and sets the native indeterminate state.
`checked`	`checked`	`checked`	`bool`	Controlled state.
`defaultChecked`	`default-checked`	`default_checked`	`bool`	Initial state of an uncontrolled checkbox.
`onChange`	`on-change`	`on_change`	`event`	The new state (a bool).

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