UI components · Feedback

Progress

A progressbar, a line or a circle. Group: Feedback · component 15 of 17, new in silverpoint 0.3.

size="lg"

mode="precision"

substrate="green"

States

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

`line`

silverpoint · cream

cyanotype · prussian

tsx

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

<SpProgress label="Upload" value={40} />

vue

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

<template>
  <SpProgress label="Upload" :value="40" />
</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 { SpProgress } from '@silverpoint/angular/ui/progress';

@Component({
  selector: 'app-root',
  imports: [SpProgress],
  template: `
    <sp-progress label="Upload" [value]="40" />
  `,
})
export class App {}

python

from reflex_silverpoint_react import sp_progress

sp_progress(
    label="Upload",
    value=40,
)

`circle`

silverpoint · cream

cyanotype · prussian

tsx

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

<SpProgress label="Coverage" value={72} shape="circle" />

vue

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

<template>
  <SpProgress label="Coverage" :value="72" shape="circle" />
</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 { SpProgress } from '@silverpoint/angular/ui/progress';

@Component({
  selector: 'app-root',
  imports: [SpProgress],
  template: `
    <sp-progress label="Coverage" [value]="72" shape="circle" />
  `,
})
export class App {}

python

from reflex_silverpoint_react import sp_progress

sp_progress(
    label="Coverage",
    value=72,
    shape="circle",
)

`indeterminate`

silverpoint · cream

cyanotype · prussian

tsx

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

<SpProgress label="Loading" />

vue

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

<template>
  <SpProgress label="Loading" />
</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 { SpProgress } from '@silverpoint/angular/ui/progress';

@Component({
  selector: 'app-root',
  imports: [SpProgress],
  template: `
    <sp-progress label="Loading" />
  `,
})
export class App {}

python

from reflex_silverpoint_react import sp_progress

sp_progress(
    label="Loading",
)

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

Props

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

React / Angular	Vue	Reflex	Type	Description
`value`	`value`	`value`	`int \| float`	0..100; omitted, the progress is indeterminate.
`shape`	`shape`	`shape`	`Literal['line', 'circle']`	line (default) or circle.
`label`	`label`	`label`	`str`	Accessible name. Required.
`showValue`	`show-value`	`show_value`	`bool`	Prints the value (true by default).

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