mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-11 23:00:20 +08:00
fb0b4f0fc9
* docs: add api first appearance * docs: fix auto-complete doc * docs: replace Version Added with Version * docs: date picker common method * docs: date picker common method * docs: tree * docs: remove meaningless 3.0.0
28 lines
1.0 KiB
Markdown
28 lines
1.0 KiB
Markdown
---
|
|
category: Components
|
|
type: Feedback
|
|
title: Spin
|
|
---
|
|
|
|
A spinner for displaying loading state of a page or a section.
|
|
|
|
## 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.
|
|
|
|
## API
|
|
|
|
| Property | Description | Type | Default Value | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| delay | specifies a delay in milliseconds for loading state (prevent flush) | number (milliseconds) | - | |
|
|
| indicator | React node of the spinning indicator | ReactElement | - | |
|
|
| size | size of Spin, options: `small`, `default` and `large` | string | `default` | |
|
|
| spinning | whether Spin is spinning | boolean | true | |
|
|
| tip | customize description content when Spin has children | string | - | |
|
|
| wrapperClassName | className of wrapper when Spin has children | string | - | |
|
|
|
|
### Static Method
|
|
|
|
- `Spin.setDefaultIndicator(indicator: ReactElement)`
|
|
As `indicator`, you can define the global default spin element
|