Spin

Lightweight loading indicator with size presets, a determinate progress ring, a neural loading style, and a children overlay mode.

import { Spin } from '@lobehub/ui/base-ui';

NPM Source Edit

Feedback

Basic

Loading preview

APIs

Spin properties

children: null | string | number | bigint | false | true | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Promise<AwaitedReactNode>
indicator: null | string | number | bigint | false | true | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Promise<AwaitedReactNode>
percent: number
ref: null | (instance: HTMLDivElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES] | RefObject<HTMLDivElement | null>
Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).
size: number | 'small' | 'middle' | 'large'
Defaults to "middle".
spinning: boolean
Defaults to true.
style: CSSProperties
tip: null | string | number | bigint | false | true | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Promise<AwaitedReactNode>
variant: 'default' | 'neural'
Defaults to "default".

Also accepts all native HTML and ARIA attributes.

Spin renders a native <div>. All standard div HTML attributes including className, style, data-*, and ref are forwarded to the root element.

Sizes

size accepts small (14px), middle (20px, default), large (32px), or any raw pixel number.

Determinate progress

Pass percent (0–100) with the default variant to render a progress ring driven by stroke-dashoffset instead of the spinning glyph.

Neural variant

variant="neural" renders a lightweight travelling-particle glyph instead of the default LoaderCircle spinner.

Overlaying content

When children is provided, Spin wraps it in a relative container and overlays a centered spinner (plus optional tip) on top while spinning is true. Set spinning={false} to render only the children.

Migrating from antd Spin

import { Spin } from '@lobehub/ui/base-ui';

<Spin spinning={loading} tip="Loading…">
  <Content />
</Spin>;

delay and fullscreen are not supported; gate spinning yourself and use Spin inside your own fullscreen container if needed.

antd's size="default" becomes size="middle".