Skip to main content

Badge

A small inline label for statuses, counts, or short pieces of metadata.

Installation​

npm install @sipe-team/badge
import '@sipe-team/badge/styles.css';

Usage​

Wrap the text you want to label. The badge sizes itself to its content.

Sipe

Examples​

Variant​

filled (default) is the solid emphasis look; outline keeps only a border for a lighter touch; weak uses a muted neutral background.

filled
outline
weak

Size​

medium (default) suits most inline uses; step up to large for emphasis, down to small for dense layouts. The text size scales with the badge (12 / 14 / 18 px).

small
medium
large

Anatomy​

import { Badge } from '@sipe-team/badge';

export default () => <Badge size="medium" variant="filled">New</Badge>;

Renders a <div role="status"> wrapping the children in a Typography <span>.

API Reference​

Renders a <div> and forwards its ref.

PropTypeDefaultDescription
childrenReactNode—The badge's content, rendered as text.
size'small' | 'medium' | 'large''medium'Padding and text size.
variant'filled' | 'outline' | 'weak''filled'Visual emphasis.

Also accepts every ComponentProps<'div'> (className, onClick, …), forwarded to the rendered <div>. The <div> carries role="status", so screen readers announce its content as a live status message.