1.3.0 • Published 5 months ago

@illa-design/avatar v1.3.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
5 months ago

Avatar

The Avatar component is used to represent a user and displays the pictures, text or icon.

Installation

yarn add @illa-design/avatar

Import component

import { Avatar } from "@illa-design/avatar"

API

Avatar Basic Properties

PropsDescTypeDefault
colorSchemeColor of avatar"white" | "blackAlpha" | "gray" | "grayBlue" | "red" | "orange" | "yellow" |"green" |"blue" |"cyan" |"purple""gray"
srcThe image url of avatarstring | string[]-
sizeSize of the avatar"small" | "medium" | "large""small"
textThe displayed text of the avatar when src is not loadedstring | string[]-
shapeThe shape of avatar"circle" | "square""circle"
iconThe default avatar when text and src is not specifiedReactNode-

Avatar-group Basic Properties

PropsDescTypeDefault
colorSchemeColor of avatar group"white" | "blackAlpha" | "gray" | "grayBlue" | "red" | "orange" | "yellow" | "green" | "blue" | "cyan" | "purple""gray"
sizeSize of avatar group"small" | "medium" | "large""small"
maxCountThe max count of avatar groupnumber-
zIndexAscendThe avatars are z-index ascend or notbooleanfalse

Avatar Events

PropsDescTypeDefault
onClickCallback when click the avatar() => void-

Example

import Sandpack from '@site/src/components/Sandpack'

export const code = `
    <>
      <Avatar />
      <Avatar size="small">Small</Avatar>
      <Avatar shape="square" colorScheme="red">Small</Avatar>
      <Avatar src='https://bit.ly/dan-abramov' />
      <Avatar text="e" />
    </>`

export const importStatement = `import { Avatar } from '@illa-design/avatar'`

export const packages = {"@illa-design/avatar":"latest"}

<Sandpack code={code} packages={packages} importStatement={importStatement} template="react-ts"/>

Basic usage

<Avatar />

Set Avatar's size

<Avatar size="small">Small</Avatar>

Set Avatar's shape and color

<Avatar shape="saqure" colorScheme="red">Small</Avatar>

Set Avatar's icon

<Avatar icon={<CloseIcon />} />

Set Avatar's image

<Avatar src='https://bit.ly/dan-abramov' />

Set Avatar's text

<Avatar text="e" />

Set Avatar-group's max count

      <AvatarGroup maxCount={2}>
        <Avatar text="I" />
        <Avatar text="L" />
        <Avatar text="L" />
        <Avatar text="A" /> 
      </AvatarGroup>
1.2.0

5 months ago

1.3.0

5 months ago

1.0.29

10 months ago

1.0.28

10 months ago

1.0.27

11 months ago

1.0.30

9 months ago

1.1.0

8 months ago

1.0.22

1 year ago

1.0.21

1 year ago

1.0.26

12 months ago

1.0.25

12 months ago

1.0.24

1 year ago

1.0.23

1 year ago

1.0.19

1 year ago

1.0.18

1 year ago

1.0.17

1 year ago

1.0.20

1 year ago

1.0.16

1 year ago

1.0.15

1 year ago

1.0.14

1 year ago

1.0.9

1 year ago

1.0.8

1 year ago

1.0.7

1 year ago

1.0.6

2 years ago

1.0.11

1 year ago

1.0.10

1 year ago

1.0.13

1 year ago

1.0.12

1 year ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

0.0.10

2 years ago

0.0.11

2 years ago

0.0.12

2 years ago

0.0.13

2 years ago

0.0.14

2 years ago

0.0.15

2 years ago

0.0.9

2 years ago

0.0.16

2 years ago

0.0.17

2 years ago

0.0.8

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.1

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1-alpha.0

2 years ago