Skip to content

Badge

⚠️ This documentation file needs to be reviewed ⚠️, but the component is ready to use.

Basic Usage

To implement the Badge component, you need to import it first:

import { Badge } from '@react-ui-org/react-ui';

And use it:

<Badge label="Hello!" />

See API for all available options.

General Guidelines

Use badges to highlight content with a short and brief additional information: a number, a word, but no more than two words.

Priorities

There are two visual priorities of badges to choose from, from highest to lowest:

  1. filled
  2. outline

All priorities come in supported component colors.

Filled

High-emphasis priority to draw user's attention.

<Badge label="3" color="success" />
<Badge label="4" color="warning" />
<Badge label="5" color="danger" />
<Badge label="10" color="help" />
<Badge label="34" color="info" />
<Badge label="99+" />
<docoff-placeholder dark inline>
    <Badge label="365" color="light" />
</docoff-placeholder>
<Badge label="999+" color="dark" />
<Badge label="Success" color="success" />
<Badge label="Warning" color="warning" />
<Badge label="Danger" color="danger" />
<Badge label="Help" color="help" />
<Badge label="Info" color="info" />
<Badge label="Note" />
<docoff-placeholder dark inline>
    <Badge label="Light" color="light" />
</docoff-placeholder>
<Badge label="Dark" color="dark" />

Outline

Medium-emphasis priority to provide additional context in an unobtrusive way.

<Badge priority="outline" label="3" color="success" />
<Badge priority="outline" label="4" color="warning" />
<Badge priority="outline" label="5" color="danger" />
<Badge priority="outline" label="10" color="help" />
<Badge priority="outline" label="34" color="info" />
<Badge priority="outline" label="99+" />
<docoff-placeholder dark inline>
    <Badge priority="outline" label="365" color="light" />
</docoff-placeholder>
<Badge priority="outline" label="999+" color="dark" />
<Badge priority="outline" label="Success" color="success" />
<Badge priority="outline" label="Warning" color="warning" />
<Badge priority="outline" label="Danger" color="danger" />
<Badge priority="outline" label="Help" color="help" />
<Badge priority="outline" label="Info" color="info" />
<Badge priority="outline" label="Note" />
<docoff-placeholder dark inline>
    <Badge priority="outline" label="Light" color="light" />
</docoff-placeholder>
<Badge priority="outline" label="Dark" color="dark" />

Forwarding HTML Attributes

In addition to the options below in the component's API section, you can specify React synthetic events or any HTML attribute you like. All attributes that don't interfere with the API are forwarded to the root <div> HTML element. This enables making the component interactive and helps to improve its accessibility.

👉 Refer to the MDN reference for the full list of supported attributes of the div element.

API