TrademarkTrademark
Docs
Ctrl k
Search docs...
Components

Badge

Updated: October 11, 2026
View on GitHub

A versatile component for displaying highlighted information, labels, or interactive elements in a pill-shaped container. Commonly used to draw attention to important information or provide interactive links.

Icon

Add icons to badges to enhance visual communication.

Badges can be made interactive by adding the href prop, turning them into links.

Arrow

Badges can be displayed without the arrow indicator by setting the arrow prop to false. If using multiple badges on a page, add custom id to each badge to ensure the arrow gets rendered.

Effect

Disable the hover animation effect by setting the effect prop to false.

Custom content

Badges can contain custom content using children instead of the title prop.

API reference

Type
Default
title
The label. Use this or children, not both — they render the same text twice.
string—
icon
Icon before the label.
IconName—
arrow
Trailing arrow. On by default once href is set.
booleanhref ? true : false
children
React.ReactNode—
href
Makes it a link.
string—
effect
The shine that runs across it. Turn it off for a static badge.
booleantrue
className
string—
style
React.CSSProperties—
id
Element id.
string—
…and every FlexProps propinherited—
Edit this page on GitHub
TrademarkTrademark
Built with curiosity by Lorant One and the Design Engineers Club