{/* Copyright 2020 Adobe. All rights reserved. This file is licensed to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */}

import {Layout} from '@react-spectrum/docs'; export default Layout;

import docs from 'docs:react-aria-components'; import {PropTable, HeaderInfo, TypeLink, PageDescription, StateTable, ContextTable} from '@react-spectrum/docs'; import styles from '@react-spectrum/docs/src/docs.css'; import packageData from 'react-aria-components/package.json'; import Anatomy from '/packages/react-aria/docs/progress/anatomy.svg'; import ChevronRight from '@spectrum-icons/workflow/ChevronRight'; import {Divider} from '@react-spectrum/divider'; import {ExampleCard} from '@react-spectrum/docs/src/ExampleCard'; import {ExampleList} from '@react-spectrum/docs/src/ExampleList'; import Label from '@react-spectrum/docs/pages/assets/component-illustrations/Label.svg'; import {StarterKits} from '@react-spectrum/docs/src/StarterKits';

category: Status keywords: [progressbar, aria] type: component

ProgressBar

<PageDescription>{docs.exports.ProgressBar.description}</PageDescription>

Example

tsx

import {ProgressBar, Label} from 'react-aria-components';

<ProgressBar value={80}>
  {({percentage, valueText}) => <>
    <Label>Loading…</Label>
    <span className="value">{valueText}</span>
    <div className="bar">
      <div className="fill" style={{width: percentage + '%'}} />
    </div>
  </>}
</ProgressBar>

css

@import "@react-aria/example-theme";

.react-aria-ProgressBar {
  display: grid;
  grid-template-areas: "label value"
                       "bar bar";
  grid-template-columns: 1fr auto;
  gap: 4px;
  width: 250px;
  color: var(--text-color);

  .value {
    grid-area: value;
  }

  .bar {
    grid-area: bar;
    box-shadow: inset 0px 0px 0px 1px var(--border-color);
    forced-color-adjust: none;
    height: 10px;
    border-radius: 5px;
    overflow: hidden;
    will-change: transform;
  }

  .fill {
    background: var(--highlight-background);
    height: 100%;
  }
}

</details>

Features

The <progress> HTML element can be used to build a progress bar, however it is very difficult to style cross browser. ProgressBar helps achieve accessible progress bars and spinners that can be styled as needed.

Accessible – Follows the ARIA progressbar pattern, supporting both determinate and indeterminate progress bars. A nested label is automatically associated with the progress bar semantically.
International – The value is formatted as a percentage or custom format according to the user's locale.

Anatomy

Progress bars consist of a track element showing the full progress of an operation, a fill element showing the current progress, a label, and an optional value label. The track and bar elements represent the progress visually, while a wrapper element represents the progress to assistive technology using the progressbar ARIA role.

tsx

import {ProgressBar, Label} from 'react-aria-components';

<ProgressBar>
  <Label />
</ProgressBar>

If there is no visual label, an aria-label or aria-labelledby prop must be passed instead to identify the element to screen readers.

Composed components

A ProgressBar uses the following components, which may also be used standalone or reused in other components.

</section>

Examples

Starter kits

To help kick-start your project, we offer starter kits that include example implementations of all React Aria components with various styling solutions. All components are fully styled, including support for dark mode, high contrast mode, and all UI states. Each starter comes with a pre-configured Storybook that you can experiment with, or use as a starting point for your own component library.

Reusable wrappers

If you will use a ProgressBar in multiple places in your app, you can wrap all of the pieces into a reusable component. This way, the DOM structure, styling code, and other logic are defined in a single place and reused everywhere to ensure consistency.

This example wraps ProgressBar and all of its children together into a single component which accepts a label prop that is passed to the right place.

tsx

import type {ProgressBarProps} from 'react-aria-components';

interface MyProgressBarProps extends ProgressBarProps {
  label?: string
}

function MyProgressBar({label, ...props}: MyProgressBarProps) {
  return (
    <ProgressBar {...props}>
      {({percentage, valueText}) => <>
        <Label>{label}</Label>
        <span className="value">{valueText}</span>
        <div className="bar">
          <div className="fill" style={{width: percentage + '%'}} />
        </div>
      </>}
    </ProgressBar>
  );
}

<MyProgressBar label="Loading…" value={80} />

Value

ProgressBars are controlled with the value prop. By default, the value prop represents the current percentage of progress, as the minimum and maximum values default to 0 and 100, respectively.

tsx

<MyProgressBar label="Loading…" value={25} />

Custom value scale

A custom value scale can be used by setting the minValue and maxValue props.

tsx

<MyProgressBar
  label="Loading…"
  minValue={50}
  maxValue={150}
  value={100} />

Indeterminate

The isIndeterminate prop can be used to represent an indeterminate operation.

tsx

<MyProgressBar
  aria-label="Loading…"
  isIndeterminate />

css

.react-aria-ProgressBar {
  &:not([aria-valuenow]) {
    .fill {
      width: 120px;
      border-radius: inherit;
      animation: indeterminate 1.5s infinite ease-in-out;
      will-change: transform;
    }
  }
}

@keyframes indeterminate {
  from {
    transform: translateX(-100%);
  }

  to {
    transform: translateX(250px);
  }
}

</details>

Labeling

Value formatting

Values are formatted as a percentage by default, but this can be modified by using the formatOptions prop to specify a different format. formatOptions is compatible with the option parameter of Intl.NumberFormat and is applied based on the current locale.

tsx

<MyProgressBar
  label="Sending…"
  formatOptions={{style: 'currency', currency: 'JPY'}}
  value={60} />

Custom value label

The valueLabel prop allows the formatted value to be replaced with a custom string.

tsx

<MyProgressBar
  label="Feeding…"
  valueLabel="30 of 100 dogs"
  value={30} />

Circular

Progress bars may also be represented using a circular visualization rather than a line. This is often used to represent indeterminate operations, but may also be used for determinate progress indicators when space is limited. The following example shows a progress bar visualized as a circular spinner using SVG.

tsx

let center = 16;
let strokeWidth = 4;
let r = 16 - strokeWidth;
let c = 2 * r * Math.PI;

<ProgressBar aria-label="Loading…" value={60}>
  {({percentage}) => <>
    <svg width={64} height={64} viewBox="0 0 32 32" fill="none" strokeWidth={strokeWidth}>
      <circle cx={center} cy={center} r={r - (strokeWidth / 2 - 0.25)} stroke="var(--border-color)" strokeWidth={0.5} />
      <circle cx={center} cy={center} r={r + (strokeWidth / 2 - 0.25)} stroke="var(--border-color)" strokeWidth={0.5} />
      <circle
        cx={center}
        cy={center}
        r={r}
        stroke="var(--highlight-background)"
        strokeDasharray={`${c} ${c}`}
        strokeDashoffset={c - percentage / 100 * c}
        strokeLinecap="round"
        transform="rotate(-90 16 16)" />
    </svg>
  </>}
</ProgressBar>

Props

Styling

React Aria components can be styled in many ways, including using CSS classes, inline styles, utility classes (e.g. Tailwind), CSS-in-JS (e.g. Styled Components), etc. By default, all components include a builtin className attribute which can be targeted using CSS selectors. These follow the react-aria-ComponentName naming convention.

css

.react-aria-ProgressBar {
  /* ... */
}

A custom className can also be specified on any component. This overrides the default className provided by React Aria with your own.

jsx

<ProgressBar className="my-progressbar">
</ProgressBar>

The className and style props also accept functions which receive states for styling. This lets you dynamically determine the classes or styles to apply, which is useful when using utility CSS libraries like Tailwind.

jsx

<ProgressBar className={({percentage}) => percentage > 50 ? 'bg-green-400' : 'bg-yellow-100'}>
  Item
</ProgressBar>

The selectors and render props for each component used in a ProgressBar are documented below.

ProgressBar

A ProgressBar can be targeted with the .react-aria-ProgressBar CSS selector, or by overriding with a custom className. It supports the following states and render props:

Label

A Label can be targeted with the .react-aria-Label CSS selector, or by overriding with a custom className.

Advanced customization

Contexts

All React Aria Components export a corresponding context that can be used to send props to them from a parent element. This enables you to build your own compositional APIs similar to those found in React Aria Components itself. You can send any prop or ref via context that you could pass to the corresponding component. The local props and ref on the component are merged with the ones passed via context, with the local props taking precedence (following the rules documented in mergeProps).

This example sets the formatOptions via context, which applies to all nested progress bars.

tsx

import {ProgressBarContext} from 'react-aria-components';

<ProgressBarContext.Provider value={{formatOptions: {style: 'decimal'}}}>
  <MyProgressBar label="Converting…" value={28.5} />
  <MyProgressBar label="Uploading…" value={68.75} />
</ProgressBarContext.Provider>

Hooks

If you need to customize things further, such as customizing the DOM structure, you can drop down to the lower level Hook-based API. See useProgressBar for more details.