ui · Primitive

ProgressRing

@devalok/shilp-sutra/ui/progress-ringView in Storybook

Preview

Variants

size

color

custom max

MultiProgressRing

Reference

Import: @devalok/shilp-sutra/ui/progress-ring
Server-safe: No
Category: ui

Props

ProgressRing

value: number (current progress value)
max: number (maximum value)
size: "sm" | "md" | "lg"
color: "default" | "success" | "warning" | "error" | "info"
showValue: boolean (show percentage text in center)
label: string (accessible label — falls back to "{n}% progress")

MultiProgressRing

rings: Array<{ value: number; max?: number; color?: "default" | "success" | "warning" | "error" | "info"; label?: string }>
size: "sm" | "md" | "lg"

Defaults

max={100}, size="md", color="default", showValue={false}

Example

<ProgressRing value={75} />
<ProgressRing value={3} max={12} size="lg" color="warning" showValue />

<MultiProgressRing
  rings={[
    { value: 80, color: 'error', label: 'Move' },
    { value: 60, color: 'success', label: 'Exercise' },
  ]}
  size="lg"
/>

Composability

SVG-based circular progress — pure SVG, no chart library dependency.
MultiProgressRing — concentric rings for multi-metric visualization (Apple Activity style: Move + Exercise + Stand). Don't stack more than 4-5 rings at a size; the innermost rings become too thin. Size auto-allocates ring stroke; pass size="lg" for more room.
ProgressRing vs Progress: Use ProgressRing for dashboard tiles, at-a-glance status, multi-metric visualizations. Use Progress for linear "percentage filled" UIs.
showValue={true} renders the percentage in the center (ProgressRing only). For MultiProgressRing, use external labels since center would conflict with multiple values.
Label for a11y: label falls back to "{n}% progress" so screen readers always get meaningful context.

Gotchas

Uses Framer Motion for the animated fill — not server-safe
Value is clamped to [0, max] internally
MultiProgressRing skips rings whose computed radius would be <= 0 (too many rings for the size)