3.0.2 • Published 8 months ago

@licuido-ui/ui_avatar v3.0.2

Weekly downloads
-
License
MIT
Repository
-
Last release
8 months ago

Avatar

Avatars are found throughout material design with uses in everything from tables to dialog menus.

Author

Link

Story Book Link Avatar

PlayGround

Try it have a fun codeBox

Installation

npm i @licuido-ui/ui_avatar

Import component

import { Avatar } from '@licuido-ui/ui_avatar';
<Avatar
  avatarData={[]}
  fontSize=""
  />

Usage

<Avatar
  avatarData={[]}
  fontSize="14px"
  backgroundColor="#f0f0f0"
  dummyAvatarBackgroundColor='#CBCBCB'
  borderColor="#ccc"
  border="1px solid"
  height="50px"
  width="50px"
  max={3}
  handleAvatarGroupClick={(e) => console.log('Avatar Group Clicked!', e)}

Image

alt text

Props

Prop NameTypeDescription
classNamestringOverride class name for additional styling.
sxSxProps or SxProps[]System overrides and additional CSS styles.
avatarDataAvatarInterface[]An array of objects containing data for individual avatars (see AvatarInterface for details).
fontSizestringFont size of the avatars.
backgroundColorstringBackground color of the avatars.
avatarBackgroundColorstringBackground color of the dummy avatars.
borderColorstringBorder color of the avatars.
borderstringBorder style of the avatars.
heightstringHeight of the avatars.
widthstringWidth of the avatars.
variant'rounded' or 'square' or 'circular' or AvatarGroupPropsVariantOverridesVariant of the avatar (either 'rounded', 'square', 'circular', or an object for additional variant overrides).
maxnumberMaximum number of avatars to display in the AvatarGroup.
handleAvatarGroupClick(e: React.MouseEvent) => void | undefinedCallback function triggered on AvatarGroup click.