Badge

Display badge, pill or tag

Import

Source

View source code

Docs

Edit this page

Package

@mantine/core

Usage

Badge

Color

Size

Radius

Variant

import { Badge } from '@mantine/core';

function Demo() {
  return (
    <Badge>Badge</Badge>
  );
}

Gradient variant

To use gradient as Badge background:

set variant to gradient
set gradient to { from: 'color-from', to: 'color-to', deg: 135 }, where
- color-from and color-to are color from theme.colors
- deg is linear gradient deg

Indigo cyan

Lime green

Teal blue

Orange red

Peach

import { Badge } from '@mantine/core';

function Demo() {
  return (
    <>
      <Badge variant="gradient" gradient={{ from: 'indigo', to: 'cyan' }}>Indigo cyan</Badge>
      <Badge variant="gradient" gradient={{ from: 'teal', to: 'lime', deg: 105 }}>Lime green</Badge>
      <Badge variant="gradient" gradient={{ from: 'teal', to: 'blue', deg: 60 }}>Teal blue</Badge>
      <Badge variant="gradient" gradient={{ from: 'orange', to: 'red' }}>Orange red</Badge>
      <Badge variant="gradient" gradient={{ from: '#ed6ea0', to: '#ec8c69', deg: 35 }}>Peach</Badge>
    </>
  );
}

Full width and overflow

Badge will take full width of container if fullWidth prop is true. If badge cannot fit in its container, overflow content will be hidden with ellipsis:

Full width badge

Badge with overflow

import { Badge } from '@mantine/core';
function Demo() {
  return (
    <>
      <div style={{ width: 200 }}>
        <Badge variant="filled" fullWidth>
          Full width badge
        </Badge>
      </div>

      <div style={{ width: 120 }}>
        <Badge variant="filled" fullWidth>
          Badge with overflow
        </Badge>
      </div>
    </>
  );
}

Right and left sections

Badge with Avatar

Badge with right section

Badge with left section

import { ActionIcon, Avatar, Badge, Group } from '@mantine/core';
import { X } from 'tabler-icons-react';

function Demo() {
  const avatar = (
    <Avatar
      alt="Avatar for badge"
      size={24}
      mr={5}
      src="image-link"
    />
  );

  const removeButton = (
    <ActionIcon size="xs" color="blue" radius="xl" variant="transparent">
      <X size={10} />
    </ActionIcon>
  );

  return (
    <Group>
      <Badge sx={{ paddingLeft: 0 }} size="lg" radius="xl" color="teal" leftSection={avatar}>
        Badge with Avatar
      </Badge>

      <Badge variant="outline" sx={{ paddingRight: 3 }} rightSection={removeButton}>
        Badge with right section
      </Badge>

      <Badge variant="outline" sx={{ paddingLeft: 3 }} leftSection={removeButton}>
        Badge with left section
      </Badge>
    </Group>
  );
}

Custom component

To change badge root element pass React element to component prop:

Link badge

$$$ Get lots of money $$$

import { Badge } from '@mantine/core';

const CustomComponent = ({ pads, children, ...others }: { pads: string; children: React.ReactNode; }) => (
  <div {...others}>
    {pads} {children} {pads}
  </div>
);

function Demo() {
  return (
    <>
      <Badge component="a" href="https://mantine.dev" variant="outline">
        Link badge
      </Badge>

      <Badge component={CustomComponent} pads="$$$" variant="filled">
        Get lots of money
      </Badge>
    </>
  );
}

To use custom component with TypeScript provide type:

import { Badge } from '@mantine/core';
import { Link } from 'react-router-dom';

function Demo() {
  return (
    <>
      <Badge<'a'> component="a" href="#" />
      <Badge<typeof Link> component={Link} to="/hello" />
    </>
  );
}

Go back

Avatar – @mantine/core

Up next

Card – @mantine/core

Build fully functional accessible web applications faster than ever

About

Contribute Media assets Changelog Releases

Community

Chat on Discord Follow on Twitter Follow on Github GitHub discussions

Project

Mantine UI Documentation Github organization npm organization

Built by Vitaly Rtishchev and these awesome people

Join Discord community

Follow Mantine on Twitter