Skip to main content

Spin

Ant Design

The Spin component is Ant Design's loading spinner. It tells users that something is in progress, such as a query or a file upload.

Properties​

Property
Description
Expected Value
SpinningShows the spinner. Turn it off to hide it, for example with {{queries.getOrders.isLoading}}.On or off. Default: On
TipText shown under the spinner, such as Loading orders.Text
SizeSize of the spinner.small, default, large. Default: default

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set visibilityShows the component when true, hides it when false.components.spin1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.spin1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.spin1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
spinningShows the spinner. Turn it off to hide it, for example with {{queries.getOrders.isLoading}}.{{components.spin1.spinning}}
tipText shown under the spinner, such as Loading orders.{{components.spin1.tip}}
sizeSize of the spinner.{{components.spin1.size}}
isVisibleWhether the component is visible.{{components.spin1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.spin1.isLoading}}
isDisabledWhether the component is disabled.{{components.spin1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.