React Spinner Component

About#

CoreUI "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 className="visually-hidden">Loading...</span>.

Border spinner#

Use the border spinners for a lightweight loading indicator.

<CSpinner/>

Colors#

The border spinner uses currentColor for its border-color. You can use any of our text color utilities on the standard spinner.

<CSpinner color="primary" />
<CSpinner color="secondary" />
<CSpinner color="success" />
<CSpinner color="danger" />
<CSpinner color="warning" />
<CSpinner color="info" />
<CSpinner color="light" />
<CSpinner color="dark" />

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!

<CSpinner variant="grow" />

Once again, this spinner is built with currentColor, so you can easily change its appearance. Here it is in blue, along with the supported variants.

<CSpinner color="primary" variant="grow" />
<CSpinner color="secondary" variant="grow" />
<CSpinner color="success" variant="grow" />
<CSpinner color="danger" variant="grow" />
<CSpinner color="warning" variant="grow" />
<CSpinner color="info" variant="grow" />
<CSpinner color="light" variant="grow" />
<CSpinner color="dark" variant="grow" />

Alignment#

CoreUI React spinners are built with rems, currentColor, and display: inline-flex. This means they can easily be resized, recolored, and quickly aligned.

Margin#

Use margin utilities like .m-5 for easy spacing.

<CSpinner className="m-5" />

Placement#

Use [flexbox utilities][https://coreui.io/docs/utilities/flex/], [float utilities][https://coreui.io/docs/utilities/float/], or [text alignment][https://coreui.io/docs/utilities/text/] utilities to place spinners exactly where you need them in any situation.

Flex#

<div className="d-flex justify-content-center">
  <CSpinner />
</div>

<div className="d-flex align-items-center">
  <strong role="status">Loading...</strong>
  <CSpinner className="ms-auto" />
</div>

Floats#

<div className="clearfix">
  <CSpinner className="float-end" />
</div>

Text align#

<div className="text-center">
  <CSpinner />
</div>

Size#

Add size="sm" property to make a smaller spinner that can quickly be used within other components.

<CSpinner size="sm" />
<CSpinner size="sm" variant="grow" />

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

<CSpinner size="sm" style={{ width: '3rem', height: '3rem'}}/>
<CSpinner size="sm" variant="grow" style={{ width: '3rem', height: '3rem'}}/>

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.

<CButton color="primary" disabled>
  <CSpinner as="span" size="sm" aria-hidden="true" />
</CButton>
<CButton color="primary" disabled>
  <CSpinner as="span" size="sm" aria-hidden="true" />
  Loading...
</CButton>

<CButton color="primary" disabled>
  <CSpinner as="span" size="sm" variant="grow" aria-hidden="true" />
</CButton>
<CButton color="primary" disabled>
  <CSpinner as="span" size="sm" variant="grow" aria-hidden="true" />
  Loading...
</CButton>

Customizing#

CSS variables#

React spinners 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:

--cui-spinner-width: #{$spinner-width};
--cui-spinner-height: #{$spinner-height};
--cui-spinner-vertical-align: #{$spinner-vertical-align};
--cui-spinner-border-width: #{$spinner-border-width};
--cui-spinner-animation-speed: #{$spinner-animation-speed};
--cui-spinner-animation-name: spinner-border;

Growing spinner variables:

--cui-spinner-width: #{$spinner-width};
--cui-spinner-height: #{$spinner-height};
--cui-spinner-vertical-align: #{$spinner-vertical-align};
--cui-spinner-animation-speed: #{$spinner-animation-speed};
--cui-spinner-animation-name: spinner-grow;

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:

--cui-spinner-width: #{$spinner-width-sm};
--cui-spinner-height: #{$spinner-height-sm};
--cui-spinner-border-width: #{$spinner-border-width-sm};

How to use CSS variables#

const vars = { 
  '--my-css-var': 10,
  '--my-another-css-var': "red" 
}
return <CSpinner style={vars}>...</CSpinner>

SASS variables#

$spinner-width:           2rem !default;
$spinner-height:          $spinner-width !default;
$spinner-vertical-align:  -.125em !default;
$spinner-border-width:    .25em !default;
$spinner-animation-speed: .75s !default;

$spinner-width-sm:        1rem !default;
$spinner-height-sm:       $spinner-width-sm !default;
$spinner-border-width-sm: .2em !default;

Keyframes#

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

@keyframes spinner-border {
  to { transform: rotate(360deg) #{"/* rtl:ignore */"}; }
}

@keyframes spinner-grow {
  0% {
    transform: scale(0);
  }
  50% {
    opacity: 1;
    transform: none;
  }
}

API#

CSpinner#

import { CSpinner } from '@coreui/react'
// or
import CSpinner from '@coreui/react/src/components/spinner/CSpinner'