This commit includes all the needed workarounds and most changes from the main branch for everything to work, like: * removing empty lines in raw HTML that break output * read .browserslistrc, CSS variables from disk instead of duplicating it * using Hugo mounts * using Hugo for the docs CSS/JS * move ToC Sass code to a separate file while adapting it for Hugo Thus, this patch makes our npm scripts faster since lint runs on one step and there's no separate docs assets processing.
5.6 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="sr-only">Loading...</span>
.
{{< callout info >}} {{< partial "callout-info-prefersreducedmotion.md" >}} {{< /callout >}}
Border spinner
Use the border spinners for a lightweight loading indicator.
{{< 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") }}
{{< 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 >}}
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") }}
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.
{{< 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 >}}
{{< example >}}
Floats
{{< example >}}
Text align
{{< example >}}
Size
Add .spinner-border-sm
and .spinner-grow-sm
to make a smaller spinner that can quickly be used within other components.
{{< example >}}
Or, use custom CSS or inline styles to change the dimensions as needed.
{{< 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 >}}
[color]: {{< docsref "/utilities/colors" >}} [display]: {{< docsref "/utilities/display" >}} [flex]: {{< docsref "/utilities/flex" >}} [float]: {{< docsref "/utilities/float" >}} [margin]: {{< docsref "/utilities/spacing" >}} [sizing]: {{< docsref "/utilities/sizing" >}} [text]: {{< docsref "/content/typography" >}}