Skip to content

Commit

Permalink
[docs][material-ui] Add docs for complementary stepper components (@a…
Browse files Browse the repository at this point in the history
…nle9650) (#42613)

Signed-off-by: Andy Le <andy.le@ucdenver.edu>
Signed-off-by: Zeeshan Tamboli <zeeshan.tamboli@gmail.com>
Co-authored-by: Andy Le <andy.le@ucdenver.edu>
Co-authored-by: Diego Andai <diego@mui.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: ZeeshanTamboli <zeeshan.tamboli@gmail.com>
  • Loading branch information
5 people authored Jun 11, 2024
1 parent c890b25 commit c83dfd8
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/data/material/components/steppers/steppers.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,29 @@ Steppers may display a transient feedback message after a step is saved.
This component is no longer documented in the [Material Design guidelines](https://m2.material.io/), but Material UI will continue to support it.
:::

## Introduction

The Stepper component displays progress through a sequence of logical and numbered steps.
It supports horizontal and vertical orientation for desktop and mobile viewports.

Steppers are implemented using a collection of related components:

- Stepper: the container for the steps.
- Step: an individual step in the sequence.
- Step Label: a label for a Step.
- Step Content: optional content for a Step.
- Step Button: optional button for a Step.
- Step Icon: optional icon for a Step.
- Step Connector: optional customized connector between Steps.

## Basics

```jsx
import Stepper from '@mui/material/Stepper';
import Step from '@mui/material/Step';
import StepLabel from '@mui/material/StepLabel';
```

## Horizontal stepper

Horizontal steppers are ideal when the contents of one step depend on an earlier step.
Expand Down

0 comments on commit c83dfd8

Please sign in to comment.