ant-design/components/spin/index.en-US.md
afc163 e027cbec1c
docs: format all markdown (#38629)
* chore: add prettier-ignore in markdown demo

* docs: format markdown api table

* docs: format markdown api table
2022-11-17 17:31:26 +08:00

1.5 KiB

category group title cover demo
Components Feedback Spin https://gw.alipayobjects.com/zos/alicdn/LBcJqCPRv/Spin.svg
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

basic Usage Size Inside a container Embedded mode Customized description delay Custom spinning indicator

API

Property Description Type Default
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 -

Static Method

  • Spin.setDefaultIndicator(indicator: ReactNode)

    You can define default spin element globally.