Back to Ant Design

Spin

components/spin/index.zh-CN.md

6.3.72.4 KB
Original Source

何时使用 {#when-to-use}

页面局部处于等待异步数据或正在渲染过程时,合适的加载动效会有效缓解用户的焦虑。

代码演示 {#examples}

<!-- prettier-ignore -->

<code src="./demo/basic.tsx">基本用法</code> <code src="./demo/size.tsx">各种大小</code> <code src="./demo/nested.tsx">卡片加载中</code> <code src="./demo/tip.tsx">自定义描述文案</code> <code src="./demo/delayAndDebounce.tsx">延迟</code> <code src="./demo/custom-indicator.tsx">自定义指示符</code> <code src="./demo/percent.tsx" version="5.18.0">进度</code> <code src="./demo/style-class.tsx" version="6.0.0">自定义语义结构的样式和类</code> <code src="./demo/fullscreen.tsx">全屏</code>

API

通用属性参考:通用属性

参数说明类型默认值版本
classNames用于自定义组件内部各语义化结构的 class,支持对象或函数Record<SemanticDOM, string> | (info: { props }) => Record<SemanticDOM, string>-
delay延迟显示加载效果的时间(防止闪烁)number (毫秒)-
description可以自定义描述文案ReactNode-6.3.0
fullscreen显示带有 Spin 组件的背景booleanfalse5.11.0
indicator加载指示符ReactNode-
percent展示进度,当设置 percent="auto" 时会预估一个永远不会停止的进度number | 'auto'-5.18.0
size组件大小,可选值为 small medium largestringmedium
spinning是否为加载中状态booleantrue
styles用于自定义组件内部各语义化结构的行内 style,支持对象或函数Record<SemanticDOM, CSSProperties> | (info: { props }) => Record<SemanticDOM, CSSProperties>-
tip当作为包裹元素时,可以自定义描述文案。已废弃,请使用 descriptionReactNode-
wrapperClassName包装器的类属性。已废弃,请使用 classNames.rootstring-

静态方法

  • Spin.setDefaultIndicator(indicator: ReactNode)

    你可以自定义全局默认 Spin 的元素。

Semantic DOM

<code src="./demo/_semantic.tsx" simplify="true"></code>

主题变量(Design Token){#design-token}

<ComponentTokenTable component="Spin"></ComponentTokenTable>