Progress

Displays the status of a task that takes a long time.

Export data

import * as React from 'react';
import { Progress } from '@base-ui-components/react/progress';
import styles from './index.module.css';

export default function ExampleProgress() {
  const [value, setValue] = React.useState(20);

  // Simulate changes
  React.useEffect(() => {
    const interval = setInterval(() => {
      setValue((current) => Math.min(100, Math.round(current + Math.random() * 25)));
    }, 1000);
    return () => clearInterval(interval);
  }, []);

  return (
    <Progress.Root className={styles.Progress} value={value}>
      <Progress.Label className={styles.Label}>Export data</Progress.Label>
      <Progress.Value className={styles.Value} />
      <Progress.Track className={styles.Track}>
        <Progress.Indicator className={styles.Indicator} />
      </Progress.Track>
    </Progress.Root>
  );
}

Anatomy

Import the component and assemble its parts:

Anatomy

import { Progress } from '@base-ui-components/react/progress';

<Progress.Root>
  <Progress.Label />
  <Progress.Track>
    <Progress.Indicator />
  </Progress.Track>
  <Progress.Value />
</Progress.Root>

API reference

Root

Groups all parts of the progress bar and provides the task completion status to screen readers. Renders a <div> element.

value^*number | null(default: —)

Name: value
Description: The current value. The component is indeterminate when value is null.
Type: number | null
Default: —

aria-valuetextstring

Name: aria-valuetext
Description: A string value that provides a user-friendly name for aria-valuenow, the current value of the meter.
Type: string | undefined

getAriaValueTextfunction

Name: getAriaValueText
Description: Accepts a function which returns a string value that provides a human-readable text alternative for the current value of the progress bar.
Type: | (( formattedValue: string | null, value: number | null, ) => string) | undefined

localeIntl.LocalesArgument

Name: locale
Description: The locale used by Intl.NumberFormat when formatting the value. Defaults to the user's runtime locale.
Type: Intl.LocalesArgument

minnumber(default: 0)

Name: min
Description: The minimum value.
Type: number | undefined
Default: 0

maxnumber(default: 100)

Name: max
Description: The maximum value.
Type: number | undefined
Default: 100

formatIntl.NumberFormatOptions

Name: format
Description: Options to format the value.
Type: Intl.NumberFormatOptions | undefined

classNamestring | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Progress.Root.State) => string)

renderReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Progress.Root.State, ) => ReactElement)

data-complete

Present when the progress has completed.

data-indeterminate

Present when the progress is in interminate state.

data-progressing

Present while the progress is progressing.

Attribute	Description
`data-complete`	Present when the progress has completed.
`data-indeterminate`	Present when the progress is in interminate state.
`data-progressing`	Present while the progress is progressing.

Track

Contains the progress bar indicator. Renders a <div> element.

classNamestring | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Progress.Root.State) => string)

renderReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Progress.Root.State, ) => ReactElement)

data-complete

Present when the progress has completed.

data-indeterminate

Present when the progress is in interminate state.

data-progressing

Present while the progress is progressing.

Attribute	Description
`data-complete`	Present when the progress has completed.
`data-indeterminate`	Present when the progress is in interminate state.
`data-progressing`	Present while the progress is progressing.

Indicator

Visualizes the completion status of the task. Renders a <div> element.

classNamestring | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Progress.Root.State) => string)

renderReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Progress.Root.State, ) => ReactElement)

data-complete

Present when the progress has completed.

data-indeterminate

Present when the progress is in interminate state.

data-progressing

Present while the progress is progressing.

Attribute	Description
`data-complete`	Present when the progress has completed.
`data-indeterminate`	Present when the progress is in interminate state.
`data-progressing`	Present while the progress is progressing.

Value

A text label displaying the current value. Renders a <span> element.

children

| ((formattedValue: string | null, value: number | null) => ReactNode) 
|  null

Name: children
Type: | (( formattedValue: string | null, value: number | null, ) => ReactNode) | null | undefined

classNamestring | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Progress.Root.State) => string)

renderReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Progress.Root.State, ) => ReactElement)

data-complete

Present when the progress has completed.

data-indeterminate

Present when the progress is in interminate state.

data-progressing

Present while the progress is progressing.

Attribute	Description
`data-complete`	Present when the progress has completed.
`data-indeterminate`	Present when the progress is in interminate state.
`data-progressing`	Present while the progress is progressing.

Label

An accessible label for the progress bar. Renders a <span> element.

classNamestring | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Progress.Root.State) => string)

renderReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Progress.Root.State, ) => ReactElement)

data-complete

Present when the progress has completed.

data-indeterminate

Present when the progress is in interminate state.

data-progressing

Present while the progress is progressing.