@styloviz/avatar

User avatar with initials fallback, status indicator, size and shape variants.

Part of the Styloviz UI Kit — a premium Angular 21 + Tailwind CSS 4 dashboard component library. Standalone, OnPush, strongly typed, dark-mode ready.

Installation

npm install @styloviz/avatar

Requires @angular/core and @angular/common >= 21. Self-contained — no other Styloviz packages required. Prefer everything at once? @styloviz/all installs the whole free tier in one command.

Usage

import { SvAvatarComponent } from '@styloviz/avatar';

@Component({
  standalone: true,
  imports: [SvAvatarComponent],
  template: `
    <sv-avatar name="Alex Johnson" status="online" size="md" />
  `,
})
export class DemoComponent {}

Inputs

| Input | Type | Default | Description | | --- | --- | --- | --- | | src | string | '' | URL of the avatar image. When blank or broken, falls back to initials/icon. | | name | string | '' | Full name — used to generate initials and auto-assign a palette color. | | alt | string | '' | Alt text for the image; falls back to name. | | size | AvatarSize | 'md' | Avatar size. | | shape | AvatarShape | 'circle' | Border-radius style. | | status | AvatarStatus | 'none' | Presence status indicator rendered as a small dot. Set to 'none' to hide it entirely. | | color | AvatarColor | 'auto' | Color palette for the initials background. 'auto' derives a consistent hue from the name string. | | verified | boolean | false | Show a verified checkmark badge in the bottom-right corner. Overridden by badgeCount when that is > 0. | | badgeCount | number | 0 | Notification count shown in the top-right corner. Set to 0 to hide. | | badgeMax | number | 9 | Cap for the badge count display (e.g. 9 → shows "9+"). | | customClass | string | '' | Additional CSS classes merged onto the root wrapper. | | clickable | boolean | false | Makes the avatar interactive (adds cursor-pointer, hover/focus styles, and emits avatarClick). |

Outputs

| Output | Type | Description | | --- | --- | --- | | avatarClick | Event | Emitted when the avatar is activated (click or keyboard) and clickable is true. |

Documentation

Full API reference and live demos: https://styloviz.dev/docs/avatar

License

MIT