Skip to main content

src/components/badge/Badge.ts:

class: Badge, btu-badge

Superclass

NameModulePackage
LitElementlit

Mixins

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