ant-design/components/spin/index.en-US.md

27 lines
1002 B
Markdown
Raw Normal View History

---
category: Components
type: Feedback
title: Spin
---
2017-01-07 22:07:09 +08:00
A spinner for displaying loading state of a page or a section.
2016-09-10 13:43:30 +08:00
## When To Use
2016-11-29 17:13:24 +08:00
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 |
| --- | --- | --- | --- |
| 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