mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-05 01:19:45 +08:00
cc223a102c
* feat: start the implementation of the fullscreen prop in Spin * docs: change main spin demo * docs: enhance demo * test: update snapshot * fix: address pr comments * fix: use logical property on fullscreen class * fix: address pr review * feat: Added background color token * fix: remove onClick and change demo * feat: change spin to white when fullcreen also use the bgmask as background, removing the bgColor token * fix: unused import * test: update snapshot * Update components/spin/style/index.tsx Signed-off-by: lijianan <574980606@qq.com> * fix: use white color from token * fix: not needed interpolation and version * fix: address pr review * fix: tip prop was not working * test: cover tip & fullscreen case * fix: addrress pr coments --------- Signed-off-by: lijianan <574980606@qq.com> Co-authored-by: lijianan <574980606@qq.com> Co-authored-by: MadCcc <1075746765@qq.com>
52 lines
1.9 KiB
Markdown
52 lines
1.9 KiB
Markdown
---
|
||
category: Components
|
||
group: Feedback
|
||
title: Spin
|
||
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*5mC5TomY4B0AAAAAAAAAAAAADrJ8AQ/original
|
||
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*i43_ToFrL8YAAAAAAAAAAAAADrJ8AQ/original
|
||
demo:
|
||
cols: 2
|
||
---
|
||
|
||
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.
|
||
|
||
## Examples
|
||
|
||
<!-- prettier-ignore -->
|
||
<code src="./demo/basic.tsx">Basic Usage</code>
|
||
<code src="./demo/size.tsx">Size</code>
|
||
<code src="./demo/inside.tsx">Inside a container</code>
|
||
<code src="./demo/nested.tsx">Embedded mode</code>
|
||
<code src="./demo/tip.tsx">Customized description</code>
|
||
<code src="./demo/delayAndDebounce.tsx">Delay</code>
|
||
<code src="./demo/custom-indicator.tsx">Custom spinning indicator</code>
|
||
<code src="./demo/fullscreen.tsx">Fullscreen</code>
|
||
|
||
## API
|
||
|
||
Common props ref：[Common props](/docs/react/common-props)
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| delay | Specifies a delay in milliseconds for loading state (prevent flush) | number (milliseconds) | - |
|
||
| indicator | React node of the spinning indicator | ReactNode | - |
|
||
| 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 | - |
|
||
| fullscreen | Display a backdrop with the `Spin` component | boolean | false | 5.11.0 |
|
||
|
||
### Static Method
|
||
|
||
- `Spin.setDefaultIndicator(indicator: ReactNode)`
|
||
|
||
You can define default spin element globally.
|
||
|
||
## Design Token
|
||
|
||
<ComponentTokenTable component="Spin"></ComponentTokenTable>
|