Skip to content

Commit

Permalink
docs(StepIndicator): format Steps Parameters table (#2284)
Browse files Browse the repository at this point in the history
  • Loading branch information
langz authored May 5, 2023
1 parent 22565ad commit 0d8191a
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ showTabs: true
## Steps Parameters

| Parameters | Description |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --- |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `title` | _(required)_ the title as a string or React element. |
| `is_current` | _(optional)_ if set to `true`, this item step will be set as the current current selected step. This can be used instead of `current_step` on the component itself. |
| `inactive` | _(optional)_ if set to `true`, this item step will be handled as an inactive step and will not be clickable. Defaults to `false`. |
| `disabled` | _(optional)_ if set to `true`, this item step will be visible as an disabled button and will not be clickable. Defaults to `false`. |
| `status` | _(optional)_ a status text. |
| `status_state` | _(optional)_ In case the status state should be `info` or `error`. Defaults to `warn`. |
| `on_render` | _(optional)_ callback function to manipulate or wrap a certain item. Has to return a React Node. |
| `on_click` | _(optional)_ event function that gets invoked once the users clicks on the active item. | | |
| `on_click` | _(optional)_ event function that gets invoked once the users clicks on the active item. |

## Steps example

Expand Down

0 comments on commit 0d8191a

Please sign in to comment.