Badges
Small and adaptive tag for adding context to just about any content.
Badges scale to match the size of the immediate parent element by using
relative font sizing and em
units.
<div>
<h2>Example heading <b-badge>New</b-badge></h2>
<h3>Example heading <b-badge>New</b-badge></h3>
<h4>Example heading <b-badge>New</b-badge></h4>
<h5>Example heading <b-badge>New</b-badge></h5>
<h6>Example heading <b-badge>New</b-badge></h6>
</div>
Badges can be used as part of links or buttons to provide a counter (or similar flag).
<div class="text-center">
<b-button variant="primary">
Notifications <b-badge variant="light">4</b-badge>
</b-button>
</div>
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 (as with the “Notifications” example, where it is
understood that the “4” is the number of notifications), consider including additional
context with a visually hidden piece of additional text.
<div class="text-center">
<b-button variant="primary">
Profile
<b-badge variant="light">
9 <span class="sr-only">unread messages</span>
</b-badge>
</b-button>
</div>
Contextual variations
Add any of the following variants via the variant
prop to change the
appearance of a <b-badge>
: default
, primary
, success
, warning
, info
,
and danger
. If no variant is specified default
will be used.
<div>
<b-badge variant="primary">Primary</b-badge>
<b-badge variant="secondary">Secondary</b-badge>
<b-badge variant="success">Success</b-badge>
<b-badge variant="danger">Danger</b-badge>
<b-badge variant="warning">Warning</b-badge>
<b-badge variant="info">Info</b-badge>
<b-badge variant="light">Light</b-badge>
<b-badge variant="dark">Dark</b-badge>
</div>
Conveying meaning to assistive technologies:
Using color to add meaning only provides a visual indication, which will not
be conveyed to users of assistive technologies – such as screen readers. Ensure
that information denoted by the color is either obvious from the content itself
(e.g. the visible text), or is included through alternative means, such as
additional text hidden with the .sr-only
class.
Pill badges
Use the pill
prop to make badges more rounded (with a larger border-radius
and additional horizontal padding). Useful if you miss the badges from Bootstrap v3.
<div>
<b-badge pill variant="primary">Primary</b-badge>
<b-badge pill variant="secondary">Secondary</b-badge>
<b-badge pill variant="success">Success</b-badge>
<b-badge pill variant="danger">Danger</b-badge>
<b-badge pill variant="warning">Warning</b-badge>
<b-badge pill variant="info">Info</b-badge>
<b-badge pill variant="light">Light</b-badge>
<b-badge pill variant="dark">Dark</b-badge>
</div>
Actionable badges
Quickly provide actionable badges with hover and focus states by specifying either the
href
prop (links) or to
prop (router-links):
<div>
<b-badge href="#" variant="primary">Primary</b-badge>
<b-badge href="#" variant="secondary">Secondary</b-badge>
<b-badge href="#" variant="success">Success</b-badge>
<b-badge href="#" variant="danger">Danger</b-badge>
<b-badge href="#" variant="warning">Warning</b-badge>
<b-badge href="#" variant="info">Info</b-badge>
<b-badge href="#" variant="light">Light</b-badge>
<b-badge href="#" variant="dark">Dark</b-badge>
</div>
Refer to the Router support reference page for
router-link specific props.
Component Reference
Importing Individual Components
Component | Import Path |
---|
<b-badge> | bootstrap-vue/es/components/badge/badge |
Example:
import bBadge from 'bootstrap-vue/es/components/badge/badge';
Vue.component('b-badge', bBadge);
Importing Badge as a Vue plugin
This plugin includes all of the above listed individual
components.
Plugins also include any component aliases.
import { Badge } from 'bootstrap-vue/es/components';
Vue.use(Badge);