src/components/badge/Badge.ts:
class: Badge, btu-badge
Superclass
| Name | Module | Package |
|---|---|---|
LitElement | lit |
Mixins
| Name | Module | Package |
|---|---|---|
EventEmitterMixin | /src/utils/EventEmitterMixin.js |
Fields
| Name | Privacy | Type | Default | Description | Inherited 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 | ||
dot | boolean | false | Should a dot be displayed before the label? | ||
size | string | 'sm' | Size variant. - 'sm': Small (default) - 'md': Medium - 'lg': Large |
Events
| Name | Type | Description | Inherited From |
|---|---|---|---|
btu-badge-ready | CustomEvent | Fired after first render and initialization |
Attributes
| Name | Field | Inherited From |
|---|---|---|
variant | variant | |
dot | dot | |
size | size |
CSS Properties
| Name | Default | Description |
|---|---|---|
--badge-color-foreground | Text color (overrides theme color) | |
--badge-color-background | Background color (overrides theme color) | |
--badge-radius-size | Border radius size (overrides shape default, default: 999px) | |
--badge-px | Horizontal padding (overrides size default) | |
--badge-py | Vertical padding (overrides size default) | |
--badge-dot-size | Size of the dot affordance (default: 6px) |
Exports
| Kind | Name | Declaration | Module | Package |
|---|---|---|---|---|
js | default | Badge | src/components/badge/Badge.ts | |
custom-element-definition | btu-badge | Badge | src/components/badge/Badge.ts |