Documentation

Avatar

An image element with a fallback for representing the user.

Examples

AvatarJD
AvatarAvatarAvatar+2
import { Avatar } from 'kalki-design'

<Avatar>Click me</Avatar>

Installation

npx kalki-design add avatar

Usage

import { Avatar } from 'kalki-design'

export default function Example() {
  return <Avatar />
}

API Reference

NameTypeDefaultDescription
NamesrcTypestringDefaultDescriptionThe image source URL.
NamealtTypestringDefault'Avatar'DescriptionAlternative screen reader text.
NameinitialsTypestringDefaultDescriptionInitials to show if the image is missing.
NamesizeType'xs' | 'sm' | 'md' | 'lg' | 'xl'Default'md'DescriptionSize of the avatar.
NameshapeType'circle' | 'square'Default'circle'DescriptionShape of the avatar.
NamestatusType'online' | 'offline' | 'away' | 'busy' | 'none'DefaultDescriptionAn optional status indicator bubble.