eds-spinner

Explore the Interactive Component

Use the playground below to experiment with the component. Click the button to view the full Storybook deployment for additional examples and configurations.

eds-spinner Open in Storybook

See It in Use with Code

Check out this practical implementation of component.

Plain HTML

In React

In fullscreen={false} a parent div with defined dimensions must exist.

In Vue

With :fullscreen="false" a parent div with defined dimensions must exist.

Overview

EdsSpinner is a loading indicator: a clean ring (brand dark green on light, neon on dark) that overlays its parent container or the full viewport.

Properties

PropertyAttributeDescriptionTypeDefault
backgroundbackgroundBackground of the overlay. Empty by default: inline spinners sit on their container with no box, and a fullscreen spinner covers the page with the solid page surface. Pass any CSS colour to paint your own.stringundefined
fullscreenfullscreenWhen true, the spinner covers the entire viewport — solid by default, so a half-loaded page never shows through (use veil to keep it visible).booleanfalse
messagemessageOptional message displayed below the spinner.stringundefined
sizesizeSize preset: ‘xs’ | ‘sm’ | ‘md’ | ’lg’ | ‘xl’"lg" | "md" | "sm" | "xl" | "xs"'md'
variantvariantColor variant: ‘secondary’ (default) = brand green arc; ‘primary’ = brand black arc (white on dark)."primary" | "secondary"'secondary'
veilveilSee-through cover: a translucent, slightly blurred page veil that keeps the content underneath faintly visible. For loading over content that is already on screen (saving, submitting). Works fullscreen or over the positioned parent. Ignored when background is set.booleanfalse

Dependencies

Used by

Graph

graph TD;
  eds-global-search --> eds-spinner
  eds-kg-learning-resources --> eds-spinner
  style eds-spinner fill:#f9f,stroke:#333,stroke-width:4px

Built with StencilJS