Spinner

OverviewStyleGuidelinesCodeAccessibilityDemos

Installation

We recommend import maps when building pages with RHDS. Learn more about how to install on our getting started docs.

Red Hat CDN
<script type="importmap">
{
  "imports": {
    "@rhds/elements/": "https://www.redhatstatic.com/dx/v1-alpha/@rhds/elements@2.1.2/elements/",
  }
}
</script>
Copy to Clipboard Wrap lines
NPM
npm install @rhds/elements
Copy to Clipboard Wrap lines
JSPM
<script type="importmap">
Could not generate import map using JSPM: Cannot read properties of undefined (reading '@rhds/elements')
</script>
Copy to Clipboard Wrap lines

Add it to your page with this import statement

<script type="module">
  import '@rhds/elements/rh-spinner/rh-spinner.js';
</script>
Copy to Clipboard Wrap lines

Usage

<rh-spinner></rh-spinner>

<script type="module">
  import '@rhds/elements/rh-spinner/rh-spinner.js';
</script>
Copy to Clipboard Wrap lines

Usage

Default/Large Spinner

<rh-spinner></rh-spinner>

Medium Spinner

<rh-spinner size="md"></rh-spinner>

Small Spinner

<rh-spinner size="sm"></rh-spinner>

rh-spinner

A spinner indicates that an action is in progress. It appears as an animated circle over the section that is loading, and it may include a text label

Slots 1
Slot Name Description

Optional text label below the animated circle.

Attributes 1
Attribute DOM Property Description Type Default
size size

Preset sizes for the spinner

'sm' | 'md' | 'lg'
'lg'
Methods 0
None
Events 0
None
CSS Shadow Parts 0
None
CSS Custom Properties 0
None
Design Tokens 18
Token Copy
--rh-color-accent-base-on-dark
Full CSS Variable Permalink to this token
--rh-color-accent-base-on-light
Full CSS Variable Permalink to this token
--rh-color-gray-10
Full CSS Variable Permalink to this token
--rh-color-gray-70
Full CSS Variable Permalink to this token
--rh-font-family-body-text
Full CSS Variable Permalink to this token
--rh-font-size-body-text-lg
Full CSS Variable Permalink to this token
--rh-font-size-body-text-md
Full CSS Variable Permalink to this token
--rh-font-size-body-text-sm
Full CSS Variable Permalink to this token
--rh-font-weight-body-text-regular
Full CSS Variable Permalink to this token
--rh-length-2xs
Full CSS Variable Permalink to this token
--rh-length-4xl
Full CSS Variable Permalink to this token
--rh-length-sm
Full CSS Variable Permalink to this token
--rh-length-xs
Full CSS Variable Permalink to this token
--rh-line-height-body-text
Full CSS Variable Permalink to this token
--rh-size-icon-01
Full CSS Variable Permalink to this token
--rh-size-icon-04
Full CSS Variable Permalink to this token
--rh-size-icon-06
Full CSS Variable Permalink to this token
--rh-space-lg
Full CSS Variable Permalink to this token