avatar

An image element with a fallback for representing the user.

PreviousNext
ZA ZA
import { Component } from '@angular/core';

import { ZardAvatarComponent } from '@/shared/components/avatar/avatar.component';

@Component({
  selector: 'z-demo-avatar-basic',
  imports: [ZardAvatarComponent],
  template: `
    <div class="mb-4 flex gap-3">
      <z-avatar zSrc="/images/avatar/imgs/avatar_image.jpg" zFallback="ZA" />
      <z-avatar zSrc="error-image.png" zFallback="ZA" />
    </div>
  `,
})
export class ZardDemoAvatarBasicComponent {}

Installation

Copy
npx zard-cli@latest add avatar

Usage

import { ZardAvatarComponent } from '@/shared/components/avatar/avatar.component';
Copy
<z-avatar zSrc="https://github.com/shadcn.png" zAlt="@shadcn"></z-avatar>
Copy

Examples

basic

ZA ZA
import { Component } from '@angular/core';

import { ZardAvatarComponent } from '@/shared/components/avatar/avatar.component';

@Component({
  selector: 'z-demo-avatar-basic',
  imports: [ZardAvatarComponent],
  template: `
    <div class="mb-4 flex gap-3">
      <z-avatar zSrc="/images/avatar/imgs/avatar_image.jpg" zFallback="ZA" />
      <z-avatar zSrc="error-image.png" zFallback="ZA" />
    </div>
  `,
})
export class ZardDemoAvatarBasicComponent {}

badge

Image
Image
import { Component } from '@angular/core';

import { provideIcons } from '@ng-icons/core';
import { lucidePlus } from '@ng-icons/lucide';

import { ZardAvatarComponent } from '@/shared/components/avatar/avatar.component';

@Component({
  selector: 'z-demo-avatar-badge',
  imports: [ZardAvatarComponent],
  template: `
    <div class="flex gap-3">
      <z-avatar
        [zShowBadge]="true"
        zSrc="/images/avatar/imgs/avatar_image.jpg"
        zAlt="Image"
        zBadgeClass="bg-green-600 dark:bg-green-800"
      />
      <z-avatar
        class="grayscale"
        [zShowBadge]="true"
        zSrc="/images/avatar/imgs/avatar_image.jpg"
        zAlt="Image"
        zBadgeIcon="lucidePlus"
      />
    </div>
  `,
  viewProviders: [provideIcons({ lucidePlus })],
})
export class ZardDemoAvatarBadgeComponent {}

group

JD SA LU JD SA LU
import { Component } from '@angular/core';

import { ZardAvatarGroupComponent } from '@/shared/components/avatar/avatar-group.component';
import { ZardAvatarComponent } from '@/shared/components/avatar/avatar.component';

@Component({
  selector: 'z-demo-avatar-group',
  imports: [ZardAvatarComponent, ZardAvatarGroupComponent],
  template: `
    <div class="flex flex-col gap-4">
      <z-avatar-group class="grayscale">
        <z-avatar zSrc="/images/avatar/imgs/avatar_image.jpg" zFallback="JD" />
        <z-avatar zSrc="https://github.com/srizzon.png" zFallback="SA" />
        <z-avatar zSrc="https://github.com/Luizgomess.png" zFallback="LU" />
      </z-avatar-group>

      <z-avatar-group zOrientation="vertical" class="grayscale">
        <z-avatar zSrc="/images/avatar/imgs/avatar_image.jpg" zFallback="JD" />
        <z-avatar zSrc="https://github.com/srizzon.png" zFallback="SA" />
        <z-avatar zSrc="https://github.com/Luizgomess.png" zFallback="LU" />
      </z-avatar-group>
    </div>
  `,
})
export class ZardDemoAvatarGroupComponent {}

API Reference

z-avatarComponent

An image element with a fallback for representing the user.

PropertyDescriptionTypeDefault
[class] Additional CSS classes string ''
[zAlt] Image alt text for accessibility string ''
[zFallback] Fallback text displayed while loading or on error string ''
[zPriority] Should image load with high priority boolean false
[zSize] Avatar size variant 'sm' | 'default' | 'lg' 'default'
[zSrc] Image source URL string | SafeUrl ''
[zShowBadge] Show avatar badge boolean false
[zBadgeClass] Additional avatar badge classes ClassValue ''
[zBadgeIcon] Avatar badge icon string ''

z-avatar-groupComponent

A group container for displaying multiple avatars.

PropertyDescriptionTypeDefault
[zOrientation] Layout direction of avatars 'horizontal' | 'vertical' 'horizontal'
[class] Additional CSS classes string ''
github iconwhatsapp icondiscord iconX icon

Made with in Brazil. Open source and available on GitHub .