Skip to main content

Examples

Default

With Completion

All Variants

With Steps

ProgressBarSteps — Brand

ProgressBarSteps — Brand Small

ProgressBarSteps — Mono

Props

ProgressBar

A horizontal progress indicator with optional title, completion percentage, step count, and helper text. The bar colour reflects progress when using the "default" variant.
number
required
Current progress value, clamped to 0–100.
string
default:"Progress"
Accessible label for the progressbar role.
string
Human-readable text alternative for the current value (e.g. “Step 3 of 5”).
ReactNode
Helper content at the bottom-left of the bar.
ReactNode
Helper content at the bottom-right of the bar.
ReactNode
Icon shown at the bottom-left before the helper text.
boolean
default:"false"
Whether to display the completion percentage above the track.
"small" | "default" | "medium"
default:"default"
Track height — "default" (12px), "medium" (8px) or "small" (6px).
ReactNode
Steps label shown at the top-right (e.g. "2/8 steps").
ReactNode
Title content shown at the top-left of the bar.
"neutral" | "default" | "brand" | "mono" | "sky" | "generic"
default:"default"
Colour mode. Prefer "brand" or "mono" (V2); "default"/"generic"/"neutral" are legacy.

ProgressBarItem

A single rounded segment used to compose a stepped progress indicator. Render a row of these (see ProgressBarSteps) to represent discrete steps.
boolean
default:"false"
Whether this item is filled (completed).
"small" | "default"
default:"default"
Pill thickness — "default" (8px) or "small" (4px).
"brand" | "mono"
default:"brand"
Colour mode.

ProgressBarSteps

A segmented (stepped) progress indicator built from ProgressBarItem pills. Fills the first value of steps segments.
number
required
Total number of steps (segments). Values below 1 are treated as 1.
number
required
Number of completed steps, clamped to 0steps.
string
default:"Progress"
Accessible label for the progressbar role.
string
Human-readable text alternative for the current value (e.g. “Step 2 of 4”).
"small" | "default"
default:"default"
Pill thickness — "default" (8px) or "small" (4px).
"brand" | "mono"
default:"brand"
Colour mode.

Exported types

Also exported from @fanvue/ui: ProgressBarItemProps, ProgressBarItemSize, ProgressBarItemVariant, ProgressBarProps, ProgressBarSize, ProgressBarStepsProps, ProgressBarVariant.
Setup: Installation · Theming