Badge#

A badge can be commonly used as a notification or number indicator.

Import#

import { Badge } from 'bumbag';

Usage#

Editable example

<Badge>
  1
</Badge>

<Badge>
  1
</Badge>

No content#

Editable example

<Badge />

<Badge />

Colors#

Editable example

<Set spacing="minor-1">
  <Badge palette="primary">12</Badge>
  <Badge palette="secondary">12</Badge>
  <Badge palette="info">12</Badge>
  <Badge palette="success">12</Badge>
  <Badge palette="warning">12</Badge>
  <Badge palette="danger">12</Badge>
</Set>

<Set spacing="minor-1">
  <Badge palette="primary">12</Badge>
  <Badge palette="secondary">12</Badge>
  <Badge palette="info">12</Badge>
  <Badge palette="success">12</Badge>
  <Badge palette="warning">12</Badge>
  <Badge palette="danger">12</Badge>
</Set>

Sizes#

Editable example

<Set spacing="minor-1">
  <Badge>
    1
  </Badge>
  <Badge size="medium">
    1
  </Badge>
  <Badge size="large">
    1
  </Badge>
</Set>

<Set spacing="minor-1">
  <Badge>
    1
  </Badge>
  <Badge size="medium">
    1
  </Badge>
  <Badge size="large">
    1
  </Badge>
</Set>

Attachment#

You can attach a badge onto a component by providing it as a child of the component.

Hello world

Editable example

<Button>
  Hello world
  <Badge isAttached palette="danger" />
</Button>
<Button size="large" marginLeft="major-2">
  Hello world
  <Badge isAttached palette="danger" size="large">1</Badge>
</Button>
<Box backgroundColor="primary" color="white" marginTop="major-2">
  Hello world
  <Badge isAttached palette="danger">1</Badge>
</Box>

<Button>
  Hello world
  <Badge isAttached palette="danger" />
</Button>
<Button size="large" marginLeft="major-2">
  Hello world
  <Badge isAttached palette="danger" size="large">1</Badge>
</Button>
<Box backgroundColor="primary" color="white" marginTop="major-2">
  Hello world
  <Badge isAttached palette="danger">1</Badge>
</Box>

Props#

Badge Props#

isAttached boolean

Indicates if the badge is attached to it's parent.

palette

"default"
  | "primary"
  | "secondary"
  | "success"
  | "danger"
  | "warning"
  | (string & {})

The color of the badge.

size

"default"
  | (string & {})
  | "small"
  | "medium"
  | "large"

The size of the badge.

Inherits Box props

use

string
  | (ComponentClass<any, any> & { useProps: any; })
  | (FunctionComponent<any> & { useProps: any; })

className string

children

string
  | number
  | boolean
  | {}
  | ReactElement<any, string
  | ((props: any) => ReactElement<any, string
  | ...
  | (new (props: any) => Component<any, any, any>)>)
  | (new (props: any) => Component<...>)>
  | ReactNodeArray
  | ReactPortal
  | ((props: BoxProps) => ReactNode)

alignX "right" | "left" | "center"

alignY "top" | "bottom" | "center"

variant string

colorMode string

disabled boolean

overrides

{
  useCSSVariables?: boolean;
  altitudes?: AltitudesThemeConfig;
  borders?: BordersThemeConfig;
  borderRadii?: BorderRadiiThemeConfig;
  ... 95 more ...;
  Template?: TemplateThemeConfig;
}

elementRef ((instance: any) => void) | RefObject<any>

themeKey string

Theming#

Badge.styles.base

Badge.styles.sizes.default

Badge.styles.sizes.medium

Badge.styles.sizes.large

On this page