Skip to main content
Version: 1.1.0

src/components/avatar/Avatar.ts:

class: Avatar, btu-avatar

Superclass

NameModulePackage
LitElementlit

Mixins

NameModulePackage
EventEmitterMixin/src/utils/EventEmitterMixin.js
ReadyMixin/src/utils/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

src/components/avatar/AvatarGroup.ts:

class: AvatarGroup, btu-avatar-group

Superclass

NameModulePackage
LitElementlit

Mixins

NameModulePackage
EventEmitterMixin/src/utils/EventEmitterMixin.js
ReadyMixin/src/utils/ReadyMixin.js

Fields

NamePrivacyTypeDefaultDescriptionInherited From
maxnumber | undefinedMaximum number of visible avatars. Remaining avatars shown as "+N"
size'xs' | 'sm' | 'md''md'Size variant for all child avatars (unless individually overridden)

Methods

NamePrivacyDescriptionParametersReturnInherited From
processAvatarsProcess all avatar children: apply size, handle overflow Call this method when avatars are dynamically added or removedvoid

Events

NameTypeDescriptionInherited From
btu-avatar-group-readyCustomEventFired after first render and initialization
btu-avatar-group-overflowCustomEvent<{hidden: number}>Fired when avatars are hidden due to max limit

Attributes

NameFieldInherited From
maxmax
sizesize

Exports

KindNameDeclarationModulePackage
jsdefaultAvatarGroupsrc/components/avatar/AvatarGroup.ts
custom-element-definitionbtu-avatar-groupAvatarGroupsrc/components/avatar/AvatarGroup.ts

src/components/badge/Badge.ts:

class: Badge, btu-badge

Superclass

NameModulePackage
LitElementlit

Mixins

NameModulePackage
EventEmitterMixin/src/utils/EventEmitterMixin.js
ReadyMixin/src/utils/ReadyMixin.js

Fields

NamePrivacyTypeDefaultDescriptionInherited From
variant'info' | 'primary' | 'error' | 'success' | 'warning''info'Style of the badge. - 'info': Informational (default) - 'primary': Primary action or emphasis - 'error': Error or danger state - 'success': Success or completion state - 'warning': Warning or caution state
dotbooleanfalseShould a dot be displayed before the label?
sizestring'sm'Size variant. - 'sm': Small (default) - 'md': Medium - 'lg': Large

Events

NameTypeDescriptionInherited From
btu-badge-readyCustomEventFired after first render and initialization

Attributes

NameFieldInherited From
variantvariant
dotdot
sizesize

CSS Properties

NameDefaultDescription
--badge-color-foregroundText color (overrides theme color)
--badge-color-backgroundBackground color (overrides theme color)
--badge-radius-sizeBorder radius size (overrides shape default, default: 999px)
--badge-pxHorizontal padding (overrides size default)
--badge-pyVertical padding (overrides size default)
--badge-dot-sizeSize of the dot affordance (default: 6px)

Exports

KindNameDeclarationModulePackage
jsdefaultBadgesrc/components/badge/Badge.ts
custom-element-definitionbtu-badgeBadgesrc/components/badge/Badge.ts