Spin
Importimport{ Spin }from"antd"; |
Sourcecomponents/spin |
When To Use
When part of the page is waiting for asynchronous data or during a rendering process, an appropriate loading animation can effectively alleviate users' inquietude.
Examples
A simple loading status.
Loading state：
Embedding content into Spin will set it into loading state.
Loading state：
Specifies a delay for loading state. If spinning ends during delay, loading status won't appear.
Show the progress. When percent="auto" is set, an indeterminate progress will be displayed.
A small Spin is used for loading text, default sized Spin for loading a card-level block, and large Spin used for loading a page.
Customize the description text.
Use custom loading indicator.
The fullscreen mode is perfect for creating page loaders. It adds a dimmed overlay with a centered spinner.
API
Common props ref：Common props
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| delay | Specifies a delay in milliseconds for loading state (prevent flush) | number (milliseconds) | - | |
| fullscreen | Display a backdrop with the Spin component | boolean | false | 5.11.0 |
| indicator | React node of the spinning indicator | ReactNode | - | |
| percent | The progress percentage, when set to auto, it will be an indeterminate progress | number | 'auto' | - | 5.18.0 |
| size | The size of Spin, options: small, default and large | string | default | |
| spinning | Whether Spin is visible | boolean | true | |
| tip | Customize description content when Spin has children | ReactNode | - | |
| wrapperClassName | The className of wrapper when Spin has children | string | - |
Static Method
Spin.setDefaultIndicator(indicator: ReactNode)You can define default spin element globally.
Design Token
Component TokenHow to use?
| Token Name | Description | Type | Default Value |
|---|---|---|---|
| contentHeight | Height of content area | string | number | 400 |
| dotSize | Loading icon size | number | 20 |
| dotSizeLG | Large loading icon size | number | 32 |
| dotSizeSM | Small loading icon size | number | 14 |