Skip to content

Badge

widgetsdisplay

Badge: a short inline label with a colored background

Installation

$ bunx termuijs add badge

Copies the source into src/components/badge/ and installs @termuijs/core, @termuijs/widgets.

Usage

ts
import { Badge } from '@termuijs/widgets'
ts
new Badge(text: string, style?: Partial<Style>, opts?: BadgeOptions)

API Reference

Badge

PropTypeRequiredDescription
textstringrequired
variantBadgeVariantoptionalVariant determines background color
#display#badge