Skip to content
TrademarkTrademark
Docs
Components

Badge

Updated: October 25, 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.

Badge, Tag or Chip
Badge announces something, usually as a link: the "New" line above a hero. Tag is a static label for a status, category or piece of metadata. Chip is interactive: a choice that can be selected or removed, in filters and in TagInput. 3.0 plans to consolidate them.

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

By default a short brand-to-accent beam travels slowly round the badge's edge, and faster while it is hovered. It stops under reduced motion. Set effect to false for a static badge.

Custom content

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

Inside text

as="span" renders the badge, and its arrow, as spans that flow inline, so it can sit inside a paragraph without breaking the HTML.

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 beam that travels round the edge. 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