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.

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

Update Typography documentation to not include success as a supported color #44908

Closed
lericksonobsidian opened this issue Dec 31, 2024 · 3 comments
Assignees
Labels
component: Typography The React component. support: question Community support but can be turned into an improvement

Comments

@lericksonobsidian
Copy link

lericksonobsidian commented Dec 31, 2024

Please update the MUI documentation to not include success as a supported color prop.

Link to docs: https://mui.com/material-ui/api/typography/#typography-prop-color

From an older issue:

          I know this was closed years ago, but the docs do indeed say that using "success" is supported. https://mui.com/material-ui/api/typography/

Originally posted by @dsatfire in #29564 (comment)

Search keywords: Typography, success, green, color prop

@github-actions github-actions bot added the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label Dec 31, 2024
@zannager zannager added the component: Typography The React component. label Jan 1, 2025
@siriwatknp
Copy link
Member

I know that this is confusing but the success is one of the supported in v6 and in the future too.

For history, success was going to be removed because of system props support in v5. However, we learned that system props won't be a sustainable API in long term, so decided to deprecate the system props and bring back the success color.

What you see in the docs is correct.

@siriwatknp siriwatknp added support: question Community support but can be turned into an improvement and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Jan 3, 2025
Copy link

github-actions bot commented Jan 3, 2025

This issue has been closed. If you have a similar problem but not exactly the same, please open a new issue.
Now, if you have additional information related to this issue or things that could help future readers, feel free to leave a comment.

Note

@lericksonobsidian How did we do? Your experience with our support team matters to us. If you have a moment, please share your thoughts in this short Support Satisfaction survey.

@dsatfire
Copy link

dsatfire commented Jan 3, 2025

@siriwatknp The docs say "success" is supported. Typography does not support "success" color even though the docs say it does. It accepts the value because color supports string, but it does not apply the color styling.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: Typography The React component. support: question Community support but can be turned into an improvement
Projects
None yet
Development

No branches or pull requests

4 participants