Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs][material-ui] Add docs for complementary stepper components #41900

Merged
merged 14 commits into from
Jun 11, 2024
Merged

[docs][material-ui] Add docs for complementary stepper components #41900

Changes from 2 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
81326b8
Update steppers.md
anle9650 Apr 14, 2024
8ee52c8
trigger ci
DiegoAndai Apr 17, 2024
2bb414d
Update docs/data/material/components/steppers/steppers.md
anle9650 May 18, 2024
2469fa6
Update docs/data/material/components/steppers/steppers.md
anle9650 May 18, 2024
8ec7ec1
Update docs/data/material/components/steppers/steppers.md
anle9650 May 18, 2024
02af1c8
Update docs/data/material/components/steppers/steppers.md
anle9650 May 18, 2024
ff48e94
Update docs/data/material/components/steppers/steppers.md
anle9650 May 18, 2024
3265d75
Update docs/data/material/components/steppers/steppers.md
anle9650 May 18, 2024
ff11e0a
Update docs/data/material/components/steppers/steppers.md
anle9650 May 18, 2024
e5fbb42
Update docs/data/material/components/steppers/steppers.md
anle9650 May 18, 2024
8f69324
Update docs/data/material/components/steppers/steppers.md
anle9650 May 18, 2024
c215366
Update steppers.md
anle9650 May 26, 2024
c24fa88
Merge branch 'next' into add-documentation-for-complementary-stepper-…
ZeeshanTamboli Jun 11, 2024
8a4a2c2
Update docs/data/material/components/steppers/steppers.md
ZeeshanTamboli Jun 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/data/material/components/steppers/steppers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,28 @@
This component is no longer documented in the [Material Design guidelines](https://m2.material.io/), but Material UI will continue to support it.
:::

## Introduction

Stepper displays progress through a sequence of logical and numbered steps. It support horizontal and vertical orientation for desktop and mobile viewports.
anle9650 marked this conversation as resolved.
Show resolved Hide resolved

Material UI Steppers are implemented using a collection of related components:

Check failure on line 29 in docs/data/material/components/steppers/steppers.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[MUI.MuiBrandName] Use a non-breaking space (option+space on Mac, Alt+0160 on Windows or AltGr+Space on Linux, instead of space) for brand name ('Material UI' instead of 'Material UI')

Raw Output:
{"message": "[MUI.MuiBrandName] Use a non-breaking space (option+space on Mac, Alt+0160 on Windows or AltGr+Space on Linux, instead of space) for brand name ('Material UI' instead of 'Material UI')", "location": {"path": "docs/data/material/components/steppers/steppers.md", "range": {"start": {"line": 29, "column": 1}}}, "severity": "ERROR"}
anle9650 marked this conversation as resolved.
Show resolved Hide resolved

- Stepper: a required container for steps. Renders as a `<ol>` by default.
anle9650 marked this conversation as resolved.
Show resolved Hide resolved
- Step: a step. Renders as a `<li>` by default.
anle9650 marked this conversation as resolved.
Show resolved Hide resolved
- Step Label: a label of a step.
anle9650 marked this conversation as resolved.
Show resolved Hide resolved
- Step Content: an optional content of a step.
anle9650 marked this conversation as resolved.
Show resolved Hide resolved
- Step Button: an optional button of a step.
anle9650 marked this conversation as resolved.
Show resolved Hide resolved
- Step Icon: an optional icon of a step.
anle9650 marked this conversation as resolved.
Show resolved Hide resolved
- Step Connector: an optional customized connector of a step.
anle9650 marked this conversation as resolved.
Show resolved Hide resolved

## 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
Loading