Avatar

Display an image that represents a user with a text fallback.

Import

Import the Avatar primitives from ng-primitives/avatar.

import { NgpAvatar, NgpAvatarImage, NgpAvatarFallback } from 'ng-primitives/avatar';

Usage

Assemble the avatar directives in your template.

<span ngpAvatar>
  <img ngpAvatarImage src="..." alt="..." />
  <span ngpAvatarFallback>NG</span>
</span>

Reusable Component

Create a reusable component that uses the NgpAvatar directive.

Schematics

Generate a reusable avatar component using the Angular CLI.

ng g ng-primitives:primitive avatar

Options

• path: The path at which to create the component file.
• prefix: The prefix to apply to the generated component selector.
• componentSuffix: The suffix to apply to the generated component class name.
• fileSuffix: The suffix to apply to the generated component file name. Defaults to component.
• exampleStyles: Whether to include example styles in the generated component file. Defaults to true.

API Reference

The following directives are available to import from the ng-primitives/avatar package:

NgpAvatar

Data Attributes

Attribute	Description	Value
data-status	The loading status of the avatar image.	idle | loading | loaded | error

NgpAvatarImage

NgpAvatarFallback

Global Configuration

You can configure the default options for all avatars in your application by using the provideAvatarConfig function in a providers array.

import { provideAvatarConfig } from 'ng-primitives/avatar';

bootstrapApplication(AppComponent, {
  providers: [provideAvatarConfig({ delay: 1000 })],
});

NgpAvatarConfig

Define a delay before the fallback is shown. This is useful to only show the fallback for those with slower connections.