Skeleton骨架屏

在需要等待加载内容的位置提供一个占位图形组合。

何时使用#

  • 网络较慢,需要长时间等待加载处理的情况下。

  • 图文信息内容较多的列表/卡片中。

  • 只适合用在第一次加载数据的场景。

  • 可以被 Spin 完全代替,但是在可用的场景下可以比 Spin 提供更好的视觉效果和用户体验。

代码演示

最简单的占位效果。

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

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

更复杂的组合。

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

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

显示动画效果。

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.

加载占位图包含子组件。

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);

在列表组件中使用加载占位符。

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#

属性说明类型默认值版本
active是否展示动画效果booleanfalse3.9.0
avatar是否显示头像占位图boolean | SkeletonAvatarPropsfalse3.9.0
loadingtrue 时,显示占位图。反之则直接展示子组件boolean-3.9.0
paragraph是否显示段落占位图boolean | SkeletonParagraphPropstrue3.9.0
title是否显示标题占位图boolean | SkeletonTitlePropstrue3.9.0

SkeletonAvatarProps#

属性说明类型默认值版本
size设置头像占位图的大小number | Enum{ 'large', 'small', 'default' }-3.9.0
shape指定头像的形状Enum{ 'circle', 'square' }-3.9.0

SkeletonTitleProps#

属性说明类型默认值版本
width设置标题占位图的宽度number | string-3.9.0

SkeletonParagraphProps#

属性说明类型默认值版本
rows设置段落占位图的行数number-3.9.0
width设置段落占位图的宽度,若为数组时则为对应的每行宽度,反之则是最后一行的宽度number | string | Array<number | string>-3.9.0
Spin加载中Anchor锚点