Progress

Use our custom progress component for displaying simple or complex progress bars, featuring support for horizontally stacked bars, animated backgrounds, and text labels.

Component reference

<b-progress>

Properties

All property default values are globally configurable.

Property
Type
Default
Description
animated
BooleanfalseEnable the animated background. Also automatically sets 'striped'
height
StringOverride the default height by specifying a CSS height value (including units)
max
Number or String100Set the maximum value
precision
Number or String0The number of digits after the decimal to round the value to
show-progress
BooleanfalseDisplays the current progress value as a percentage
show-value
BooleanfalseDisplays the current progress value
striped
BooleanfalseEnable the striped background
value
Number or String0The current value of the progress bar
variant
StringApplies one of the Bootstrap theme color variants to the component

Slots

Name
Description
default Content (progress bars) to place in the progress element

<b-progress-bar>

Properties

All property default values are globally configurable.

Property
(Click to sort ascending)
Type
(Click to sort ascending)
Default
Description
animated
BooleannullEnable the animated background. Also automatically sets 'striped'
label
StringText string to explicitly set the label as
label-html
Use with caution
StringHTML string to explicitly set the label as
max
Number or StringnullSet the maximum value
precision
Number or StringnullThe number of digits after the decimal to round the value to
show-progress
BooleannullDisplays the current progress value as a percentage
show-value
BooleannullDisplays the current progress value
striped
BooleannullEnable the striped background
value
Number or String0The current value of the progress bar
variant
StringApplies one of the Bootstrap theme color variants to the component

Caution: Props that support HTML strings (*-html) can be vulnerable to Cross Site Scripting (XSS) attacks when passed raw user supplied values. You must properly sanitize the user input first!

Slots

Name
Description
default Content to place in the progress bar. Overrides the `label`, `label-html`, `show-progress` and `show-value` props

Importing individual components

You can import individual components into your project via the following named exports:

Component
Named Export
Import Path
<b-progress>BProgressbootstrap-vue
<b-progress-bar>BProgressBarbootstrap-vue

Example:

import { BProgress } from 'bootstrap-vue'
Vue.component('b-progress', BProgress)

Importing as a Vue.js plugin

This plugin includes all of the above listed individual components. Plugins also include any component aliases.

Named Export
Import Path
ProgressPluginbootstrap-vue

Example:

import { ProgressPlugin } from 'bootstrap-vue'
Vue.use(ProgressPlugin)