Spinners

React Bootstrap 5 Spinners component

Indicate the loading state of a component or page with MDB spinners, built entirely with HTML, CSS, and no JavaScript.

Basic example

Use the border spinners for a lightweight loading indicator.

import React from 'react';
import { MDBSpinner } from 'mdb-react-ui-kit';

export default function App() {
  return (
    <MDBSpinner role='status'>
      <span className='visually-hidden'>Loading...</span>
    </MDBSpinner>
  );
}

MDB “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 classNames.

For accessibility purposes, each loader here includes role="status" and a nested <span class="visually-hidden">Loading...</span>.

Colors

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

import React from 'react';
import { MDBSpinner } from 'mdb-react-ui-kit';

export default function App() {
  return (
    <>
      <MDBSpinner color='primary'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
      <MDBSpinner className='mx-2' color='secondary'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
      <MDBSpinner color='success'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
      <MDBSpinner className='mx-2' color='warning'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
      <MDBSpinner color='danger'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
      <MDBSpinner className='mx-2' color='info'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
      <MDBSpinner color='light'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
      <MDBSpinner className='ms-2' color='dark'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
    </>
  );
}

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.

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! 

import React from 'react';
import { MDBSpinner } from 'mdb-react-ui-kit';

export default function App() {
  return (
    <MDBSpinner grow>
      <span className='visually-hidden'>Loading...</span>
    </MDBSpinner>
  );
}

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

import React from 'react';
import { MDBSpinner } from 'mdb-react-ui-kit';

export default function App() {
  return (
    <>
      <MDBSpinner grow color='primary'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
      <MDBSpinner grow className='mx-2' color='secondary'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
      <MDBSpinner grow color='success'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
      <MDBSpinner grow className='mx-2' color='warning'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
      <MDBSpinner grow color='danger'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
      <MDBSpinner grow className='mx-2' color='info'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
      <MDBSpinner grow color='light'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
      <MDBSpinner grow className='ms-2' color='dark'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
    </>
  );
}

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 like .m-5 for easy spacing. 

import React from 'react';
import { MDBSpinner } from 'mdb-react-ui-kit';

export default function App() {
  return (
    <MDBSpinner className='m-5' role='status'>
      <span className='visually-hidden'>Loading...</span>
    </MDBSpinner>
  );
}

Flex

Use flexbox utilities, float utilities, or text alignment utilities to place spinners exactly where you need them in any situation. 

import React from 'react';
import { MDBSpinner } from 'mdb-react-ui-kit';

export default function App() {
  return (
    <div className='d-flex justify-content-center'>
      <MDBSpinner role='status'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
    </div>
  );
}
Loading... 
import React from 'react';
import { MDBSpinner } from 'mdb-react-ui-kit';

export default function App() {
  return (
    <div className='d-flex align-items-center'>
      <strong>Loading...</strong>
      <MDBSpinner className='ms-auto' role='status' />
    </div>
  );
}

Floats

import React from 'react';
import { MDBSpinner } from 'mdb-react-ui-kit';

export default function App() {
  return (
    <div className='clearfix'>
      <MDBSpinner className='float-end' role='status'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
    </div>
  );
}

Text align

import React from 'react';
import { MDBSpinner } from 'mdb-react-ui-kit';

export default function App() {
  return (
    <div className='text-center'>
      <MDBSpinner role='status'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
    </div>
  );
}

Size

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

import React from 'react';
import { MDBSpinner } from 'mdb-react-ui-kit';

export default function App() {
  return (
    <>
      <MDBSpinner className='me-2' size='sm'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>

      <MDBSpinner grow size='sm'>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
    </>
  );
}

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

import React from 'react';
import { MDBSpinner } from 'mdb-react-ui-kit';

export default function App() {
  return (
    <>
      <MDBSpinner className='me-2' style={{ width: '3rem', height: '3rem' }}>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>

      <MDBSpinner grow style={{ width: '3rem', height: '3rem' }}>
        <span className='visually-hidden'>Loading...</span>
      </MDBSpinner>
    </>
  );
}

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.

Border spinner

import React from 'react';
import { MDBSpinner, MDBBtn } from 'mdb-react-ui-kit';

export default function App() {
  return (
    <>
      <MDBBtn disabled className='me-2'>
        <MDBSpinner size='sm' role='status' tag='span' />
        <span className='visually-hidden'>Loading...</span>
      </MDBBtn>

      <MDBBtn disabled>
        <MDBSpinner size='sm' role='status' tag='span' className='me-2' />
        Loading...
      </MDBBtn>
    </>
  );
}

Growing spinner

import React from 'react';
import { MDBSpinner, MDBBtn } from 'mdb-react-ui-kit';

export default function App() {
  return (
    <>
      <MDBBtn disabled className='me-2'>
        <MDBSpinner grow size='sm' role='status' tag='span' />
        <span className='visually-hidden'>Loading...</span>
      </MDBBtn>

      <MDBBtn disabled>
        <MDBSpinner grow size='sm' role='status' tag='span' className='me-2' />
        Loading...
      </MDBBtn>
    </>
  );
}

Spinners - API

Import

import { MDBSpinner } from 'mdb-react-ui-kit';

Properties

MDBSpinner

Name Type Default Description Example
tag String 'div' Defines tag of the MDBSpinner element <MDBSpinner tag="section" />
color String '' Defines the color of the MDBSpinner element <MDBSpinner color="secondary" />
size String '' Sets the size of the spinner <MDBSpinner size="sm" />
grow Boolean '' Makes a growing spinner <MDBSpinner grow />

CSS variables

As part of MDB'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:

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

// .spinner-border-sm
--#{$prefix}spinner-width: #{$spinner-width-sm};
--#{$prefix}spinner-height: #{$spinner-height-sm};
--#{$prefix}spinner-border-width: #{$spinner-border-width-sm};

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

// .spinner-grow-sm
--#{$prefix}spinner-width: #{$spinner-width-sm};
--#{$prefix}spinner-height: #{$spinner-height-sm};

SCSS variables

$spinner-width: 2rem;
$spinner-height: $spinner-width;
$spinner-vertical-align: -0.125em;
$spinner-border-width: 0.25em;
$spinner-animation-speed: 0.75s;

$spinner-width-sm: 1rem;
$spinner-height-sm: $spinner-width-sm;
$spinner-border-width-sm: 0.2em;