Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcAvatarComponent

An avatar component is used as a representation of a user identity typically in a user profile.

Element

igc-avatar

Slot

  • Renders an icon inside the default slot.

Csspart

base - The base wrapper of the avatar.

Csspart

initials - The initials wrapper of the avatar.

Csspart

image - The image wrapper of the avatar.

Csspart

icon - The icon wrapper of the avatar.

Hierarchy

  • SizableInterface<this> & LitElement<this>
    • IgcAvatarComponent

Constructors

constructor

Properties

alt initials shape size src styles tagName

Methods

register

Constructors

constructor

Properties

alt

alt: string

Alternative text for the image.

Attr

initials

initials: string

Initials to use as a fallback when no image is available.

Attr

shape

shape: "square" | "circle" | "rounded" = 'square'

The shape of the avatar.

Attr

size

size: "small" | "medium" | "large"

Determines the size of the component.

Attr

Deprecated

  • since v4.5.0. Use the --ig-size CSS custom property instead.

src

src: string

The image source to use.

Attr

Static styles

styles: CSSResult = styles

Static Readonly tagName

tagName: "igc-avatar" = 'igc-avatar'

Methods

Static register