DocSpace-client/packages/components/avatar
2023-10-05 15:47:29 +03:00
..
svg Web:Common/Client/Components: add PUBLIC_DIR alias 2023-01-27 17:08:30 +03:00
avatar.stories.js figma links were added 2023-07-03 13:31:26 +05:00
avatar.test.js Web: Moved all clients app to packages directory 2022-07-22 22:01:25 +03:00
index.js Web: Files: PublicRoom: added primary link 2023-10-05 15:47:29 +03:00
README.md Web: Moved all clients app to packages directory 2022-07-22 22:01:25 +03:00
styled-avatar.js Web: Components: Remove unnecessary defaultProps expanding 2023-07-11 13:57:11 +02:00

Avatar

Used to display an avatar or brand.

Usage

import Avatar from "@docspace/components/avatar";
<Avatar size="max" role="admin" source="" userName="" editing={false} />

If you want to create an avatar with initials, only first letter of first two words of line is used.

Properties

Props Type Required Values Default Description
size oneOf - max, big, medium, small, min medium Size of avatar
role oneOf - owner, admin, guest, user user Adds a user role table
source string - - - The address of the image for an image avatar
isIcon bool - - false Set true if .svg is provided as source prop
userName string - - - Need to create an avatar with initials
editing bool - - false Displays avatar edit layer
editLabel string - - Edit photo Label for editing layer
editAction func - - - Function called when the avatar change button is pressed
className string - - - Accepts class
id string - - - Accepts id
style obj, array - - - Accepts css style