mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-23 23:18:36 +08:00
882cec62d6
* docs: Add components overview page * fix detail * remove ContributorsList form overview page * fix components url * improve code style * remove extra file * fix detail * fix lint * fix lint * docs: Finish components overview page * fix lint * docs: Update cover * fix lint * update cover * update menu * improve overview page * refactor code * fix order * update title * add components count * fix overview page ssr bug * move less file * update title margin Co-authored-by: arvinxx <arvinx@foxmail.com>
30 lines
1.0 KiB
Markdown
30 lines
1.0 KiB
Markdown
---
|
|
category: Components
|
|
type: Feedback
|
|
title: Spin
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/LBcJqCPRv/Spin.svg
|
|
---
|
|
|
|
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 |
|
|
| --- | --- | --- | --- |
|
|
| delay | specifies a delay in milliseconds for loading state (prevent flush) | number (milliseconds) | - |
|
|
| indicator | React node of the spinning indicator | ReactNode | - |
|
|
| 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: ReactNode)`
|
|
|
|
You can define default spin element globally.
|