Enact

moonstone/Spinner

Exports the moonstone/Spinner.Spinner and moonstone/Spinner.SpinnerBase components. The default export is moonstone/Spinner.Spinner.

import Spinner from '@enact/moonstone/Spinner';

Members

SpinnerComponent

moonstone/Spinner.Spinner wraps moonstone/Spinner.SpinnerBase to make sure spotlight is paused when blockClickOn prop is 'screen', and resume spotlight when unmounted. However, spotlight is not paused when blockClickOn prop is 'container'. Blocking spotlight within the container is up to app implementation.

import Spinner from '@enact/moonstone/Spinner';
Properties
blockClickOn
String

Click event blocking type. It can be either 'screen', 'container', or null. 'screen' pauses spotlight.

Default: null

SpinnerBaseComponent

moonstone/Spinner.SpinnerBase is a component that shows a spinning animation to indicate that some activity is taking place. Optionally, a scrim may be applied and clicks to underlying components may be blocked.

import {SpinnerBase} from '@enact/moonstone/Spinner';
Properties
blockClickOn
String

Determines how far the click-blocking should extend. It can be 'screen', 'container', or null. 'screen' blocks entire screen. 'container' blocks up to the nearest ancestor with absolute or relative positioning. When blockClickOn is either 'screen' or 'container', a translucent scrim can be added by setting scrim prop to true.

centered
Boolean

When true, the spinner is horizontally and vertically centered, relative to its containing component.

Default: false
children
String

The optional string to be displayed as the main content of the spinner.

scrim
Boolean

When true, sets visible translucent scrim behind spinner only when blockClickOn is 'screen' or 'container'. Scrim has no effect by default or when blockClickOn is null.

Default: false
transparent
Boolean

When true, the background-color of the spinner is transparent.

Default: false
ArrayBooleanFunctionModuleNumberObjectString