[docs] Update custom Typography variants example #36185
Merged
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
mj12albert
added
docs
Netlify deploy preview
Bundle size report |
mj12albert
force-pushed
the
docs/material-ui-typography
branch
5 times, most recently
from
cec67ed
to
e628a79
Compare
There was a problem hiding this comment.
I love to see improvements to the docs like this! 🤩 Keep them coming @mj12albert ! My review is all related to style. Let me know if you have any questions about style rules and best practices. :)
docs/data/material/customization/typography/TypographyCustomVariant.tsx
Outdated
Show resolved
Hide resolved
mj12albert
force-pushed
the
docs/material-ui-typography
branch
2 times, most recently
from
e31d02b
to
126a111
Compare
|
Updated – thanks for the suggestions @samuelsycamore ! |
siriwatknp
reviewed
Feb 16, 2023
Comment on lines
20
to
32
| // we have to provide the default variantMapping first because currently | ||
| // custom entries will replace this whole object instead of being merged | ||
| h1: 'h1', | ||
| h2: 'h2', | ||
| h3: 'h3', | ||
| h4: 'h4', | ||
| h5: 'h5', | ||
| h6: 'h6', | ||
| subtitle1: 'h6', | ||
| subtitle2: 'h6', | ||
| body1: 'p', | ||
| body2: 'p', | ||
| inherit: 'p', |
There was a problem hiding this comment.
Suggested change
| // we have to provide the default variantMapping first because currently | |
| // custom entries will replace this whole object instead of being merged | |
| h1: 'h1', | |
| h2: 'h2', | |
| h3: 'h3', | |
| h4: 'h4', | |
| h5: 'h5', | |
| h6: 'h6', | |
| subtitle1: 'h6', | |
| subtitle2: 'h6', | |
| body1: 'p', | |
| body2: 'p', | |
| inherit: 'p', |
After checking the implementation, these lines are not needed.
Here is the proof: https://codesandbox.io/s/naughty-ives-5vorcl?file=/demo.tsx
There was a problem hiding this comment.
Thanks for double checking ~ I see it falls back to the default variantMapping here
siriwatknp
reviewed
Feb 16, 2023
siriwatknp
reviewed
Feb 16, 2023
docs/data/material/customization/typography/TypographyCustomVariant.tsx
Outdated
Show resolved
Hide resolved
mj12albert
force-pushed
the
docs/material-ui-typography
branch
from
126a111
to
72f7209
Compare
siriwatknp
approved these changes
Feb 17, 2023
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.
Follow up to: #36005 (comment)
Preview: https://deploy-preview-36185--material-ui.netlify.app/material-ui/customization/typography/#adding-amp-disabling-variants
This PR expands a little more on how to add custom Typography variants to material-ui.
I am assuming that its very likely a user would want to (or want to know how to) specify the default HTML element for custom Typography variants if they are on this part of the docs, and it's not obvious (at least I completely missed it 🤦 ) that this is the way to do it until Jun pointed it out.
The most related existing doc about this is here but it's not linked to from that page, and doesn't directly address using
variantMappingand custom variants together – also I think a page called "Customization/Typography" should be a one-stop shop for all of this instead of having to hop to another page!