Skip to Content
DocumentationBadge

Badge

Displays a badge or a component that looks like a badge.

Examples

Regular

LabelLabel0WK

Freemium

LabelLabel099

Error

LabelLabel099

Warning

LabelLabel099

Sizes

LabelLabelLabelLabel

Animation

ShineWith Icon

API

PropertyTypeDefaultDescription
variant”regular” | “freemium” | “error""regular”Visual style of the badge.
size”sm” | “md” | “lg” | “xl""md”Controls the height, padding and font size.
iconReact.ReactNode-Optional left icon (e.g. from @medway-ui/icons).
animation”shine”-Adds a shine animation effect that sweeps from left to right.
asChildbooleanfalseRenders the badge as a child element using Slot.
classNamestring-Custom CSS classes.
…propsReact.ComponentProps<“span”>-All native span props are supported.
Last updated on