Skip to Content
Documentation
Saas UI
Get Pro
Getting started
Components
Overview

Badge

Used to highlight an item's status for quick recognition.

SourceStorybookRecipe
DefaultSuccessRemovedNew

Anatomy

import { Badge } from '@saas-ui/react/badge'
<Badge>Badge</Badge>

Examples

Icon

Render an icon within the badge directly

NewNew

Variants

Badges come in different variants

OutlineSolidSubtleSurface
OutlineSolidSubtleSurface

Sizes

Badges come in different sizes

NewNewNewNew

Colors

Badges come in different colors

gray

NewNewNewNew

zinc

NewNewNewNew

neutral

NewNewNewNew

stone

NewNewNewNew

red

NewNewNewNew

orange

NewNewNewNew

amber

NewNewNewNew

yellow

NewNewNewNew

lime

NewNewNewNew

green

NewNewNewNew

emerald

NewNewNewNew

teal

NewNewNewNew

cyan

NewNewNewNew

sky

NewNewNewNew

blue

NewNewNewNew

indigo

NewNewNewNew

violet

NewNewNewNew

purple

NewNewNewNew

fuchsia

NewNewNewNew

pink

NewNewNewNew

rose

NewNewNewNew

Props

PropDefaultType
colorPalette 'gray'
'gray' | 'zinc' | 'neutral' | 'stone' | 'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'emerald' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'fuchsia' | 'pink' | 'rose' | 'presence' | 'status' | 'sidebar' | 'sidebar.accent' | 'accent' | 'slate'

The color palette of the component

variant 'subtle'
'solid' | 'subtle' | 'outline' | 'surface' | 'plain'

The variant of the component

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

The size of the component

Previous

Avatar

Next

Breadcrumb