-
Couldn't load subscription status.
- Fork 851
feat: Add <UserAvatar /> documentation
#2708
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
<UserAvatar /> documentation
|
@tmilewski have submitted a docs review with a few changes. Feel free to check out the commit and let me know if you have any thoughts. I will test this with the diff SDKs, and if that's all good, then it should be good to go. Tagging @alexisintech for visibility on this. |
|
@SarahSoutoul Thank you!! |
|
@tmilewski One comment I had was regarding the picture - it appeared really small, so I removed the styling in my docs review, and it looks a bit better. But I feel like the avatar is still really small - wondering if we could get a better image with the actual avatar being bigger? Before: After: |
|
Update on this one @alexisintech:
|
Another update @alexisintech:
That's the remaining element before approving this, so feel free to review my docs review and any other things while we wait for the image. |
|
@tmilewski @SarahSoutoul it looks like there's some extra props here that weren't documented: component and fallback is there more info surrounding these? |
|
@alexisintech Where are you seeing that? |
From the JS repo, there are only two props available: |
|
Actually, there is a merge of props @tmilewski So on top of the UserAvatarProps, there is |
yup! let's get those documented please :) |
@tmilewski @alexisintech have added the |
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.
Left some small nits. Approving as not to block. Feel free to incorporate them now or do a follow up PR.
Might want @alexisintech's final blessing over mine too.
Co-authored-by: Michael Novotny <[email protected]>
|
we don't really put "optional" for any prop descriptions, because the |
Have reverted back the old description for |
hmm maybe we should do a props table clean up and get those consistent across the docs - just a chore though, not a high priority. i can create a ticket ! |
π Previews:
What does this solve?
Adds documentation for the new
<UserAvatar />component.What changed?
<UserAvatar />component reference page[un]mountUserAvatar(...)to the Javascript referenceChecklist