Skip to main content

src/components/avatar/Avatar.ts:

class: Avatar, btu-avatar

Superclass

NameModulePackage
LitElementlit

Mixins

NameModulePackage
EventEmitterMixin/src/util/EventEmitterMixin.js
ReadyMixin/src/util/ReadyMixin.js

Fields

NamePrivacyTypeDefaultDescriptionInherited From
srcstring''Image source URL
altstring''Alt text for the image
fallbackstring''Fallback text (typically user initials)
size'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl''md'Size variant. - 'xs': Extra small (1.5rem) - 'sm': Small (2.25rem) - 'md': Medium (2.5rem) - default - 'lg': Large (3rem) - 'xl': Extra large (3.5rem) - 'xxl': Extra extra large (4rem)

Events

NameTypeDescriptionInherited From
btu-avatar-readyCustomEventFired after first render and initialization
btu-avatar-image-loadedCustomEvent<{src: string}>Fired when image successfully loads
btu-avatar-image-errorCustomEvent<{src: string, error: Event}>Fired when image fails to load

Attributes

NameFieldInherited From
srcsrc
altalt
fallbackfallback
sizesize

CSS Properties

NameDefaultDescription
--avatar-sizeCustom size (overrides size prop)
--avatar-bg-colorFallback background color (default: purple-600)
--avatar-corner-roundingHow rounded is the avatar (default: circle)
--avatar-ring-colorOptional ring border color
--avatar-ring-widthRing border width (default: 2px)

Exports

KindNameDeclarationModulePackage
jsdefaultAvatarsrc/components/avatar/Avatar.ts
custom-element-definitionbtu-avatarAvatarsrc/components/avatar/Avatar.ts