-
Notifications
You must be signed in to change notification settings - Fork 231
docs(avatar): update a11y docs #5665
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
base: main
Are you sure you want to change the base?
Conversation
|
efa4eb6
to
b474554
Compare
📚 Branch Preview🔍 Visual Regression Test ResultsWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
Deployed to Azure Blob Storage: If the changes are expected, update the |
Tachometer resultsCurrently, no packages are changed by this PR... |
b474554
to
702923a
Compare
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 pretty good! I left a couple of comments below.
Looking at the API table, it looks like there are a bunch of properties that come from LikeAnchor
, because it looks like the avatar can be wrapped in an anchor tag when href
is present. That might be a good additional thing to document here?
#### Generic avatars | ||
|
||
Use branded generic avatars when a user has not set their avatar image. These images are designed to be abstracted from all genders, locales, and cultures. |
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.
This feels less like a state, but I'm not sure it's necessarily an option either. Thoughts?
|
||
#### Sizes | ||
|
||
Avatar sizes scale exponentially, based on the Spectrum type scale. These range from `size-50` to `size-700`. An avatar can also be customized to fit appropriately for your context. |
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.
There's a default size, right? That feels like something we could mention here.
Description
Improving the accessibility documentation of components.
Related issue(s)
SWC-358
Author's checklist
Reviewer's checklist
patch
,minor
, ormajor
featuresDevice review