Alpha

Badge

Small informational badges for displaying labels, statuses, and categories.

Preview

Status

color

variant

size

isDisabled

1<e>
2  Status
3</e>

Anatomy

1<Badge></Badge>

Installation

Note
Please ensure your local environment is fully configured as instructed in the getting started guide.
npm install @rootui/badge

Usage

1import { Badge } from "@rootui/badge";
2
3export default function Page() {
4  return (
5    <Badge>status</Badge>
6  )
7}

API Reference

Badge

Prop

Type

Default

color
'neutral' | 'primary' | 'secondary' |
'info' | 'success' | 'warning' |
'danger' | 'magic'
'neutral'

The color of the badge.

variant
'filled' | 'outlined' | 'subtle' |
'transparent'
'filled'

The visual style of the badge.

size
'sm' | 'md' | 'lg'
'md'

The size of the badge.

isDisabled
boolean
false

Whether the badge is disabled.