0
0
mirror of https://github.com/twbs/bootstrap.git synced 2024-11-29 11:24:18 +01:00
Bootstrap/docs/4.1/components/progress.md
Mark Otto 8f7bd41993
Ship v4.1.0 (#26218)
* update docs path from docs/4.0/ to docs/4.1/

* bump version to 4.1.0

* Update redirects to work for 4.1 docs move

* Update docs version switcher to include latest and link to 4.0 docs

* re-run dist

* Update package-lock.json

* Update docs-navbar.html
2018-04-09 09:00:23 -07:00

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 .progress as a wrapper to indicate the max value of the progress bar.
  • We use the inner .progress-bar to indicate the progress so far.
  • The .progress-bar requires an inline style, utility class, or custom CSS to set their width.
  • The .progress-bar also requires some role and aria attributes to make it accessible.

Put that all together, and you have the following examples.

{% capture example %}

{% endcapture %} {% include example.html content=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 %}

{% endcapture %} {% include example.html content=example %}

Labels

Add labels to your progress bars by placing text within the .progress-bar.

{% capture example %}

25%
{% endcapture %} {% include example.html content=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 %}

{% endcapture %} {% include example.html content=example %}

Backgrounds

Use background utility classes to change the appearance of individual progress bars.

{% capture example %}

{% endcapture %} {% include example.html content=example %}

Multiple bars

Include multiple progress bars in a progress component if you need.

{% capture example %}

{% endcapture %} {% include example.html content=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 %}

{% endcapture %} {% include example.html content=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.

Toggle animation

{% highlight html %}

{% endhighlight %}