Progress

Feedback & Status
stable

Progress indicator family: linear bar (determinate, indeterminate, buffered, stream, striped, clickable) and circular spinner (determinate, indeterminate, rotate). Dispatched via the type prop.

Preview

Rendering the live preview…

linear default

Rendering the live preview…

linear indeterminate

Rendering the live preview…

linear striped

Rendering the live preview…

circular

Rendering the live preview…

circular indeterminate

Structure

Anatomy

Visual breakdown of the component's internal structure with BEM class call-outs.

Anatomy of OrigamProgressSchematic of the ProgressLinear and ProgressCircular components with numbered parts. ProgressLinear #default slot buffer track ProgressCircular 75% indeterminate 1 2 3 4 5
Anatomy of <origam-progress> — Linear: fill bar (①) + buffer track (②). Circular: SVG underlay ring (③) + overlay arc (④) + content slot (⑤).
1.origam-progress__bar
Linear: foreground fill bar. Width = normalized value %. In indeterminate mode, two bars (--long and --short) animate in loop.
2.origam-progress__stream / background track
Linear: background track (opacity 50% of fill color) and optional stream dots. Buffer renders a secondary transparent track at bufferValue.
3SVG underlay circle
Circular: background ring (stroke = {color.surface.disabled}, opacity 50%). Always visible.
4SVG overlay circle
Circular: foreground arc. stroke-dashoffset driven by normalized value. Animated by CSS in indeterminate mode.
5.origam-progress__content
Shared content zone. Circular: absolutely centered inside the ring. Linear: overlaid on the bar. Visible only when #default slot has content.

API

Props

All props accepted by this component, with their type, default value and description.

type
TProgressType
'linear'
Determines which sub-component to render: "linear" → OrigamProgressLinear, "circular" → OrigamProgressCircular.
bufferValue
number | string
Linear only. Buffer value (e.g. media buffered percentage). Renders a secondary track from 0 to bufferValue.
clickable
boolean
false
Linear only. Makes the bar interactive — click sets modelValue to the clicked position. Used internally by OrigamMediaController.
reverse
boolean
false
Linear only. Reverses the bar direction (fills right to left).
stream
boolean
false
Linear only. Adds a streaming dots animation ahead of the progress bar (live media pattern).
indeterminate
boolean
false
Animates continuously without a determinate value. Sets aria-valuenow to undefined.
modelValue
string | number
0
Current progress value (0 to max). Used in determinate mode. Ignored when indeterminate=true.
thickness
string | number
Thickness of the linear bar (height) or circular stroke width.
active
boolean
true
Controls visibility. When false, the progress bar is hidden (aria-hidden="true").
absolute
boolean
false
Positions the progress bar absolutely relative to its nearest positioned ancestor.
max
number | string
100
Maximum value. Normalized value = modelValue / max * 100.
striped
boolean
false
Adds animated diagonal stripes to the progress bar (linear only).
label
string
'Loading'
Accessible label (aria-label) on the progress bar. Pass a translated string.
tag
string
'div'
Root HTML tag.
id
string
class
string | Array<string> | object
style
string | Array<string> | object | StyleValue
color
Intent or custom color applied to the progress fill and spinner stroke.
bgColor
TColor
padding
boolean | number | string
paddingTop
boolean | number | string
paddingLeft
boolean | number | string
paddingBottom
boolean | number | string
paddingRight
boolean | number | string
paddingBlock
boolean | number | string
paddingInline
boolean | number | string
paddingInlineStart
boolean | number | string
paddingInlineEnd
boolean | number | string
paddingBlockStart
boolean | number | string
paddingBlockEnd
boolean | number | string
margin
boolean | number | string
marginTop
boolean | number | string
marginLeft
boolean | number | string
marginBottom
boolean | number | string
marginRight
boolean | number | string
marginBlock
boolean | number | string
marginInline
boolean | number | string
marginInlineStart
boolean | number | string
marginInlineEnd
boolean | number | string
marginBlockStart
boolean | number | string
marginBlockEnd
boolean | number | string
Linear only. Border-radius of the bar ends. true → {radius.full}.
roundedTopRight
boolean | number | string
roundedTopLeft
boolean | number | string
roundedBottomLeft
boolean | number | string
roundedBottomRight
boolean | number | string
roundedStartStart
boolean | number | string
roundedStartEnd
boolean | number | string
roundedEndStart
boolean | number | string
roundedEndEnd
boolean | number | string
location
TAnchor
'top'
Linear only. Absolute position on the screen when absolute=true: top | bottom.
rotate
string | number
0
Circular only. Rotation offset of the SVG circle start point in degrees.
size
'default'
Circular only. Overall size of the spinner. Accepts size tokens (xs → xl) or a px number.

API

Slots

Content slots exposed by this component.

#default
Content rendered inside the progress indicator. Circular: inside the ring. Linear: overlaid on the bar. Receives normalized value (0-100) and optional buffer.

API

Emits

Events emitted by this component.

@update:modelValue
number
Linear only, clickable=true. Fired when the user clicks the bar — payload is the new value (0 to max).

Customisation

CSS variables

CSS custom properties exposed by this component. Override them to customise the component without losing theme compatibility.

Transition duration for the fill bar width change.
Duration of the indeterminate bar animation cycle.
Border-radius applied when rounded=true.
Circular size for size="x-small".
Circular size for size="x-large".
Duration of the indeterminate circular spin animation.
Color of the background ring (underlay circle).

Inclusion

Accessibility

ARIA roles, keyboard navigation and focus management. Sourced from the real component template.

ARIA roles

progressbar

Notes

  • Both ProgressLinear and ProgressCircular have role="progressbar". They bind aria-valuemin="0", aria-valuemax, and aria-valuenow (undefined in indeterminate mode). aria-label comes from the label prop (defaults to "Loading").
  • When active=false, the component sets aria-hidden="true" to remove it from the accessibility tree without removing it from the DOM.
  • Indeterminate animations are paused under prefers-reduced-motion: reduce.

Foundation

Design tokens

Excerpt from this component's token declarations — the --origam-<component>---<property> variables, declared in its hand-maintained token sheet with no build step.

Source
duration
var(--origam-motion__duration---medium)
Linear fill bar transition duration.
duration
2200ms
Indeterminate animation duration for the linear bar.
dimension
32px
Default (medium) circular spinner size.
duration
1400ms
Spin animation duration for the indeterminate circular variant.
number
var(--origam-opacity---50)
Opacity of the background ring.

Interactive

Playground

Edit props live and see the component update in real time. The generated code snippet updates as you change values.

Rendering the live preview…

Usage

Examples

Ready-to-paste code snippets for your templates.

Linear determinate

vue

Indeterminate

vue

Circular with value slot

vue

Ecosystem

Family

Components from the same folder that share conventions and often compose together.