47266 improve button documentation examples #47267
Closed
Conversation
This file contains hidden or 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
Netlify deploy previewhttps://deploy-preview-47267--material-ui.netlify.app/ Bundle size report
|
zannager
added
docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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 PR enhances the Button component documentation by adding missing examples and accessibility guidance.
Changes introduced:
Added examples for all variants (contained, outlined, text).
Included size variations (small, medium, large).
Demonstrated usage with icons (startIcon, endIcon).
Added disabled state example.
Expanded color coverage (primary, secondary, success, error).
Added accessibility tips for icon-only buttons (aria-label, Tooltip usage, focus order).
Provided a ready-to-use JSX snippet for quick copy/paste.
Motivation:
The current Button docs lacked comprehensive examples for common use cases. These additions improve clarity, help developers quickly understand usage patterns, and promote accessibility best practices.
Preview:
Netlify deploy preview will show updated examples for review.
Linked Issue:
Closes #47266