Back to Vant Weapp

Skeleton 骨架屏

packages/skeleton/README.md

1.11.72.1 KB
Original Source

Skeleton 骨架屏

介绍

用于在内容加载过程中展示一组占位图形。

引入

app.jsonindex.json中引入组件,详细介绍见快速上手

json
"usingComponents": {
  "van-skeleton": "@vant/weapp/skeleton/index"
}

Vant Weapp 1.0 版本开始支持此组件,升级方式参见快速上手

代码演示

基础用法

通过title属性显示标题占位图,通过row属性配置占位段落行数。

html
<van-skeleton title row="3" />

显示头像

通过avatar属性显示头像占位图。

html
<van-skeleton title avatar row="3" />

展示子组件

loading属性设置成false表示内容加载完成,此时会隐藏占位图,并显示Skeleton的子组件。

html
<van-skeleton title avatar row="3" loading="{{ loading }}">
  <view>实际内容</view>
</van-skeleton>
js
Page({
  data: {
    loading: true,
  },
  onReady() {
    this.setData({
      loading: false,
    });
  },
});

API

Props

参数说明类型默认值
row段落占位图行数number0
row-width段落占位图宽度,可传数组来设置每一行的宽度string | string[]100%
title是否显示标题占位图booleanfalse
title-width标题占位图宽度string | number40%
avatar是否显示头像占位图booleanfalse
avatar-size头像占位图大小string | number32px
avatar-shape头像占位图形状,可选值为squarestringround
loading是否显示占位图,传false时会展示子组件内容booleantrue
animate是否开启动画booleantrue

外部样式类

类名说明
custom-class根节点样式类
row-class段落占位样式类
avatar-class头像占位样式类
title-class标题占位样式类