Spinner

Overview Style Guidelines Code Demos Accessibility

Installation

Learn more about how to install on our getting started docs.

Red Hat CDN
<script type="module">
  import '@rhds/elements/rh-spinner/rh-spinner.js';
</script>
Import Map Example
<script type="importmap">
  {
    "imports": {
      "@rhds/elements/": "https://www.redhatstatic.com/dx/v1-alpha/@rhds/elements@2.1.0/elements/",
    }
  }
</script>
NPM
npm install @rhds/elements
<script type="module">
  import '@rhds/elements/rh-spinner/rh-spinner.js';
</script>
JSPM
<script type="module">
  import '@rhds/elements/rh-spinner/rh-spinner.js';
</script>
Import Map Example
<script type="importmap">
{
  "imports": {
    "@rhds/elements/rh-spinner/rh-spinner.js": "./elements/rh-spinner/rh-spinner.js"
  },
  "scopes": {
    "./": {
      "@patternfly/pfe-core/controllers/style-controller.js": "https://ga.jspm.io/npm:@patternfly/pfe-core@4.0.2/controllers/style-controller.js",
      "@rhds/tokens/css/color-context-consumer.css.js": "https://ga.jspm.io/npm:@rhds/tokens@2.1.0/css/color-context-consumer.css.js",
      "lit": "https://ga.jspm.io/npm:lit@3.2.0/index.js",
      "lit/": "https://ga.jspm.io/npm:lit@3.2.0/",
      "tslib": "https://ga.jspm.io/npm:tslib@2.7.0/tslib.es6.mjs"
    },
    "https://ga.jspm.io/": {
      "@lit/reactive-element": "https://ga.jspm.io/npm:@lit/reactive-element@2.0.4/development/reactive-element.js",
      "@lit/reactive-element/decorators/": "https://ga.jspm.io/npm:@lit/reactive-element@2.0.4/development/decorators/",
      "lit": "https://ga.jspm.io/npm:lit@3.2.0/index.js",
      "lit-element/lit-element.js": "https://ga.jspm.io/npm:lit-element@4.1.0/development/lit-element.js",
      "lit-html": "https://ga.jspm.io/npm:lit-html@3.2.0/development/lit-html.js",
      "lit-html/": "https://ga.jspm.io/npm:lit-html@3.2.0/development/"
    }
  }
}
</script>

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

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
--rh-color-accent-base-on-light
--rh-color-gray-10
--rh-color-gray-70
--rh-font-family-body-text
--rh-font-size-body-text-lg
--rh-font-size-body-text-md
--rh-font-size-body-text-sm
--rh-font-weight-body-text-regular
--rh-length-2xs
--rh-length-4xl
--rh-length-sm
--rh-length-xs
--rh-line-height-body-text
--rh-size-icon-01
--rh-size-icon-04
--rh-size-icon-06
--rh-space-lg