structyl

Circular Progress API

View component

The full prop reference for the Circular Progress component. A circular progress indicator with determinate and indeterminate modes.

Import

tsx
import { CircularProgress } from '@structyl/styled';

Props

CircularProgress

A circular SVG progress indicator that displays progress as a circular arc, supporting both determinate and indeterminate (spinning) states.

PropTypeDefault
value#number | null | undefined

Current progress value (0 to max). Omit or pass null/undefined for indeterminate spinning state.

undefined
max#number

Maximum progress value; progress is calculated as value/max.

100
size#number

Width and height of the SVG element in pixels.

40
strokeWidth#number

Width of the progress stroke in pixels.

4
label#string

Aria-label text to announce the progress to screen readers.

'Loading'
color#'primary' | 'secondary' | 'error' | 'warning' | 'info' | 'success' | 'inherit'

Color variant; maps to Tailwind text color classes (e.g. text-primary, text-destructive).

'primary'
className#string | undefined

Additional CSS classes merged with internal classes.

...SVGAttributes#React.SVGAttributes<SVGSVGElement>

All standard SVG element attributes (e.g. aria-*, data-*, style, id, etc.) are supported via spread.

Source code

If you didn't find what you need here, read the component implementation .

structyl — Accessible React Component Library