-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
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
[docs] Revise the Joy UI "Avatar" component page #35152
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Approved the Argos detection.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great!
|
||
{{"demo": "BadgeAvatars.js"}} | ||
|
||
### Group | ||
## Usage with the Avatar Group |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that it would be simpler with:
## Usage with the Avatar Group | |
## Avatar Group |
When I read "Usage with" I head with another component, but the group is part of the same component. Maybe "group" should be lowercase for the same reason.
@samuelsycamore On this page, as a user, I think that I would the first 2-3 viewports's height of the page would work better with:
so we don't have to scroll two viewports to find one. As a developer, I would personally never trust what I see in 1. because it doesn't have a preview of what it renders. |
Whoops! That header is an artifact from the earlier version of the doc. I'll address that and the need for a demo under Basics in #35162. We can discuss whether or not to remove this section entirely on that PR. |
Part of #33998
This PR revises the Joy UI "Avatar" component page.
I also added a new kind of
h2
to this page, which I haven't tried elsewhere: Usage with [some other component]. I think this helps to differentiate the content from what would otherwise fall under Customization, and hopefully makes it easier for users to find. cc @oliviertassinari do you think this pattern would work in the Material UI docs as well?https://deploy-preview-35152--material-ui.netlify.app/joy-ui/react-alert/