Light Dark System

Spinner

<sl-spinner> | SlSpinner
Since 2.0 stable

Spinners are used to show the progress of an indeterminate operation.

<sl-spinner></sl-spinner>

import { SlSpinner } from '@shoelace-style/shoelace/dist/react';

const App = () => <SlSpinner />;

Examples

Size

Spinners are sized based on the current font size. To change their size, set the font-size property on the spinner itself or on a parent element as shown below. 

<sl-spinner></sl-spinner>
<sl-spinner style="font-size: 2rem;"></sl-spinner>
<sl-spinner style="font-size: 3rem;"></sl-spinner>

import { SlSpinner } from '@shoelace-style/shoelace/dist/react';

const App = () => (
  <>
    <SlSpinner />
    <SlSpinner style={{ fontSize: '2rem' }} />
    <SlSpinner style={{ fontSize: '3rem' }} />
  </>
);

Track Width

The width of the spinner’s track can be changed by setting the --track-width custom property. 

<sl-spinner style="font-size: 50px; --track-width: 10px;"></sl-spinner>

import { SlSpinner } from '@shoelace-style/shoelace/dist/react';

const App = () => (
  <SlSpinner
    style={{
      fontSize: '3rem',
      '--track-width': '6px'
    }}
  />
);

Color

The spinner’s colors can be changed by setting the --indicator-color and --track-color custom properties. 

<sl-spinner style="font-size: 3rem; --indicator-color: deeppink; --track-color: pink;"></sl-spinner>

import { SlSpinner } from '@shoelace-style/shoelace/dist/react';

const App = () => (
  <SlSpinner
    style={{
      fontSize: '3rem',
      '--indicator-color': 'deeppink',
      '--track-color': 'pink'
    }}
  />
);

Importing

If you’re using the autoloader or the traditional loader, you can ignore this section. Otherwise, feel free to use any of the following snippets to cherry pick this component.

Script Import Bundler React

To import this component from the CDN using a script tag: 

<script type="module" src="https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace@2.5.2/cdn/components/spinner/spinner.component.js"></script>

To import this component from the CDN using a JavaScript import: 

import 'https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace@2.5.2/cdn/components/spinner/spinner.component.js';

To import this component using a bundler:

import '@shoelace-style/shoelace/dist/components/spinner/spinner.component.js';

To import this component as a React component:

import { SlSpinner } from '@shoelace-style/shoelace/dist/react';

Custom Properties

Name Description Default
--track-width The width of the track.
--track-color The color of the track.
--indicator-color The color of the spinner’s indicator.
--speed The time it takes for the spinner to complete one animation cycle.

Learn more about customizing CSS custom properties.

Parts

Name Description
base The component’s base wrapper.

Learn more about customizing CSS parts.