Badges

Documentation and examples for badges, our small count and labeling component.

Examples

Badges scale to match the size of the immediate parent element by using relative font sizing and em units.

Result

Loading...

Live Editor

import Badge from 'react-bootstrap/Badge'; function BasicExample() { return ( <div> <h1> Example heading <Badge bg="secondary">New</Badge> </h1> <h2> Example heading <Badge bg="secondary">New</Badge> </h2> <h3> Example heading <Badge bg="secondary">New</Badge> </h3> <h4> Example heading <Badge bg="secondary">New</Badge> </h4> <h5> Example heading <Badge bg="secondary">New</Badge> </h5> <h6> Example heading <Badge bg="secondary">New</Badge> </h6> </div> ); } export default BasicExample;

import Badge from 'react-bootstrap/Badge';

function BasicExample() {
  return (
    <div>
      <h1>
        Example heading <Badge bg="secondary">New</Badge>
      </h1>
      <h2>
        Example heading <Badge bg="secondary">New</Badge>
      </h2>
      <h3>
        Example heading <Badge bg="secondary">New</Badge>
      </h3>
      <h4>
        Example heading <Badge bg="secondary">New</Badge>
      </h4>
      <h5>
        Example heading <Badge bg="secondary">New</Badge>
      </h5>
      <h6>
        Example heading <Badge bg="secondary">New</Badge>
      </h6>
    </div>
  );
}

export default BasicExample;

Badges can be used as part of links or buttons to provide a counter.

Result

Loading...

Live Editor

import Badge from 'react-bootstrap/Badge'; import Button from 'react-bootstrap/Button'; function ButtonExample() { return ( <Button variant="primary"> Profile <Badge bg="secondary">9</Badge> <span className="visually-hidden">unread messages</span> </Button> ); } export default ButtonExample;

import Badge from 'react-bootstrap/Badge';
import Button from 'react-bootstrap/Button';

function ButtonExample() {
  return (
    <Button variant="primary">
      Profile <Badge bg="secondary">9</Badge>
      <span className="visually-hidden">unread messages</span>
    </Button>
  );
}

export default ButtonExample;

Note that depending on how they are used, badges may be confusing for users of screen readers and similar assistive technologies. While the styling of badges provides a visual cue as to their purpose, these users will simply be presented with the content of the badge. Depending on the specific situation, these badges may seem like random additional words or numbers at the end of a sentence, link, or button. Unless the context is clear, consider including additional context with a visually hidden piece of additional text.

Contextual variations

Add any of the below mentioned modifier classes to change the appearance of a badge.

Result

Loading...

Live Editor

import Badge from 'react-bootstrap/Badge'; import Stack from 'react-bootstrap/Stack'; function VariationsExample() { return ( <Stack direction="horizontal" gap={2}> <Badge bg="primary">Primary</Badge> <Badge bg="secondary">Secondary</Badge> <Badge bg="success">Success</Badge> <Badge bg="danger">Danger</Badge> <Badge bg="warning" text="dark"> Warning </Badge> <Badge bg="info">Info</Badge> <Badge bg="light" text="dark"> Light </Badge> <Badge bg="dark">Dark</Badge> </Stack> ); } export default VariationsExample;

import Badge from 'react-bootstrap/Badge';
import Stack from 'react-bootstrap/Stack';

function VariationsExample() {
  return (
    <Stack direction="horizontal" gap={2}>
      <Badge bg="primary">Primary</Badge>
      <Badge bg="secondary">Secondary</Badge>
      <Badge bg="success">Success</Badge>
      <Badge bg="danger">Danger</Badge>
      <Badge bg="warning" text="dark">
        Warning
      </Badge>
      <Badge bg="info">Info</Badge>
      <Badge bg="light" text="dark">
        Light
      </Badge>
      <Badge bg="dark">Dark</Badge>
    </Stack>
  );
}

export default VariationsExample;

Pill badges

Use the pill modifier class to make badges more rounded (with a larger border-radius). Useful if you miss the badges from v3.

Result

Loading...

Live Editor

import Badge from 'react-bootstrap/Badge'; import Stack from 'react-bootstrap/Stack'; function PillExample() { return ( <Stack direction="horizontal" gap={2}> <Badge pill bg="primary"> Primary </Badge> <Badge pill bg="secondary"> Secondary </Badge> <Badge pill bg="success"> Success </Badge> <Badge pill bg="danger"> Danger </Badge> <Badge pill bg="warning" text="dark"> Warning </Badge> <Badge pill bg="info"> Info </Badge> <Badge pill bg="light" text="dark"> Light </Badge> <Badge pill bg="dark"> Dark </Badge> </Stack> ); } export default PillExample;

import Badge from 'react-bootstrap/Badge';
import Stack from 'react-bootstrap/Stack';

function PillExample() {
  return (
    <Stack direction="horizontal" gap={2}>
      <Badge pill bg="primary">
        Primary
      </Badge>
      <Badge pill bg="secondary">
        Secondary
      </Badge>
      <Badge pill bg="success">
        Success
      </Badge>
      <Badge pill bg="danger">
        Danger
      </Badge>
      <Badge pill bg="warning" text="dark">
        Warning
      </Badge>
      <Badge pill bg="info">
        Info
      </Badge>
      <Badge pill bg="light" text="dark">
        Light
      </Badge>
      <Badge pill bg="dark">
        Dark
      </Badge>
    </Stack>
  );
}

export default PillExample;

API

Badge