Progress - Linear

An element that shows either determinate or indeterminate progress.

Preview Component

Please note, the API of this component is currently in a preview phase and is subject to change.

0 percent

Anatomy

To set up the progress correctly, you’ll need to understand its anatomy and how we name its parts.

Each part includes a data-part attribute to help identify them in the DOM.

Examples

Learn how to use the Progress component in your project. Let’s take a look at the most basic example:

Setting the initial value

To set the progress’s initial value, set the defaultValue prop to a number.

Specifying the minimum and maximum

By default, the maximum is 100. If that’s not what you want, you can easily specify a different bound by changing the value of the max prop. You can do the same with the minimum value by setting the min prop.

For example, to show the user a progress from 10 to 30, you can use:

Using the indeterminate state

The progress component is determinate by default, with the value and max set to 50 and 100 respectively.

Set the state to indeterminate in Progress.Indicator:

Showing a value text

Progress bars can only be interpreted by sighted users. To include a text description to support assistive technologies like screen readers, use the value part in translations.

Changing the orientation

By default, the progress is assumed to be horizontal. To change the orientation to vertical, set the orientation property in the machine’s context to vertical.

Don’t forget to change the styles of the vertical progress by specifying its height

API Reference

Root

PropTypeDefault
asChild
boolean
defaultValue
number
dir
'ltr' | 'rtl'"ltr"
getRootNode
() => ShadowRoot | Node | Document
id
string
max
number
min
number
orientation
Orientation"horizontal"
translations
IntlTranslations
value
number

View

PropTypeDefault
state
ProgressState
asChild
boolean

Label

PropTypeDefault
asChild
boolean

Range

PropTypeDefault
asChild
boolean

Track

PropTypeDefault
asChild
boolean

Circle

PropTypeDefault
asChild
boolean

ValueText

PropTypeDefault
asChild
boolean

CircleRange

PropTypeDefault
asChild
boolean

CircleTrack

PropTypeDefault
asChild
boolean

Previous

Hover Card

Next

Menu