0
0
mirror of https://github.com/twbs/bootstrap.git synced 2024-12-04 16:24:22 +01:00
Bootstrap/site/content/docs/5.3/components/spinners.md
Gaël Poupard a4918e33b8
docs(spinners): improve buttons examples accessibility (#38632)
* docs(spinners): improve buttons examples accessibility

* docs(spinners): missed occurrence of wrong role + aria-hidden

---------

Co-authored-by: Patrick H. Lauke <redux@splintered.co.uk>
2023-05-31 19:32:47 -07:00

6.8 KiB

layout title description group toc
docs Spinners Indicate the loading state of a component or page with Bootstrap spinners, built entirely with HTML, CSS, and no JavaScript. components 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 a nested <span class="visually-hidden">Loading...</span>.

{{< callout info >}} {{< partial "callouts/info-prefersreducedmotion.md" >}} {{< /callout >}}

Border spinner

Use the border spinners for a lightweight loading indicator.

{{< example >}}

Loading...
{{< /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.

{{< example >}} {{< spinner.inline >}} {{- range (index $.Site.Data "theme-colors") }}

Loading...
{{- end -}} {{< /spinner.inline >}} {{< /example >}}

{{< callout info >}} 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. {{< /callout >}}

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!

{{< example >}}

Loading...
{{< /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.

{{< example >}} {{< spinner.inline >}} {{- range (index $.Site.Data "theme-colors") }}

Loading...
{{- end -}} {{< /spinner.inline >}} {{< /example >}}

Alignment

Spinners in Bootstrap are built with rems, 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.

{{< example >}}

Loading...
{{< /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

{{< example >}}

Loading...
{{< /example >}}

{{< example >}}

Loading...
{{< /example >}}

Floats

{{< example >}}

Loading...
{{< /example >}}

Text align

{{< example >}}

Loading...
{{< /example >}}

Size

Add .spinner-border-sm and .spinner-grow-sm to make a smaller spinner that can quickly be used within other components.

{{< example >}}

Loading...
Loading...
{{< /example >}}

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

{{< example >}}

Loading...
Loading...
{{< /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.

{{< example >}} Loading... Loading... {{< /example >}}

{{< example >}} Loading... Loading... {{< /example >}}

CSS

Variables

{{< added-in "5.2.0" >}}

As part of Bootstrap's evolving CSS variables approach, spinners now use local CSS variables on .spinner-border and .spinner-grow for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.

Border spinner variables:

{{< scss-docs name="spinner-border-css-vars" file="scss/_spinners.scss" >}}

Growing spinner variables:

{{< scss-docs name="spinner-grow-css-vars" file="scss/_spinners.scss" >}}

For both spinners, small spinner modifier classes are used to update the values of these CSS variables as needed. For example, the .spinner-border-sm class does the following:

{{< scss-docs name="spinner-border-sm-css-vars" file="scss/_spinners.scss" >}}

Sass variables

{{< scss-docs name="spinner-variables" file="scss/_variables.scss" >}}

Keyframes

Used for creating the CSS animations for our spinners. Included in scss/_spinners.scss.

{{< scss-docs name="spinner-border-keyframes" file="scss/_spinners.scss" >}}

{{< scss-docs name="spinner-grow-keyframes" file="scss/_spinners.scss" >}}

[color]: {{< docsref "/utilities/colors" >}} [flex]: {{< docsref "/utilities/flex" >}} [float]: {{< docsref "/utilities/float" >}} [margin]: {{< docsref "/utilities/spacing" >}} [text]: {{< docsref "/utilities/text" >}}