semi-design/content/feedback/spin/index-en-US.md

---

localeCode: en-US order: 74 category: Feedback title: Spin subTitle: Spin icon: doc-spin

brief: Spin is used to inform the user that the content is loading and may take an uncertain period of time.

Demos

How to import

import { Spin } from '@douyinfe/semi-ui';

Basic usage

import React from 'react';
import { Spin } from '@douyinfe/semi-ui';

() => (
    <div style={{ marginLeft: 30 }}>
        <div style={{ marginBottom: 10 }}>A basic spin.</div>
        <Spin />
    </div>
);

Size

Supports three sizes: large, medium (default), and small.

import React from 'react';
import { Spin } from '@douyinfe/semi-ui';

() => (
    <div style={{ marginLeft: 30 }}>
        <div style={{ marginBottom: 5 }}>size: small</div>
        <Spin size="small" />
        <br />
        <br />
        <div style={{ marginBottom: 10 }}>size: middle</div>
        <Spin size="middle" />
        <br />
        <br />
        <div style={{ marginBottom: 15 }}>size: large</div>
        <Spin size="large" />
    </div>
);

With Description

Use tip to set the description texts when Spin is used as a wrapping element

import React from 'react';
import { Spin } from '@douyinfe/semi-ui';

() => (
    <div>
        <Spin tip="I am loading...">
            <div
                style={{
                    border: '1px solid var(--semi-color-primary)',
                    borderRadius: '4px',
                    paddingLeft: '8px',
                }}
            >
                <p>Here are some texts.</p>
                <p>And more texts on the way.</p>
            </div>
        </Spin>
    </div>
);

Customized Indicator

Use indicator property to customize Spin's indicator style.

import React from 'react';
import { Spin } from '@douyinfe/semi-ui';
import { IconLoading } from '@douyinfe/semi-icons';

() => (
    <div style={{ marginLeft: 30 }}>
        <div>A spin with customized indicator.</div>
        <Spin indicator={<IconLoading />} />
    </div>
);

Delay

Delayed to display Spin.

import React, { useState } from 'react';
import { Spin, Button } from '@douyinfe/semi-ui';

() => {
    const [loading, toggleLoading] = useState(false);

    const toggle = () => {
        toggleLoading(!loading);
    };
    return (
        <div>
            <Button onClick={toggle} style={{ marginRight: 20 }}>
                Delayed spin
            </Button>
            <Spin delay={1000} spinning={loading}></Spin>
        </div>
    );
};

Controlled

Use spinning to determine if the component is in loading status

import React, { useState } from 'react';
import { Spin, Button } from '@douyinfe/semi-ui';

() => {
    const [loading, toggleLoading] = useState(false);

    const toggle = () => {
        toggleLoading(!loading);
    };
    return (
        <div>
            <Button onClick={toggle} style={{ marginRight: 20 }}>
                Controlled Spin
            </Button>
            <Spin spinning={loading}></Spin>
        </div>
    );
};

API Reference

Properties	Instructions	type	Default
childStyle	Inline style for children element v>=1.0.0	CSSProperties	-
delay	Delay timing to display Spin	number(ms)	0
indicator	Indicators	ReactNode	-
size	Size, one of small, middle, large	string	middle
spinning	Toggle whether it is in loading	boolean	true
style	Inline style	CSSProperties	-
tip	Description texts when Spin is used as a wrapping element	ReactNode	-
wrapperClassName	Class name of wrapping element	string	-

Design Tokens

Content Guidelines

• Precisely state the loading status, using words such as "Loading", "Submitting", "Processing", etc.
• Use as few words as possible to describe the state

FAQ

• **How to modify the color of the spin icon? **

  You can overwrite the original color by adding a color property to the .semi-spin-wrapper class.

  .semi-spin-wrapper {
    color: red;
  }