ProgressCircle

ProgressCircles show the progression of a system operation such as downloading, uploading, processing, etc. in a visual way. They can represent determinate or indeterminate progress.

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

View guidelines

Spectrum

Example#

<ProgressCircle aria-label="Loading…" value={50} />

<ProgressCircle aria-label="Loading…" value={50} />

<ProgressCircle
  aria-label="Loading…"
  value={50}
/>

Value#

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

<ProgressCircle aria-label="Loading…" value={25} />

<ProgressCircle aria-label="Loading…" value={25} />

<ProgressCircle
  aria-label="Loading…"
  value={25}
/>

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

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

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

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

Indeterminate#

View guidelines

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

<ProgressCircle aria-label="Loading…" value={50} />

<ProgressCircle aria-label="Loading…" value={50} />

<ProgressCircle
  aria-label="Loading…"
  value={50}
/>

Use an indeterminate ProgressCircle when progress is happening but the time or effort to completion can’t be determined.

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

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

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

Accessibility#

An aria-label must be provided for accessibility. If the ProgressCircle is labeled by a separate element, an aria-labelledby prop must be provided using the id of the labeling element instead.

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

Internationalization#

To internationalize a ProgressCircle, a localized string should be passed to the 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 fill of both determinate and indeterminate ProgressCircles continues to spin clockwise.

Props#

Name	Type	Default	Description
`size`	`'S' \| 'M' \| 'L'`	`'M'`	What the ProgressCircle's diameter should be.
`variant`	`'overBackground'`	—	The visual style of the ProgressCircle.
`isIndeterminate`	`boolean`	—	Whether presentation is indeterminate when progress isn't known.
`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.

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 ProgressCircle needs to be placed on top of a colored background, use the overBackground variant.

<View backgroundColor="positive" padding="size-300">
  <ProgressCircle
    aria-label="Loading…"
    isIndeterminate
    variant="overBackground"
  />
</View>

<View backgroundColor="positive" padding="size-300">
  <ProgressCircle
    aria-label="Loading…"
    isIndeterminate
    variant="overBackground"
  />
</View>

<View
  backgroundColor="positive"
  padding="size-300"
>
  <ProgressCircle
    aria-label="Loading…"
    isIndeterminate
    variant="overBackground"
  />
</View>

Size#

View guidelines

<ProgressCircle
  aria-label="Loading…"
  marginEnd="size-300"
  size="S"
  value={15}
/>
<ProgressCircle aria-label="Loading…" marginEnd="size-300" value={30} />
<ProgressCircle aria-label="Loading…" size="L" value={60} />

<ProgressCircle
  aria-label="Loading…"
  marginEnd="size-300"
  size="S"
  value={15}
/>
<ProgressCircle
  aria-label="Loading…"
  marginEnd="size-300"
  value={30}
/>
<ProgressCircle
  aria-label="Loading…"
  size="L"
  value={60}
/>

<ProgressCircle
  aria-label="Loading…"
  marginEnd="size-300"
  size="S"
  value={15}
/>
<ProgressCircle
  aria-label="Loading…"
  marginEnd="size-300"
  value={30}
/>
<ProgressCircle
  aria-label="Loading…"
  size="L"
  value={60}
/>