| layout | title | description | group | aliases | toc | |
|---|---|---|---|---|---|---|
docs |
Spinners |
Indicate the loading state of a component or page with Boosted spinners, built entirely with HTML, CSS, and no JavaScript. |
components |
|
true |
Boosted "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 >}}
Use the border spinners for a lightweight loading indicator.
{{< example >}}
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 >}}
See Bootstrap examples that are incompatible with Orange Design System.
{{< design-callout-alert >}} These variants contain some spinners that should not be used on Orange sites.
Colored spinners are incompatible with Orange Design System. {{< /design-callout-alert >}}
{{< 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 >}}
{{< added-in "5.2.0" >}}
If you don't fancy a border spinner, switch to the grow spinner. While it doesn't technically spin, it does repeatedly grow!
See Bootstrap examples that are incompatible with Orange Design System.
{{< design-callout-alert >}} These variants contain some spinners that should not be used on Orange sites.
Growing spinner and its examples are incompatible with Orange Design System. {{< /design-callout-alert >}}
{{< example >}}
Once again, this spinner is built with currentColor, so you can easily change its appearance with [text color utilities][color].
{{< example >}} {{< spinner.inline >}} {{- range (index $.Site.Data "theme-colors") }}
Spinners in Boosted are built with rems, currentColor, and display: inline-flex. This means they can easily be resized, recolored, and quickly aligned.
Use [margin utilities][margin] like .m-5 for easy spacing.
{{< example >}}
Use [flexbox utilities][flex], [float utilities][float], or [text alignment][text] utilities to place spinners exactly where you need them in any situation.
{{< example >}}
{{< example >}}
{{< example >}}
{{< example >}}
Add .spinner-border-sm or .spinner-border-lg to make a smaller spinner that can quickly be used within other components.
{{< example >}}
See Bootstrap examples that are incompatible with Orange Design System.
{{< design-callout-alert >}} These variants contain some spinners that should not be used on Orange sites.
Growing spinner and its examples are incompatible with Orange Design System. {{< /design-callout-alert >}}
{{< example >}}
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 >}}
See Bootstrap examples that are incompatible with Orange Design System.
{{< design-callout-alert >}} These variants contain some spinners that should not be used on Orange sites.
Growing spinner and its examples are incompatible with Orange Design System. {{< /design-callout-alert >}}
{{< example >}} Loading... Loading... {{< /example >}}
{{< added-in "5.2.0" >}}
As part of Boosted'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 and large 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" >}}
And the .spinner-border-lg:
{{< scss-docs name="spinner-border-lg-css-vars" file="scss/_spinners.scss" >}}
{{< scss-docs name="spinner-variables" file="scss/_variables.scss" >}}
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" >}}