Skip to content

Add prop for Avatar inside jsdoc #3037

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.

Sign up for GitHub

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

Merged
FrederikBolding merged 2 commits into from
Jan 28, 2025
Merged

Add prop for Avatar inside jsdoc #3037

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f09095
Add prop for Avatar inside jsdoc
Montoya Jan 25, 2025
c742089
Add jsdoc to props too
FrederikBolding Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/snaps-sdk/src/jsx/components/Avatar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { createSnapComponent } from '../component';
* The props of the {@link Avatar} component.
*
* @property address - The address to display. This should be a valid CAIP-10 address.
* @property size - The size of the avatar. Can be `sm`, `md`, or `lg`. Defaults to `md`.
*/
export type AvatarProps = {
address: CaipAccountId;
Expand All @@ -21,6 +22,7 @@ const TYPE = 'Avatar';
*
* @param props - The props of the component.
* @param props.address - The address to display. This should be a valid CAIP-10 address.
* @param props.size - The size of the avatar. Can be `sm`, `md`, or `lg`. Defaults to `md`.
* @returns An avatar element.
* @example
* <Avatar address="eip155:1:0x1234567890123456789012345678901234567890" />
Expand Down
Loading