ant-design/components/spin/index.en-US.md
Dennis273 d12614fdbb
docs(Spin): fix en-US description of spinning prop (#34382)
Previous description indicates that Spin is visible but not spinning when `spinning === false`. According to ZH-CN doc, Spin is not visible when `spinning === false`.
2022-03-09 16:46:52 +08:00

1.0 KiB

category type title cover
Components Feedback Spin 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
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.