Spinners

Spinners can be used to show the loading state in your projects.

<Spinner animation="border" role="status">
  <span className="sr-only">Loading...</span>
</Spinner>

Animations

Bootstrap offers two animation styles for spinners. The animation style can be configured with the animation property. An animation style must always be provided when creating a spinner.

Border Spinner - border

<Spinner animation="border" />

Grow Spinner - grow

<Spinner animation="grow" />

Variants

All standard visual variants are available for both animation styles by setting the variant property. Alternatively spinners can be custom sized with the style property, or custom CSS classes.

<>
  <Spinner animation="border" variant="primary" />
  <Spinner animation="border" variant="secondary" />
  <Spinner animation="border" variant="success" />
  <Spinner animation="border" variant="danger" />
  <Spinner animation="border" variant="warning" />
  <Spinner animation="border" variant="info" />
  <Spinner animation="border" variant="light" />
  <Spinner animation="border" variant="dark" />
  <Spinner animation="grow" variant="primary" />
  <Spinner animation="grow" variant="secondary" />
  <Spinner animation="grow" variant="success" />
  <Spinner animation="grow" variant="danger" />
  <Spinner animation="grow" variant="warning" />
  <Spinner animation="grow" variant="info" />
  <Spinner animation="grow" variant="light" />
  <Spinner animation="grow" variant="dark" />
</>

Sizing

In addition to the standard size, a smaller additional preconfigured size is available by configuring the size property to sm.

<>
  <Spinner animation="border" size="sm" />
  <Spinner animation="border" />
  <Spinner animation="grow" size="sm" />
  <Spinner animation="grow" />
</>

Buttons

Like the original Bootstrap spinners, these can also be used with buttons. To use this component out-of-the-box it is recommended you change the element type to span by configuring the as property when using spinners inside buttons.

<>
  <Button variant="primary" disabled>
    <Spinner
      as="span"
      animation="border"
      size="sm"
      role="status"
      aria-hidden="true"
    />
    <span className="sr-only">Loading...</span>
  </Button>{' '}
  <Button variant="primary" disabled>
    <Spinner
      as="span"
      animation="grow"
      size="sm"
      role="status"
      aria-hidden="true"
    />
    Loading...
  </Button>
</>

Accessibility

To ensure the maximum accessibility for spinner components it is recommended you provide a relevant ARIA role property, and include screenreader-only readable text representation of the spinner's meaning inside the component using Bootstrap's sr-only class.

The example below provides an example of accessible usage of this component.

<Spinner animation="border" role="status">
  <span className="sr-only">Loading...</span>
</Spinner>

API

Spinner

import Spinner from 'react-bootstrap/Spinner'

Name	Type	Default	Description
animation required	`'border'` \| `'grow'`	`true`	Changes the animation style of the spinner.
as	elementType	`<div>`	You can use a custom element type for this component.
children	element		This component may be used to wrap child elements or components.
role	string		An ARIA accessible role applied to the Menu component. This should generally be set to 'status'
size	`'sm'`		Component size variations.
variant	`'primary'` \| `'secondary'` \| `'success'` \| `'danger'` \| `'warning'` \| `'info'` \| `'light'` \| `'dark'`		The visual color style of the spinner
bsPrefix	string	`'spinner'`	Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css.

© 2014–present Stephen J. Collings, Matthew Honnibal, Pieter Vanderwerff
Licensed under the MIT License (MIT).
https://react-bootstrap.github.io/components/spinners/