vant/src/skeleton/README.zh-CN.md
2021-03-18 11:23:49 +08:00

95 lines
2.6 KiB
Markdown

# Skeleton 骨架屏
### 介绍
用于在内容加载过程中展示一组占位图形。
### 引入
通过以下方式来全局注册组件,更多注册方式请参考[组件注册](#/zh-CN/advanced-usage#zu-jian-zhu-ce)。
```js
import { createApp } from 'vue';
import { Skeleton } from 'vant';
const app = createApp();
app.use(Skeleton);
```
## 代码演示
### 基础用法
通过 `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">
<div>实际内容</div>
</van-skeleton>
```
```js
import { ref, onMounted } from 'vue';
export default {
setup() {
const loading = ref(true);
onMounted(() => {
loading.value = false;
});
return {
loading,
};
},
};
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| row | 段落占位图行数 | _number \| string_ | `0` |
| row-width | 段落占位图宽度,可传数组来设置每一行的宽度 | _number \| string \|<br>(number \| string)[]_ | `100%` |
| title | 是否显示标题占位图 | _boolean_ | `false` |
| avatar | 是否显示头像占位图 | _boolean_ | `false` |
| loading | 是否显示骨架屏,传 `false` 时会展示子组件内容 | _boolean_ | `true` |
| animate | 是否开启动画 | _boolean_ | `true` |
| round | 是否将标题和段落显示为圆角风格 | _boolean_ | `false` |
| title-width | 标题占位图宽度 | _number \| string_ | `40%` |
| avatar-size | 头像占位图大小 | _number \| string_ | `32px` |
| avatar-shape | 头像占位图形状,可选值为 `square` | _string_ | `round` |
### 样式变量
组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。
| 名称 | 默认值 | 描述 |
| --------------------------------- | --------------- | ---- |
| @skeleton-row-height | `16px` | - |
| @skeleton-row-background-color | `@active-color` | - |
| @skeleton-row-margin-top | `@padding-sm` | - |
| @skeleton-title-width | `40%` | - |
| @skeleton-avatar-size | `32px` | - |
| @skeleton-avatar-background-color | `@active-color` | - |
| @skeleton-animation-duration | `1.2s` | - |