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

[Stepper] Improve the description of the icon prop #16916

Merged
merged 1 commit into from
Aug 7, 2019
Merged

[Stepper] Improve the description of the icon prop #16916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/pages/api/step-icon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import { StepIcon } from '@material-ui/core';
| <span class="prop-name">classes</span> | <span class="prop-type">object</span> | | Override or extend the styles applied to the component. See [CSS API](#css) below for more details. |
| <span class="prop-name">completed</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | Mark the step as completed. Is passed to child components. |
| <span class="prop-name">error</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | Mark the step as failed. |
| <span class="prop-name required">icon&nbsp;*</span> | <span class="prop-type">node</span> | | The icon displayed by the step label. |
| <span class="prop-name required">icon&nbsp;*</span> | <span class="prop-type">node</span> | | The label displayed in the step icon. |

The `ref` is forwarded to the root element.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/api/step-label.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import { StepLabel } from '@material-ui/core';
| <span class="prop-name">classes</span> | <span class="prop-type">object</span> | | Override or extend the styles applied to the component. See [CSS API](#css) below for more details. |
| <span class="prop-name">disabled</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | Mark the step as disabled, will also disable the button if `StepLabelButton` is a child of `StepLabel`. Is passed to child components. |
| <span class="prop-name">error</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | Mark the step as failed. |
| <span class="prop-name">icon</span> | <span class="prop-type">node</span> | | Override the default icon. |
| <span class="prop-name">icon</span> | <span class="prop-type">node</span> | | Override the default label of the step icon. |
| <span class="prop-name">optional</span> | <span class="prop-type">node</span> | | The optional node to display. |
| <span class="prop-name">StepIconComponent</span> | <span class="prop-type">elementType</span> | | The component to render in place of the [`StepIcon`](/api/step-icon/). |
| <span class="prop-name">StepIconProps</span> | <span class="prop-type">object</span> | | Props applied to the [`StepIcon`](/api/step-icon/) element. |
Expand Down
2 changes: 1 addition & 1 deletion packages/material-ui/src/StepIcon/StepIcon.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ StepIcon.propTypes = {
*/
error: PropTypes.bool,
/**
* The icon displayed by the step label.
* The label displayed in the step icon.
*/
icon: PropTypes.node.isRequired,
};
Expand Down
2 changes: 1 addition & 1 deletion packages/material-ui/src/StepLabel/StepLabel.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ StepLabel.propTypes = {
*/
error: PropTypes.bool,
/**
* Override the default icon.
* Override the default label of the step icon.
*/
icon: PropTypes.node,
/**
Expand Down