Progress

Progress is used to display the progress status for a task that takes a long time or consists of several steps.

Import#

import { Progress } from '@nature-ui/core';

Usage#

Editable Example

Progress with Stripe#

You can add hasStripe prop to any progress bar to apply a stripe via a CSS gradient over the progress bar’s background color.

Editable Example

Progress sizes#

There are two ways you can increase the height of the progress bar:

  • You can add size prop to increase the height of the progress bar.
  • You can also use the height prop to manually set a height.
Editable Example

Progress color scheme#

You can add colorScheme prop to any progress bar to apply any color that exists in the theme config file.

Editable Example

Animated Progress#

To show an animated progress, set the value prop to undefined to put the progress component to an indeterminate state.

Editable Example

Accessibility#

  • Progress has a role set to progressbar to denote that it is a progress.
  • Progress has aria-valuenow set to the percentage completion value passed to the component, to ensure the progress percent is visible to screen readers.

Props#

NameTypeDefaultDescription
colorSchemestringblue-500Determines the fill color of the progress bar
hasStripebooleanfalseIf true, the progress bar will show stripe
isAnimatedbooleanfalseIf true, and hasStripe is true, the stripes will be animated
maxnumber-The maximum value of the progress
minnumber-The minimum value of the progress
size"sm" | "md" | "lg" | "number""md"
valuenumberundefinedThe value of the progress indicator. If undefined the progress bar will be in indeterminate state