With the current docs directory setup, I'm making too many mistakes and have to manually address path changes and directory moves on deploy. This makes for a frustrating experience developing locally and shipping releases. With this PR, we're basically back to the same setup from v3—duplicating the dist directory into our docs directory. Not the most ideal, but very straightforward for me as the release manager.
6.5 KiB
| layout | title | description | group | toc |
|---|---|---|---|---|
| docs | Progress | Documentation and examples for using Bootstrap custom progress bars featuring support for stacked bars, animated backgrounds, and text labels. | components | true |
How it works
Progress components are built with two HTML elements, some CSS to set the width, and a few attributes. We don't use the HTML5 <progress> element, ensuring you can stack progress bars, animate them, and place text labels over them.
- We use the
.progressas a wrapper to indicate the max value of the progress bar. - We use the inner
.progress-barto indicate the progress so far. - The
.progress-barrequires an inline style, utility class, or custom CSS to set their width. - The
.progress-baralso requires someroleandariaattributes to make it accessible.
Put that all together, and you have the following examples.
{% capture example %}
Bootstrap provides a handful of [utilities for setting width]({{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/sizing/). Depending on your needs, these may help with quickly configuring progress.
{% capture example %}
Labels
Add labels to your progress bars by placing text within the .progress-bar.
{% capture example %}
Height
We only set a height value on the .progress, so if you change that value the inner .progress-bar will automatically resize accordingly.
{% capture example %}
Backgrounds
Use background utility classes to change the appearance of individual progress bars.
{% capture example %}
Multiple bars
Include multiple progress bars in a progress component if you need.
{% capture example %}
Striped
Add .progress-bar-striped to any .progress-bar to apply a stripe via CSS gradient over the progress bar's background color.
{% capture example %}
Animated stripes
The striped gradient can also be animated. Add .progress-bar-animated to .progress-bar to animate the stripes right to left via CSS3 animations.
{% highlight html %}