ProgressBar

ProgressBars show the progression of a system operation: downloading, uploading, processing, etc., in a visual way. They can represent either determinate or indeterminate progress.

install	`yarn add @react-spectrum/progress`
version	3.1.8
usage	`import {ProgressBar} from '@react-spectrum/progress'`

View guidelines

Spectrum

Example#

<ProgressBar label="Loading…" value={50} />

<ProgressBar label="Loading…" value={50} />

<ProgressBar
  label="Loading…"
  value={50}
/>

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.

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

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

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

Alternatively, a different scale can be used by setting the minValue and maxValue props.

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

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

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

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.

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

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

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

Indeterminate#

View guidelines

By default, ProgressBars are determinate. Use a determinate ProgressBar when progress can be calculated against a specific goal.

<ProgressBar label="Loading…" value={50} />

<ProgressBar label="Loading…" value={50} />

<ProgressBar
  label="Loading…"
  value={50}
/>

Use an indeterminate ProgressBar when the wait time or effort to completion can not be determined.

<ProgressBar label="Loading…" isIndeterminate />

<ProgressBar label="Loading…" isIndeterminate />

<ProgressBar
  label="Loading…"
  isIndeterminate
/>

Labeling#

View guidelines

Labels and value labels are shown by default on top, but they can also be moved to the side or hidden as needed. The label text should be in sentence case.

<Flex direction="column" maxWidth="size-3000" gap="size-300">
  <ProgressBar label="Loading…" value={30} />
  <ProgressBar label="Loading…" labelPosition="side" value={30} />
  <ProgressBar label="Loading…" showValueLabel={false} value={30} />
</Flex>

<Flex
  direction="column"
  maxWidth="size-3000"
  gap="size-300"
>
  <ProgressBar label="Loading…" value={30} />
  <ProgressBar
    label="Loading…"
    labelPosition="side"
    value={30}
  />
  <ProgressBar
    label="Loading…"
    showValueLabel={false}
    value={30}
  />
</Flex>

<Flex
  direction="column"
  maxWidth="size-3000"
  gap="size-300"
>
  <ProgressBar
    label="Loading…"
    value={30}
  />
  <ProgressBar
    label="Loading…"
    labelPosition="side"
    value={30}
  />
  <ProgressBar
    label="Loading…"
    showValueLabel={false}
    value={30}
  />
</Flex>

By default, the value label is formatted as a percentage. This can be customized using the following props.

showValueLabel: Allows you to display or hide the value label.
formatOptions: Allows you to customize the format of the value.
valueLabel: Allows you to customize the value label to any string.

<Flex direction="column" maxWidth="size-3000" gap="size-300">
  <ProgressBar label="Loading…" showValueLabel={false} value={30} />
  <ProgressBar label="Loading…" valueLabel="30 of 60 dogs" value={30} />
  <ProgressBar
    label="Loading…"
    formatOptions={{ style: 'percent', minimumFractionDigits: 2 }}
    value={30.123}
  />
</Flex>

<Flex
  direction="column"
  maxWidth="size-3000"
  gap="size-300"
>
  <ProgressBar
    label="Loading…"
    showValueLabel={false}
    value={30}
  />
  <ProgressBar
    label="Loading…"
    valueLabel="30 of 60 dogs"
    value={30}
  />
  <ProgressBar
    label="Loading…"
    formatOptions={{
      style: 'percent',
      minimumFractionDigits: 2
    }}
    value={30.123}
  />
</Flex>

<Flex
  direction="column"
  maxWidth="size-3000"
  gap="size-300"
>
  <ProgressBar
    label="Loading…"
    showValueLabel={false}
    value={30}
  />
  <ProgressBar
    label="Loading…"
    valueLabel="30 of 60 dogs"
    value={30}
  />
  <ProgressBar
    label="Loading…"
    formatOptions={{
      style: 'percent',
      minimumFractionDigits:
        2
    }}
    value={30.123}
  />
</Flex>

Accessibility#

Depending on the visualization being used (i.e. depending on the showValueLabel prop), a label, aria-label, or aria-labelledby prop is required.

If using the over background variant, ensure the background offers enough contrast for the ProgressBar to be legible and meets color contrast guidelines.

Internationalization#

To internationalize a ProgressBar, a localized string should be passed to the label prop, aria-label prop, or value of the associated aria-labelledby element.

For languages that are read right-to-left (e.g. Hebrew and Arabic), the layout, for both determinate and indeterminate options, is automatically flipped. In addition, ProgressBar automatically uses the current locale to format the value label.

Props#

Name	Type	Default	Description
`variant`	`'overBackground'`	—	The visual style of the ProgressBar.
`size`	`'S' \| 'L'`	`'L'`	How thick the bar should be.
`labelPosition`	`LabelPosition`	`'top'`	The label's overall position relative to the element it is labeling.
`label`	`ReactNode`	—	The content to display as the label.
`showValueLabel`	`boolean`	—	Whether the value's label is displayed. True by default if there's a label, false by default if not.
`formatOptions`	`Intl.NumberFormatOptions`	`{style: 'percent'}`	The display format of the value label.
`valueLabel`	`ReactNode`	—	The content to display as the value's label (e.g. 1 of 4).
`value`	`number`	`0`	The current value (controlled).
`minValue`	`number`	`0`	The smallest value allowed for the input.
`maxValue`	`number`	`100`	The largest value allowed for the input.
`isIndeterminate`	`boolean`	—	Whether presentation is indeterminate when progress isn't known.

Layout

Name	Type	Default	Description
`flex`	`Responsive<string \| number \| boolean>`	—	When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
`flexGrow`	`Responsive<number>`	—	When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
`flexShrink`	`Responsive<number>`	—	When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
`flexBasis`	`Responsive<number \| string>`	—	When used in a flex layout, specifies the initial main size of the element. See MDN.
`alignSelf`	`Responsive<'auto' \| 'normal' \| 'start' \| 'end' \| 'center' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'stretch'>`	—	Overrides the `alignItems` property of a flex or grid container. See MDN.
`justifySelf`	`Responsive<'auto' \| 'normal' \| 'start' \| 'end' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'center' \| 'left' \| 'right' \| 'stretch'>`	—	Specifies how the element is justified inside a flex or grid container. See MDN.
`order`	`Responsive<number>`	—	The layout order for the element within a flex or grid container. See MDN.
`gridArea`	`Responsive<string>`	—	When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
`gridColumn`	`Responsive<string>`	—	When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
`gridRow`	`Responsive<string>`	—	When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
`gridColumnStart`	`Responsive<string>`	—	When used in a grid layout, specifies the starting column to span within the grid. See MDN.
`gridColumnEnd`	`Responsive<string>`	—	When used in a grid layout, specifies the ending column to span within the grid. See MDN.
`gridRowStart`	`Responsive<string>`	—	When used in a grid layout, specifies the starting row to span within the grid. See MDN.
`gridRowEnd`	`Responsive<string>`	—	When used in a grid layout, specifies the ending row to span within the grid. See MDN.

Spacing

Name	Type	Default	Description
`margin`	`Responsive<DimensionValue>`	—	The margin for all four sides of the element. See MDN.
`marginTop`	`Responsive<DimensionValue>`	—	The margin for the top side of the element. See MDN.
`marginBottom`	`Responsive<DimensionValue>`	—	The margin for the bottom side of the element. See MDN.
`marginStart`	`Responsive<DimensionValue>`	—	The margin for the logical start side of the element, depending on layout direction. See MDN.
`marginEnd`	`Responsive<DimensionValue>`	—	The margin for the logical end side of an element, depending on layout direction. See MDN.
`marginX`	`Responsive<DimensionValue>`	—	The margin for both the left and right sides of the element. See MDN.
`marginY`	`Responsive<DimensionValue>`	—	The margin for both the top and bottom sides of the element. See MDN.

Sizing

Name	Type	Default	Description
`width`	`Responsive<DimensionValue>`	—	The width of the element. See MDN.
`minWidth`	`Responsive<DimensionValue>`	—	The minimum width of the element. See MDN.
`maxWidth`	`Responsive<DimensionValue>`	—	The maximum width of the element. See MDN.
`height`	`Responsive<DimensionValue>`	—	The height of the element. See MDN.
`minHeight`	`Responsive<DimensionValue>`	—	The minimum height of the element. See MDN.
`maxHeight`	`Responsive<DimensionValue>`	—	The maximum height of the element. See MDN.

Positioning

Name	Type	Default	Description
`position`	`Responsive<'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky'>`	—	Specifies how the element is positioned. See MDN.
`top`	`Responsive<DimensionValue>`	—	The top position for the element. See MDN.
`bottom`	`Responsive<DimensionValue>`	—	The bottom position for the element. See MDN.
`left`	`Responsive<DimensionValue>`	—	The left position for the element. See MDN. Consider using `start` instead for RTL support.
`right`	`Responsive<DimensionValue>`	—	The right position for the element. See MDN. Consider using `start` instead for RTL support.
`start`	`Responsive<DimensionValue>`	—	The logical start position for the element, depending on layout direction. See MDN.
`end`	`Responsive<DimensionValue>`	—	The logical end position for the element, depending on layout direction. See MDN.
`zIndex`	`Responsive<number>`	—	The stacking order for the element. See MDN.
`isHidden`	`Responsive<boolean>`	—	Hides the element.

Accessibility

Name	Type	Default	Description
`id`	`string`	—	The element's unique identifier. See MDN.
`aria-label`	`string`	—	Defines a string value that labels the current element.
`aria-labelledby`	`string`	—	Identifies the element (or elements) that labels the current element.
`aria-describedby`	`string`	—	Identifies the element (or elements) that describes the object.
`aria-details`	`string`	—	Identifies the element (or elements) that provide a detailed, extended description for the object.

Advanced

Name	Type	Default	Description
`UNSAFE_className`	`string`	—	Sets the CSS className for the element. Only use as a last resort. Use style props instead.
`UNSAFE_style`	`CSSProperties`	—	Sets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#

Over background#

View guidelines

When a ProgressBar needs to be placed on top of a colored background, use the overBackground variant.

<View backgroundColor="positive" padding="size-300">
  <ProgressBar label="Loading…" variant="overBackground" value={5} />
</View>

<View backgroundColor="positive" padding="size-300">
  <ProgressBar
    label="Loading…"
    variant="overBackground"
    value={5}
  />
</View>

<View
  backgroundColor="positive"
  padding="size-300"
>
  <ProgressBar
    label="Loading…"
    variant="overBackground"
    value={5}
  />
</View>

Size#

View guidelines

<Flex direction="column" gap="size-300">
  <ProgressBar label="Small" size="S" value={70} />
  <ProgressBar label="Large" size="L" value={70} />
</Flex>

<Flex direction="column" gap="size-300">
  <ProgressBar label="Small" size="S" value={70} />
  <ProgressBar label="Large" size="L" value={70} />
</Flex>

<Flex
  direction="column"
  gap="size-300"
>
  <ProgressBar
    label="Small"
    size="S"
    value={70}
  />
  <ProgressBar
    label="Large"
    size="L"
    value={70}
  />
</Flex>