[material-ui][docs][TableRow] Escape markup in children prop so docgen tools don't parse it as HTML
#40992
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
Signed-off-by: Steve Miller <millerized@me.com>
Netlify deploy previewhttps://deploy-preview-40992--material-ui.netlify.app/ Bundle size report |
Signed-off-by: Steve Miller <millerized@me.com>
There was a problem hiding this comment.
@millerized, I don't see this error in the API docs for the TableRow component when I run the docs server locally. Can you show on which page the error is shown?
Hi @ZeeshanTamboli! Thanks for your help. This error occurs in my storybook documentation that uses react-ts-docgen to create the props tables. This change is just a minor improvement for folks that are consuming the MUI types in their own systems. |
Signed-off-by: Steve Miller <millerized@me.com>
ZeeshanTamboli
approved these changes
Feb 12, 2024
children prop so docgen tools don't parse it as HTML
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.
This is a minor change to the
TableRowTS prop description that allows docgen parsers to use the description without rendering the markup as HTML. See screenies for example:Before
After