- components
- ›
- progress linear
- ›
- svelte
Progress Linear
An indicator showing the progress or completion of a task.
75%
Color
Provide background color values for the track and range to customize the colors.
Height
Orientation
For vertical orieintation, a height must be defined on the Track component. The default is h-[100px]
.
Indeterminate
You must explicitely specify a null
value to trigger indeterminate mode.
Custom Animation
Consider using following variants to target the orientation and state.
data-[orientation=horizontal]:my-custom-animation
- target the horizontal orientation.data-[orientation=vertical]:my-custom-animation
- target the vertical orientation.data-[state=indeterminate]:my-custom-animation
- target the indeterminate state.
Native Alternative
The native progress
element is available cross browser, but does not support indeterminate animations.
Direction
Label
API Reference
RootProvider
Property | Default | Type |
---|---|---|
value | - | () => ProgressApi<PropTypes> |
element | - | Snippet<[HTMLAttributes<"div">]> | undefinedRender the element yourself |
Root
flex flex-col gap-2 data-[orientation=horizontal]:w-full data-[orientation=vertical]:items-center
Property | Default | Type |
---|---|---|
ids | - | Partial<{ root: string; track: string; label: string; circle: string; }> | undefinedThe ids of the elements in the progress bar. Useful for composition. |
value | - | number | null | undefinedThe controlled value of the progress bar. |
defaultValue | 50 | number | null | undefinedThe initial value of the progress bar when rendered. Use when you don't need to control the value of the progress bar. |
min | 0 | number | undefinedThe minimum allowed value of the progress bar. |
max | 100 | number | undefinedThe maximum allowed value of the progress bar. |
translations | - | IntlTranslations | undefinedThe localized messages to use. |
onValueChange | - | ((details: ValueChangeDetails) => void) | undefinedCallback fired when the value changes. |
formatOptions | { style: "percent" } | NumberFormatOptions | undefinedThe options to use for formatting the value. |
locale | "en-US" | string | undefinedThe locale to use for formatting the value. |
dir | "ltr" | "ltr" | "rtl" | undefinedThe document's text/writing direction. |
getRootNode | - | (() => ShadowRoot | Node | Document) | undefinedA root node to correctly resolve document in custom environments. E.x.: Iframes, Electron. |
orientation | "horizontal" | "horizontal" | "vertical" | undefinedThe orientation of the element. |
element | - | Snippet<[HTMLAttributes<"div">]> | undefinedRender the element yourself |
RootContext
Property | Default | Type |
---|---|---|
children | - | Snippet<[() => ProgressApi<PropTypes>]> |
Label
whitespace-nowrap
Property | Default | Type |
---|---|---|
element | - | Snippet<[HTMLAttributes<"div">]> | undefinedRender the element yourself |
ValueText
Property | Default | Type |
---|---|---|
element | - | Snippet<[HTMLAttributes<"span">]> | undefinedRender the element yourself |
Track
bg-surface-200-800 rounded-base overflow-hidden data-[orientation=horizontal]:w-full data-[orientation=horizontal]:h-2 data-[orientation=vertical]:w-2 data-[orientation=vertical]:h-[100px]
Property | Default | Type |
---|---|---|
element | - | Snippet<[HTMLAttributes<"div">]> | undefinedRender the element yourself |
Range
h-full bg-surface-950-50 rounded-base data-[orientation=horizontal]:transition-[width] data-[orientation=horizontal]:data-[state=indeterminate]:animate-progress-linear-indeterminate-horizontal data-[orientation=vertical]:transition-[height] data-[orientation=vertical]:data-[state=indeterminate]:animate-progress-linear-indeterminate-vertical
Property | Default | Type |
---|---|---|
element | - | Snippet<[HTMLAttributes<"div">]> | undefinedRender the element yourself |
Circle
Property | Default | Type |
---|---|---|
element | - | Snippet<[HTMLAttributes<"svg">]> | undefinedRender the element yourself |
CircleTrack
stroke-surface-200-800
Property | Default | Type |
---|---|---|
element | - | Snippet<[HTMLAttributes<"circle">]> | undefinedRender the element yourself |
CircleRange
stroke-primary-500 transition-[stroke-dashoffset] ease-in-out data-[state=indeterminate]:animate-progress-circular-indeterminate
Property | Default | Type |
---|---|---|
element | - | Snippet<[HTMLAttributes<"circle">]> | undefinedRender the element yourself |