[material-ui][docs] Add docs for complementary stepper components #41900
+22
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zannager
added
docs
|
@michaldudak, would you know the reason for this failure? |
|
No idea. It seems that only this PR is affected. We could try recreating the PR. |
I tried creating a new branch from |
|
Since this PR touches just the docs, it's safe to bypass the checks and merge it. |
|
Hey @anle9650, thanks for working on this. The changes look good to me, but I want to wait for @samuelsycamore's review in case there's anything to add or rephrase. |
There was a problem hiding this comment.
just some small style tweaks here, otherwise looking good. Thanks @anle9650 !
| @@ -22,6 +22,28 @@ 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 | |||
|
|
|||
| Stepper displays progress through a sequence of logical and numbered steps. It support horizontal and vertical orientation for desktop and mobile viewports. | |||
There was a problem hiding this comment.
Suggested change
| Stepper displays progress through a sequence of logical and numbered steps. It support horizontal and vertical orientation for desktop and mobile viewports. | |
| The Stepper component displays progress through a sequence of logical and numbered steps. | |
| It supports horizontal and vertical orientation for desktop and mobile viewports. |
|
|
||
| Stepper displays progress through a sequence of logical and numbered steps. It support horizontal and vertical orientation for desktop and mobile viewports. | ||
|
|
||
| Material UI Steppers are implemented using a collection of related components: |
There was a problem hiding this comment.
Suggested change
| Material UI Steppers are implemented using a collection of related components: | |
| Steppers are implemented using a collection of related components: |
|
|
||
| Material UI Steppers are implemented using a collection of related components: | ||
|
|
||
| - Stepper: a required container for steps. Renders as a `<ol>` by default. |
There was a problem hiding this comment.
Suggested change
| - Stepper: a required container for steps. Renders as a `<ol>` by default. | |
| - Stepper: the container for the steps. Renders as a `<ol>` by default. |
| Material UI Steppers are implemented using a collection of related components: | ||
|
|
||
| - Stepper: a required container for steps. Renders as a `<ol>` by default. | ||
| - Step: a step. Renders as a `<li>` by default. |
There was a problem hiding this comment.
Suggested change
| - Step: a step. Renders as a `<li>` by default. | |
| - Step: an individual step in the sequence. Renders as a `<li>` by default. |
|
|
||
| - Stepper: a required container for steps. Renders as a `<ol>` by default. | ||
| - Step: a step. Renders as a `<li>` by default. | ||
| - Step Label: a label of a step. |
There was a problem hiding this comment.
Suggested change
| - Step Label: a label of a step. | |
| - Step Label: a label for a Step. |
| - Stepper: a required container for steps. Renders as a `<ol>` by default. | ||
| - Step: a step. Renders as a `<li>` by default. | ||
| - Step Label: a label of a step. | ||
| - Step Content: an optional content of a step. |
There was a problem hiding this comment.
Suggested change
| - Step Content: an optional content of a step. | |
| - Step Content: optional content for a Step. |
| - Step: a step. Renders as a `<li>` by default. | ||
| - Step Label: a label of a step. | ||
| - Step Content: an optional content of a step. | ||
| - Step Button: an optional button of a step. |
There was a problem hiding this comment.
Suggested change
| - Step Button: an optional button of a step. | |
| - Step Button: optional button for a Step. |
| - Step Label: a label of a step. | ||
| - Step Content: an optional content of a step. | ||
| - Step Button: an optional button of a step. | ||
| - Step Icon: an optional icon of a step. |
There was a problem hiding this comment.
Suggested change
| - Step Icon: an optional icon of a step. | |
| - Step Icon: optional icon for a Step. |
| - Step Content: an optional content of a step. | ||
| - Step Button: an optional button of a step. | ||
| - Step Icon: an optional icon of a step. | ||
| - Step Connector: an optional customized connector of a step. |
There was a problem hiding this comment.
Suggested change
| - Step Connector: an optional customized connector of a step. | |
| - Step Connector: optional customized connector between Steps. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #39952. Fixes #41454.