oc · docs
docs / documentation

@orangecheck/design


@orangecheck/design / IconBadge

Function: IconBadge()

function IconBadge(__namedParameters: IconBadgeProps): any;

Defined in: primitives/icon-badge.tsx:53

IconBadge — a rounded-square tile holding a lucide icon OR a number/short label. The theme's most-reused decorative atom (feature-card icons, numbered steps, the verified chip). Distinct from the text Badge pill: this is a fixed-size square tile. Tones map to skin tokens so the same markup recolours across skins and light/dark (peach ↔ warm-dark).

<IconBadge tone="peach"><Lock /></IconBadge> <IconBadge tone="onBrand" size="sm">1</IconBadge>

Parameters

ParameterType
__namedParametersIconBadgeProps

Returns

any