Skip to content
+

Progress

The Progress component displays the status of a task or operation over time.

ProgressIndicator API

Import

import * as Progress from '@base_ui/react/Progress';
const ProgressIndicator = Progress.Indicator;

Props

Props of the native component are also available.

NameTypeDescription
classNamefunc
| string

Class names applied to the element or a function that returns them based on the component's state.

renderelement
| func

A function to customize rendering of the component.


The ref is forwarded to the root element.

Theme default props

You can use ProgressIndicator to change the default props of this component with the theme.

ProgressRoot API

Import

import * as Progress from '@base_ui/react/Progress';
const ProgressRoot = Progress.Root;

Props

Props of the native component are also available.

NameTypeDefaultDescription
aria-labelstring-

The label for the Indicator component.

aria-labelledbystring-

An id or space-separated list of ids of elements that label the Indicator component.

aria-valuetextstring-

A string value that provides a human-readable text alternative for the current value of the progress indicator.

classNamefunc
| string
-

Class names applied to the element or a function that returns them based on the component's state.

direction'ltr'
| 'rtl'
'ltr'

The direction that progress bars fill in

getAriaLabelfunc-

Accepts a function which returns a string value that provides an accessible name for the Indicator component

Signature:function(value: number | null) => string
  • value The component's value
getAriaValueTextfunc-

Accepts a function which returns a string value that provides a human-readable text alternative for the current value of the progress indicator.

Signature:function(value: number | null) => string
  • value The component's value to format
maxnumber100

The maximum value

minnumber0

The minimum value

renderelement
| func
-

A function to customize rendering of the component.

valuenumbernull

The current value. The component is indeterminate when value is null.


The ref is forwarded to the root element.

Theme default props

You can use ProgressRoot to change the default props of this component with the theme.

ProgressTrack API

Import

import * as Progress from '@base_ui/react/Progress';
const ProgressTrack = Progress.Track;

Props

Props of the native component are also available.

NameTypeDescription
classNamefunc
| string

Class names applied to the element or a function that returns them based on the component's state.

renderelement
| func

A function to customize rendering of the component.


The ref is forwarded to the root element.

Theme default props

You can use ProgressTrack to change the default props of this component with the theme.