Avatar
Avatar component with initials letter when have no image.
Install and import #
With image #
We use Shape component. You can use size from theme or override with w and h size.
Without image #
Without image we add initials on the avatar with property name. We get by default ramdom color from sub colors to create the background, based on the name string. You can override with color. Font size is calculated automatically and can be override with fontSizeproperty.
WJ
WJ
WJ
WJ
WJ
CU
With shape square #
By default Avatar is a circle shape, change with property shape.
WJ
Properties #
| Name | Type(s) | Default | Required |
|---|---|---|---|
| color | string | ||
| fontSize | string | number | ||
| getInitials | func | defaultGetInitials | |
| h | number | ||
| name | string | ||
| shape | circle square | circle | |
| size | sm md lg xl xxl | md | |
| src | string | ||
| w | number |
Dependencies #
- - @welcome-ui/box^3.0.0
- - @welcome-ui/shape^3.4.3
- - @welcome-ui/text^3.1.1
Peer dependencies #
- - @xstyled/styled-components^2.2.3
- - @xstyled/system^2.2.3
- - react^16.10.2 || ^17.0.1
- - react-dom^16.10.2 || ^17.0.1
- - styled-components^5.2.1