Skip to main content

Announcement

Show a badge & a short message in one pill, such as news above a heading.

View as Markdown

Installation

Component API

PropTypeDefaultDescription
childrenReactNode-The message beside the badge.
The message beside the badge.
labelstring-The badge's word, such as "New".
The badge's word, such as "New".
hrefstring-
solidbooleanfalseA solid badge in place of the tinted one, for news that leads a page.
A solid badge in place of the tinted one, for news that leads a page.
dotbooleanfalseA dot in the badge, before its word.
A dot in the badge, before its word.
badgePositionleading | trailingleadingWhich end the badge sits at.
Which end the badge sits at.
arrowbooleantrue
intentneutral | info | success | warning | dangerinfoWhat the news means, which tints the badge.
What the news means, which tints the badge.
sizesm | md | lgmdPadding and text size, the badge's with it.
Padding and text size, the badge's with it.
shapenone | rounded | pillrounded
classNamestring-
focusboolean | stringtrue