Skeleton

Provide a placeholder while you wait for content to load, or to visualise content that doesn't exist yet.

When To Use#

  • When a resource needs long time to load.

  • When the component contains lots of information, such as List or Card.

  • Only works when loading data for the first time.

  • Could be replaced by Spin in any situation, but can provide a better user experience.

Examples

Simplest Skeleton usage.

expand codeexpand code
import { Skeleton } from 'antd';

ReactDOM.render(<Skeleton />, mountNode);

Complex combination with avatar and multiple paragraphs.

expand codeexpand code
import { Skeleton } from 'antd';

ReactDOM.render(<Skeleton avatar paragraph={{ rows: 4 }} />, mountNode);

Display active animation.

expand codeexpand code
import { Skeleton } from 'antd';

ReactDOM.render(<Skeleton active />, mountNode);

Ant Design, a design language

We supply a series of design principles, practical patterns and high quality design resources (Sketch and Axure), to help people create their product prototypes beautifully and efficiently.

Skeleton contains sub component.

expand codeexpand code
import { Skeleton, Button } from 'antd';

class Demo extends React.Component {
  state = {
    loading: false,
  };

  showSkeleton = () => {
    this.setState({ loading: true });
    setTimeout(() => {
      this.setState({ loading: false });
    }, 3000);
  };

  render() {
    return (
      <div className="article">
        <Skeleton loading={this.state.loading}>
          <div>
            <h4>Ant Design, a design language</h4>
            <p>
              We supply a series of design principles, practical patterns and high quality design
              resources (Sketch and Axure), to help people create their product prototypes
              beautifully and efficiently.
            </p>
          </div>
        </Skeleton>
        <Button onClick={this.showSkeleton} disabled={this.state.loading}>
          Show Skeleton
        </Button>
      </div>
    );
  }
}

ReactDOM.render(<Demo />, mountNode);

Use skeleton in list component.

expand codeexpand code
import { Skeleton, Switch, List, Avatar, Icon } from 'antd';

const listData = [];
for (let i = 0; i < 3; i++) {
  listData.push({
    href: 'http://ant.design',
    title: `ant design part ${i}`,
    avatar: 'https://zos.alipayobjects.com/rmsportal/ODTLcjxAfvqbxHnVXCYX.png',
    description:
      'Ant Design, a design language for background applications, is refined by Ant UED Team.',
    content:
      'We supply a series of design principles, practical patterns and high quality design resources (Sketch and Axure), to help people create their product prototypes beautifully and efficiently.',
  });
}

const IconText = ({ type, text }) => (
  <span>
    <Icon type={type} style={{ marginRight: 8 }} />
    {text}
  </span>
);

class App extends React.Component {
  state = {
    loading: true,
  };

  onChange = checked => {
    this.setState({ loading: !checked });
  };

  render() {
    const { loading } = this.state;

    return (
      <div>
        <Switch checked={!loading} onChange={this.onChange} />

        <List
          itemLayout="vertical"
          size="large"
          dataSource={listData}
          renderItem={item => (
            <List.Item
              key={item.title}
              actions={
                !loading && [
                  <IconText type="star-o" text="156" key="skeleton-star-o" />,
                  <IconText type="like-o" text="156" key="skeleton-like-o" />,
                  <IconText type="message" text="2" key="skeleton-message" />,
                ]
              }
              extra={
                !loading && (
                  <img
                    width={272}
                    alt="logo"
                    src="https://gw.alipayobjects.com/zos/rmsportal/mqaQswcyDLcXyDKnZfES.png"
                  />
                )
              }
            >
              <Skeleton loading={loading} active avatar>
                <List.Item.Meta
                  avatar={<Avatar src={item.avatar} />}
                  title={<a href={item.href}>{item.title}</a>}
                  description={item.description}
                />
                {item.content}
              </Skeleton>
            </List.Item>
          )}
        />
      </div>
    );
  }
}

ReactDOM.render(<App />, mountNode);

API#

Skeleton#

PropertyDescriptionTypeDefaultVersion
activeShow animation effectbooleanfalse3.9.0
avatarShow avatar placeholderboolean | SkeletonAvatarPropsfalse3.9.0
loadingDisplay the skeleton when trueboolean-3.9.0
paragraphShow paragraph placeholderboolean | SkeletonParagraphPropstrue3.9.0
titleShow title placeholderboolean | SkeletonTitlePropstrue3.9.0

SkeletonAvatarProps#

PropertyDescriptionTypeDefaultVersion
sizeSet the size of avatarnumber | Enum{ 'large', 'small', 'default' }-3.9.0
shapeSet the shape of avatarEnum{ 'circle', 'square' }-3.9.0

SkeletonTitleProps#

PropertyDescriptionTypeDefaultVersion
widthSet the width of titlenumber | string-3.9.0

SkeletonParagraphProps#

PropertyDescriptionTypeDefaultVersion
rowsSet the row count of paragraphnumber-3.9.0
widthSet the width of paragraph. When width is an Array, it can set the width of each row. Otherwise only set the last row widthnumber | string | Array<number | string>-3.9.0
SpinAnchor