Skip to content

Commit 42637cb

Browse files
committed
[avatar] add deprecation note
1 parent d606fc9 commit 42637cb

File tree

1 file changed

+1
-10
lines changed

1 file changed

+1
-10
lines changed

src/lib/Avatar/Avatar.tsx

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,7 @@ const generateColor = (str: string) => {
4949
return pastelColors[index];
5050
};
5151

52-
/**
53-
* A stylized Avatar component for displaying user avatars.
54-
* This component supports displaying an image avatar or a fallback avatar with initials.
55-
* The fallback avatar is a colored circle with the user's initials.
56-
*
57-
* @param imgElement - An optional image element to use as the avatar.
58-
* @param name - The name of the user. Used to generate initials for the fallback avatar.
59-
* @param size - The size of the avatar in pixels.
60-
* @param round - The border-radius of the avatar in pixels. Use this to make the avatar round.
61-
*/
52+
/** @deprecated */
6253
export const Avatar = ({
6354
imgElement,
6455
name,

0 commit comments

Comments
 (0)