Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@tmilewski
Copy link
Member

@tmilewski tmilewski commented Oct 15, 2025

πŸ”Ž Previews:

What does this solve?

Adds documentation for the new <UserAvatar /> component.

What changed?

  • Adds sidebar "User components" element
  • Adds <UserAvatar /> component reference page
  • Adds [un]mountUserAvatar(...) to the Javascript reference

Checklist

  • I have clicked on "Files changed" and performed a thorough self-review
  • All existing checks pass

@tmilewski tmilewski requested a review from a team as a code owner October 15, 2025 20:57
@vercel
Copy link

vercel bot commented Oct 15, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
clerk-docs Ready Ready Preview Oct 28, 2025 6:43pm

@tmilewski tmilewski self-assigned this Oct 15, 2025
@tmilewski tmilewski changed the title feat: Add user avatar documentation feat: Add <UserAvatar /> documentation Oct 15, 2025
@SarahSoutoul
Copy link
Contributor

SarahSoutoul commented Oct 16, 2025

@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.

@tmilewski
Copy link
Member Author

@SarahSoutoul Thank you!!

@SarahSoutoul
Copy link
Contributor

@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:

Screenshot 2025-10-16 at 10 40 53β€―am

After:

Screenshot 2025-10-16 at 10 41 03β€―am

@SarahSoutoul
Copy link
Contributor

Update on this one @alexisintech:

  • Have tested the code examples for all SDKs, and noticed issues with Astro, Expo and Nuxt. @tmilewski is currently fixing those.
  • For the image, @tmilewski is going to create a ticket for the Design team to have some better images for the component.

@SarahSoutoul
Copy link
Contributor

Update on this one @alexisintech:

  • Have tested the code examples for all SDKs, and noticed issues with Astro, Expo and Nuxt. @tmilewski is currently fixing those.
  • For the image, @tmilewski is going to create a ticket for the Design team to have some better images for the component.

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.

@alexisintech
Copy link
Member

@tmilewski @SarahSoutoul it looks like there's some extra props here that weren't documented: component and fallback

is there more info surrounding these?

Screenshot 2025-10-22 at 15 01 53

@tmilewski
Copy link
Member Author

@alexisintech Where are you seeing that?

@SarahSoutoul
Copy link
Contributor

@tmilewski @SarahSoutoul it looks like there's some extra props here that weren't documented: component and fallback

is there more info surrounding these?

Screenshot 2025-10-22 at 15 01 53

From the JS repo, there are only two props available:

Screenshot 2025-10-22 at 1 15 50β€―pm

@SarahSoutoul
Copy link
Contributor

Actually, there is a merge of props @tmilewski

Screenshot 2025-10-22 at 1 20 54β€―pm

So on top of the UserAvatarProps, there is fallback and component

@alexisintech
Copy link
Member

Actually, there is a merge of props @tmilewski

Screenshot 2025-10-22 at 1 20 54β€―pm So on top of the UserAvatarProps, there is `fallback` and `component`

yup! let's get those documented please :)

@SarahSoutoul
Copy link
Contributor

SarahSoutoul commented Oct 23, 2025

Add missing prop

@tmilewski @alexisintech have added the fallback prop here, and updated all the props as optional after looking at the JS repo. But, I am confused about component, and what it does to be honest - in the snippet below, it is part of WithClerkProp, which is something used in other components, yet, not documented on these components. Let me know thoughts!

504369973-96424fee-6623-4ec8-bbdc-9479b2cfed5d

Copy link
Contributor

@manovotny manovotny left a 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.

@alexisintech
Copy link
Member

we don't really put "optional" for any prop descriptions, because the ? marker is there. i wouldn't start doing that now, as to keep all of the docs consistent

@SarahSoutoul
Copy link
Contributor

we don't really put "optional" for any prop descriptions, because the ? marker is there. i wouldn't start doing that now, as to keep all of the docs consistent

Have reverted back the old description for rounded here. However, kept the descriptions for fallback and appearance, since those are used across the docs.

@alexisintech
Copy link
Member

we don't really put "optional" for any prop descriptions, because the ? marker is there. i wouldn't start doing that now, as to keep all of the docs consistent

Have reverted back the old description for rounded here. However, kept the descriptions for fallback and appearance, since those are used across the docs.

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 !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants