diff --git a/scss/_spinners.scss b/scss/_spinners.scss new file mode 100644 index 0000000000..4235662b3f --- /dev/null +++ b/scss/_spinners.scss @@ -0,0 +1,69 @@ +// +// Rotating border +// + +@keyframes spinner-border { + to { transform: rotate(360deg); } +} + +.spinner-border { + position: relative; + display: inline-block; + width: $spinner-width; + height: $spinner-height; + overflow: hidden; + text-indent: -999em; + vertical-align: text-bottom; + border: $spinner-border-width solid; + border-color: currentColor transparent currentColor currentColor; + border-radius: 50%; + animation-name: spinner-border; + animation-duration: .75s; + animation-timing-function: linear; + animation-iteration-count: infinite; +} + +.spinner-border-sm { + width: $spinner-width-sm; + height: $spinner-height-sm; + border-width: $spinner-border-width-sm; +} + +// +// Growing circle +// + +@keyframes spinner-grow { + 0% { + opacity: 0; + transform: scale(0); + } + 50% { + opacity: 1; + } + 100% { + opacity: 0; + transform: scale(1); + } +} + +.spinner-grow { + position: relative; + display: inline-block; + width: $spinner-width; + height: $spinner-height; + overflow: hidden; + text-indent: -999em; + vertical-align: text-bottom; + background-color: currentColor; + border-radius: 50%; + animation-name: spinner-grow; + animation-duration: .75s; + animation-timing-function: linear; + animation-iteration-count: infinite; +} + +.spinner-grow-sm { + width: $spinner-width-sm; + height: $spinner-height-sm; +} diff --git a/scss/_variables.scss b/scss/_variables.scss index dac260c197..c636860bda 100644 --- a/scss/_variables.scss +++ b/scss/_variables.scss @@ -1024,6 +1024,17 @@ $carousel-transition-duration: .6s !default; $carousel-transition: transform $carousel-transition-duration ease-in-out !default; // Define transform transition first if using multiple transitions (e.g., `transform 2s ease, opacity .5s ease-out`) +// Spinners + +$spinner-width: 2rem !default; +$spinner-height: $spinner-width !default; +$spinner-border-width: .25em !default; + +$spinner-width-sm: 1rem !default; +$spinner-height-sm: $spinner-width-sm !default; +$spinner-border-width-sm: .2em !default; + + // Close $close-font-size: $font-size-base * 1.5 !default; diff --git a/scss/bootstrap.scss b/scss/bootstrap.scss index e3f76546b2..6f7e4eef15 100644 --- a/scss/bootstrap.scss +++ b/scss/bootstrap.scss @@ -38,5 +38,6 @@ @import "tooltip"; @import "popover"; @import "carousel"; +@import "spinners"; @import "utilities"; @import "print"; diff --git a/site/_data/nav.yml b/site/_data/nav.yml index 14002d3951..cb0defd890 100644 --- a/site/_data/nav.yml +++ b/site/_data/nav.yml @@ -49,6 +49,7 @@ - title: Popovers - title: Progress - title: Scrollspy + - title: Spinners - title: Tooltips - title: Utilities diff --git a/site/docs/4.1/components/spinners.md b/site/docs/4.1/components/spinners.md new file mode 100644 index 0000000000..878c2a7de4 --- /dev/null +++ b/site/docs/4.1/components/spinners.md @@ -0,0 +1,167 @@ +--- +layout: docs +title: Spinners +description: Indicate the loading state of a component or page with Bootstrap spinners, built entirely with HTML, CSS, and no JavaScript. +group: components +toc: true +--- + +## About + +Bootstrap "spinners" can be used to show the loading state in your projects. They're built only with HTML and CSS, meaning you don't need any JavaScript to create them. You will, however, need some custom JavaScript to toggle their visibility. Their appearance, alignment, and sizing can be easily customized with our amazing utility classes. + +For accessibility purposes, each loader here includes `role="status"` and `Loading...` text within. We account for this in our CSS, using a text hiding technique to prevent it from rendering on screen. + +## Border spinner + +Use the border spinners for a lightweight loading indicator. + +{% capture example %} + +{% endcapture %} +{% include example.html content=example %} + +### Colors + +The border spinner uses `currentColor` for its `border-color`, meaning you can customize the color with [text color utilities][color]. Here's the regular border spinner in blue. + +
+ +
+ +Use any of our text color utilities on the standard spinner. + +{% highlight html %} +{% for color in site.data.theme-colors %} +{% endfor %} +{% endhighlight %} + +{% capture callout %} +**Why not use `border-color` utilities?** Each border spinner specifies a `transparent` border for at least one side, so `.border-{color}` utilities would override that. +{% endcapture %} +{% include callout.html content=callout type="info" %} + +## Growing spinner + +If you don't fancy a border spinner, switch to the grow spinner. While it doesn't technically spin, it does repeatedly grow! + +{% capture example %} + +{% endcapture %} +{% include example.html content=example %} + +Once again, this spinner is built with `currentColor`, so you can easily change its appearance with [text color utilities][color]. Here it is in blue, along with the supported variants. + +
+ +
+ +{% highlight html %} +{% for color in site.data.theme-colors %} +{% endfor %} +{% endhighlight %} + +## Alignment + +Spinners in Bootstrap are built with `rem`s, `currentColor`, and `display: inline-flex`. This means they can easily be resized, recolored, and quickly aligned. + +### Margin + +Use [margin utilities][margin] like `.m-5` for easy spacing. + +{% capture example %} + +{% endcapture %} +{% include example.html content=example %} + +### Placement + +Use [flexbox utilities][flex], [float utilities][float], or [text alignment][text] utilities to place spinners exactly where you need them in any situation. + +#### Flex + +{% capture example %} +
+ +
+{% endcapture %} +{% include example.html content=example %} + +{% capture example %} +
+ Loading... + +
+{% endcapture %} +{% include example.html content=example %} + +#### Floats + +{% capture example %} +
+ +
+{% endcapture %} +{% include example.html content=example %} + +#### Text align + +{% capture example %} +
+ +
+{% endcapture %} +{% include example.html content=example %} + +## Size + +Add `.spinner-border-sm` and `.spinner-grow-sm` to make a smaller spinner that can quickly be used within other components. + +{% capture example %} + + +{% endcapture %} +{% include example.html content=example %} + +Or, use custom CSS or inline styles to change the dimensions as needed. + +{% capture example %} + + +{% endcapture %} +{% include example.html content=example %} + +## Buttons + +Use spinners within buttons to indicate an action is currently processing or taking place. You may also swap the text out of the spinner element and utilize button text as needed. + +{% capture example %} + + +{% endcapture %} +{% include example.html content=example %} + +{% capture example %} + + +{% endcapture %} +{% include example.html content=example %} + + +[color]: {{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/colors/ +[display]: {{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/display/ +[flex]: {{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/flex/ +[float]: {{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/float/ +[margin]: {{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/spacing/ +[sizing]: {{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/sizing/ +[text]: {{ site.baseurl }}/docs/{{ site.docs_version }}/content/typography/