Skip to main content

Pathfinder v1.4is here!Now supporting multiple documentation tabs with their own sidebars.Learn more

Badge

The Badge component is a versatile element for displaying labels, status indicators, or metadata. It comes with various styles and sizes to suit different use cases.

Basic Usage

The Badge component requires one prop:

  • text: The content to display inside the badge

Variants

The Badge component comes with five different variants to convey different types of information:

Sizes

The Badge component supports three different sizes through the optional size prop:

Props

Prop Type Default Required Description
text string - Yes The text content to display inside the badge
variant "note" | "tip" | "caution" | "danger" | "info" "note" No The style variant to use
size "sm" | "md" | "lg" "sm" No The size of the badge