Badge
<wa-badge>
Badges are used to draw attention and display statuses or counts.
<wa-badge>Badge</wa-badge>
Examples
Jump to heading
Variants
Jump to heading
Set the variant attribute to change the badge's variant.
<wa-badge variant="brand">Brand</wa-badge> <wa-badge variant="success">Success</wa-badge> <wa-badge variant="neutral">Neutral</wa-badge> <wa-badge variant="warning">Warning</wa-badge> <wa-badge variant="danger">Danger</wa-badge> <wa-badge variant="info">Info</wa-badge>
Appearance
Jump to heading
Use the appearance attribute to change the badge's visual appearance.
<div style="margin-block-end: 1rem;"> <wa-badge appearance="accent" variant="neutral">Accent</wa-badge> <wa-badge appearance="filled-outlined" variant="neutral">Filled-Outlined</wa-badge> <wa-badge appearance="filled" variant="neutral">Filled</wa-badge> <wa-badge appearance="outlined" variant="neutral">Outlined</wa-badge> </div> <div style="margin-block-end: 1rem;"> <wa-badge appearance="accent" variant="brand">Accent</wa-badge> <wa-badge appearance="filled-outlined" variant="brand">Filled-Outlined</wa-badge> <wa-badge appearance="filled" variant="brand">Filled</wa-badge> <wa-badge appearance="outlined" variant="brand">Outlined</wa-badge> </div> <div style="margin-block-end: 1rem;"> <wa-badge appearance="accent" variant="success">Accent</wa-badge> <wa-badge appearance="filled-outlined" variant="success">Filled-Outlined</wa-badge> <wa-badge appearance="filled" variant="success">Filled</wa-badge> <wa-badge appearance="outlined" variant="success">Outlined</wa-badge> </div> <div style="margin-block-end: 1rem;"> <wa-badge appearance="accent" variant="warning">Accent</wa-badge> <wa-badge appearance="filled-outlined" variant="warning">Filled-Outlined</wa-badge> <wa-badge appearance="filled" variant="warning">Filled</wa-badge> <wa-badge appearance="outlined" variant="warning">Outlined</wa-badge> </div> <div style="margin-block-end: 1rem;"> <wa-badge appearance="accent" variant="danger">Accent</wa-badge> <wa-badge appearance="filled-outlined" variant="danger">Filled-Outlined</wa-badge> <wa-badge appearance="filled" variant="danger">Filled</wa-badge> <wa-badge appearance="outlined" variant="danger">Outlined</wa-badge> </div> <div> <wa-badge appearance="accent" variant="info">Accent</wa-badge> <wa-badge appearance="filled-outlined" variant="info">Filled-Outlined</wa-badge> <wa-badge appearance="filled" variant="info">Filled</wa-badge> <wa-badge appearance="outlined" variant="info">Outlined</wa-badge> </div>
Size
Jump to heading
Badges are sized relative to the current font size. You can set font-size on any badge (or an ancestor element) to change it.
<wa-badge variant="brand" style="font-size: var(--wa-font-size-xs);">Brand</wa-badge> <wa-badge variant="brand" style="font-size: var(--wa-font-size-s);">Brand</wa-badge> <wa-badge variant="brand" style="font-size: var(--wa-font-size-m);">Brand</wa-badge> <wa-badge variant="brand" style="font-size: var(--wa-font-size-l);">Brand</wa-badge> <wa-badge variant="brand" style="font-size: var(--wa-font-size-xl);">Brand</wa-badge>
Pill Badges
Jump to heading
Use the pill attribute to give badges rounded edges.
<wa-badge variant="brand" pill>Brand</wa-badge> <wa-badge variant="success" pill>Success</wa-badge> <wa-badge variant="neutral" pill>Neutral</wa-badge> <wa-badge variant="warning" pill>Warning</wa-badge> <wa-badge variant="danger" pill>Danger</wa-badge> <wa-badge variant="info" pill>Info</wa-badge>
Drawing Attention
Jump to heading
Use the attention attribute to draw attention to the badge with a subtle animation. Supported effects are bounce, pulse and none.
<div class="badge-attention"> <wa-badge variant="brand" attention="pulse" pill>1</wa-badge> <wa-badge variant="success" attention="pulse" pill>1</wa-badge> <wa-badge variant="neutral" attention="pulse" pill>1</wa-badge> <wa-badge variant="warning" attention="pulse" pill>1</wa-badge> <wa-badge variant="danger" attention="pulse" pill>1</wa-badge> <wa-badge variant="info" attention="pulse" pill>1</wa-badge> </div> <div class="badge-attention"> <wa-badge variant="brand" attention="bounce" pill>1</wa-badge> <wa-badge variant="success" attention="bounce" pill>1</wa-badge> <wa-badge variant="neutral" attention="bounce" pill>1</wa-badge> <wa-badge variant="warning" attention="bounce" pill>1</wa-badge> <wa-badge variant="danger" attention="bounce" pill>1</wa-badge> <wa-badge variant="info" attention="bounce" pill>1</wa-badge> </div> <style> .badge-attention { margin-block-end: var(--wa-space-m); wa-badge:not(:last-of-type) { margin-right: 1rem; } } </style>
Start & End Decorations
Jump to heading
Use the start and end slots to add presentational elements like <wa-icon> alongside the badge's label.
<wa-badge> <wa-icon slot="start" name="seedling"></wa-icon> Start </wa-badge> <wa-badge> <wa-icon slot="end" name="tree"></wa-icon> End </wa-badge> <wa-badge> <wa-icon slot="start" name="cow"></wa-icon> <wa-icon slot="end" name="meteor"></wa-icon> Both </wa-badge>
With Buttons
Jump to heading
One of the most common use cases for badges is attaching them to buttons. To make this easier, badges will be automatically positioned at the top-right when they're a child of a button.
<wa-button appearance="filled"> Requests <wa-badge pill>30</wa-badge> </wa-button> <wa-button appearance="filled" style="margin-inline-start: 1rem;"> Warnings <wa-badge variant="warning" pill>8</wa-badge> </wa-button> <wa-button appearance="filled" style="margin-inline-start: 1rem;"> Errors <wa-badge variant="danger" pill>6</wa-badge> </wa-button>
Importing
Jump to heading
If you're using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick a component manually, use one of the following snippets.
Import this component directly from the CDN:
import 'https://ka-f.webawesome.com/webawesome@0.14.0/components/badge/badge.js';
After installing Web Awesome via npm, import this component:
import '@awesome.me/webawesome/dist/components/badge/badge.js';
If you're self-hosting Web Awesome, import this component from your server:
import './webawesome/dist/components/badge/badge.js';
To import this component for React 18 or below, use the following code:
import WaBadge from '@awesome.me/webawesome/dist/react/badge/index.js';
Slots
Jump to heading
Learn more about using slots.
| Name | Description |
|---|---|
| (default) | The badge's content. |
end
|
An element, such as <wa-icon>, placed after the label. |
start
|
An element, such as <wa-icon>, placed before the label. |
Attributes & Properties
Jump to heading
Learn more about attributes and properties.
| Name | Description | Reflects | |
|---|---|---|---|
appearanceappearance |
The badge's visual appearance.
Type
'accent' | 'filled' | 'outlined' | 'filled-outlined'Default
'accent' |
|
|
attentionattention |
Adds an animation to draw attention to the badge.
Type
'none' | 'pulse' | 'bounce'Default
'none' |
|
|
css |
One or more CSSResultGroup to include in the component's shadow root. Host styles are automatically prepended.
Type
CSSResultGroup | undefinedDefault
[variantStyles, styles] |
||
pillpill |
Draws a pill-style badge with rounded edges.
Type
booleanDefault
false |
|
|
variantvariant |
The badge's theme variant. Defaults to
brand if not within another element with a variant.Type
'brand' | 'neutral' | 'success' | 'warning' | 'danger' | 'info'Default
'brand' |
|
CSS custom properties
Jump to heading
Learn more about CSS custom properties.
| Name | Description |
|---|---|
--pulse-color |
The color of the badge's pulse effect when using
attention="pulse". |
CSS parts
Jump to heading
Learn more about CSS parts.
| Name | Description | CSS selector |
|---|---|---|
base |
The component's base wrapper. |
::part(base)
|
end |
The container that wraps the end slot. |
::part(end)
|
start |
The container that wraps the start slot. |
::part(start)
|
Need a hand?