Skip to content

Commit

Permalink
Add prop for Avatar inside jsdoc (#3037)
Browse files Browse the repository at this point in the history
The jsdoc for Avatar JSX component was missing a prop

---------

Co-authored-by: Frederik Bolding <frederik.bolding@gmail.com>
  • Loading branch information
Montoya and FrederikBolding authored Jan 28, 2025
1 parent 01ff383 commit c909011
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions packages/snaps-sdk/src/jsx/components/Avatar.ts
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

0 comments on commit c909011

Please sign in to comment.