Progress
The Progress component allows you to view the progress of any activity.
import { Progress } from '@nextui-org/react';
Default
You can control the current value
of progress.
Indeterminated
You can have a Progress
bar with indeterminate value with the indeterminated
property.
Colors
You can change the color of the Progress
with the property color
.
Sizes
You can change the height of the progress with the property size
.
Status
You can change the background of the Progress
with the property status
.
Shadow
You can add a shadow effect with the property shadow
.
Striped
You can add striped
prop to Progress
to apply a stripe over the progress bar's background color.
Squared
You can change the full style to a squared Progress
with the squared
property.
No Animated
You can disabled the initial animation setting animated={false}
.
APIs
Progress Props
Attribute | Type | Accepted values | Description | Default |
---|---|---|---|---|
value | number | - | Current value | - |
min | number | - | Progress min value | 0 |
max | number | - | Progress max value | 100 |
color | NormalColors | NormalColors | Change filler bar color | default |
status | NormalColors | NormalColors | Change filler bar background color | default |
size | NormalSizes | NormalSizes | Change progress size | medium |
striped | boolean | true/false | Stripe over the progress bar's background color | false |
indeterminated | boolean | true/false | Indeterminated progress | false |
shadow | boolean | true/false | Display shadow effect | false |
squared | boolean | true/false | Squared progress | false |
animated | boolean | true/false | Enable or disable the progress animation | true |
css | Stitches.CSS | - | Override Default CSS style | - |
as | keyof JSX.IntrinsicElements | - | Changes which tag component outputs | div |
... | ProgressHTMLAttributes | 'id', 'className', ... | Progress native props | - |
Progress types
Normal Colors
type NormalColors = | 'default' | 'primary' | 'secondary' | 'success' | 'warning' | 'error' | 'gradient';
Normal Sizes
type NormalSizes = 'xs' | 'sm' | 'md' | 'lg' | 'xl';