Displays a progress bar related to a task.
<Box maxWidth="300px">
<Progress />
</Box>
This component inherits props from the Progress primitive and supports common margin props.
| Prop | Type | Default |
|---|---|---|
size | Responsive<"1" | "2" | "3"> | "2" |
variant | "classic" | "surface" | "soft" | "surface" |
color | enum | |
highContrast | boolean | |
radius | "none" | "small" | "medium" | "large" | "full" | |
duration | string |
Use the size prop to control the size.
<Flex direction="column" gap="4" maxWidth="300px">
<Progress value={25} size="1" />
<Progress value={50} size="2" />
<Progress value={75} size="3" />
</Flex>
Use the variant prop to control the visual style.
<Flex direction="column" gap="4" maxWidth="300px">
<Progress value={25} variant="classic" />
<Progress value={50} variant="surface" />
<Progress value={75} variant="soft" />
</Flex>
Use the color prop to assign a specific color.
<Flex direction="column" gap="4" maxWidth="300px">
<Progress value={20} color="indigo" />
<Progress value={40} color="cyan" />
<Progress value={60} color="orange" />
<Progress value={80} color="crimson" />
</Flex>
Use the highContrast prop to increase color contrast with the background.
<Grid columns="2" gap="4">
<Progress value={10} color="indigo" />
<Progress value={10} color="indigo" highContrast />
<Progress value={30} color="cyan" />
<Progress value={30} color="cyan" highContrast />
<Progress value={50} color="orange" />
<Progress value={50} color="orange" highContrast />
<Progress value={70} color="crimson" />
<Progress value={70} color="crimson" highContrast />
<Progress value={90} color="gray" />
<Progress value={90} color="gray" highContrast />
</Grid>
Use the radius prop to assign a specific radius value.
<Flex direction="column" gap="4" maxWidth="300px">
<Progress value={25} radius="none" />
<Progress value={50} radius="small" />
<Progress value={75} radius="full" />
</Flex>
Use the value prop to provide a precise indication of the task progress.
<Progress value={75} />
Use the duration prop to indicate an approximate duration of an indeterminate task. Once the duration times out, the progress bar will start an indeterminate animation.
<Progress duration="30s" />
When an approximate duration can be estimated, the Progress component is still useful over Spinner, which doesn’t provide any visual cues towards the progress of the task.