Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v4.2: Spinners! #22960

Merged
merged 5 commits into from
Nov 13, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@
},
{
"path": "./dist/css/bootstrap.min.css",
"maxSize": "22 kB"
"maxSize": "22.5 kB"
},
{
"path": "./dist/js/bootstrap.bundle.js",
Expand Down
63 changes: 63 additions & 0 deletions scss/_spinners.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
//
// 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: spinner-border .75s linear 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 {
mdo marked this conversation as resolved.
Show resolved Hide resolved
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: spinner-grow .75s linear infinite;
}

.spinner-grow-sm {
width: $spinner-width-sm;
height: $spinner-height-sm;
}
11 changes: 11 additions & 0 deletions scss/_variables.scss
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
1 change: 1 addition & 0 deletions scss/bootstrap.scss
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,6 @@
@import "tooltip";
@import "popover";
@import "carousel";
@import "spinners";
@import "utilities";
@import "print";
1 change: 1 addition & 0 deletions site/_data/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
- title: Popovers
- title: Progress
- title: Scrollspy
- title: Spinners
- title: Tooltips

- title: Utilities
Expand Down
159 changes: 159 additions & 0 deletions site/docs/4.1/components/spinners.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
---
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 %}
<div class="spinner-border" role="status">Loading...</div>
{% 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]. You can use any of our text color utilities on the standard spinner.

{% capture example %}
{% for color in site.data.theme-colors %}
<div class="spinner-border text-{{ color.name }}" role="status">Loading...</div>{% endfor %}
{% endcapture %}
{% include example.html content=example %}

{% 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 %}
<div class="spinner-grow" role="status">Loading...</div>
{% 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.

{% capture example %}
{% for color in site.data.theme-colors %}
<div class="spinner-grow text-{{ color.name }}" role="status">Loading...</div>{% endfor %}
{% endcapture %}
{% include example.html content=example %}

## 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 %}
<div class="spinner-border m-5" role="status">Loading...</div>
{% 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 %}
<div class="d-flex justify-content-center">
<div class="spinner-border" role="status">Loading...</div>
</div>
{% endcapture %}
{% include example.html content=example %}

{% capture example %}
<div class="d-flex align-items-center">
<strong>Loading...</strong>
<div class="spinner-border ml-auto" role="status"></div>
</div>
{% endcapture %}
{% include example.html content=example %}

#### Floats

{% capture example %}
<div class="clearfix">
<div class="spinner-border float-right" role="status">Loading...</div>
</div>
{% endcapture %}
{% include example.html content=example %}

#### Text align

{% capture example %}
<div class="text-center">
<div class="spinner-border" role="status">Loading...</div>
</div>
{% 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 %}
<div class="spinner-border spinner-border-sm" role="status">Loading...</div>
<div class="spinner-grow spinner-grow-sm" role="status">Loading...</div>
{% endcapture %}
{% include example.html content=example %}

Or, use custom CSS or inline styles to change the dimensions as needed.

{% capture example %}
<div class="spinner-border" style="width: 3rem; height: 3rem;" role="status">Loading...</div>
<div class="spinner-grow" style="width: 3rem; height: 3rem;" role="status">Loading...</div>
{% 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 %}
<button class="btn btn-primary" type="button" disabled>
<span class="spinner-border spinner-border-sm" role="status">Loading...</span>
</button>
<button class="btn btn-primary" type="button" disabled>
<span class="spinner-border spinner-border-sm" role="status"></span>
Loading...
</button>
{% endcapture %}
{% include example.html content=example %}

{% capture example %}
<button class="btn btn-primary" type="button" disabled>
<span class="spinner-grow spinner-grow-sm" role="status">Loading...</span>
</button>
<button class="btn btn-primary" type="button" disabled>
<span class="spinner-grow spinner-grow-sm" role="status"></span>
Loading...
</button>
{% 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/