Props
Props table for all components provided by chakra-ui-steps.
Steps
| Prop | Type | Required | Description |
|---|---|---|---|
activeStep | number | yes | Currently active step |
colorScheme | string | no | Sets the color accent of the Steps component show |
orientation | string | no | Sets the orientation of the Steps component |
responsive | boolean | no | Sets whether the component auto switches to vertical orientation on mobile |
checkIcon | React.ComponentType | no | Allows you to provide a custom check icon |
onClickStep | () => void | no | If defined, allows you to click on the step icons |
state | 'loading' | 'error' | no | Let's you set the state to error or loading |
Step
| Prop | Type | Required | Description |
|---|---|---|---|
label | string | no | Sets the title of the step |
description | string | no | Provides extra info about the step |
icon | React.ComponentType | no | Custom icon to overwrite the default numerical indicator of the step |
isCompletedStep | boolean | no | Individually control each step state, defaults to active step |
isKeepError | boolean | no | Individually control if each step should keep showing the error state |
checkIcon | React.ComponentType | no | Allows you to provide a custom check icon that will override the one provided to Steps |
state | 'loading' | 'error' | no | Let's you set the state in a specific Step, if defined it will override the one provided to Steps |