[improvement] rename packages dir to src (#3659)

2019-06-27 11:25:57 +08:00
parent 8489918dca
commit 75c79b7044
619 changed files with 21 additions and 21 deletions
@@ -0,0 +1,71 @@
+# Skeleton 骨架屏
+
+### 引入
+
+``` javascript
+import { Skeleton } from 'vant';
+
+Vue.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
+export default {
+  data() {
+    return {
+      loading: true
+    }
+  },
+  mounted() {
+    this.loading = false;
+  }
+};
+```
+
+## API
+
+### Props
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 |
+|------|------|------|------|------|
+| row | 段落占位图行数 | `Number` | `0` | - |
+| row-width | 段落占位图宽度，可传数组来设置每一行的宽度 | `Number | String | Array` | `100%` | - |
+| title | 是否显示标题占位图 | `Boolean` | `false` | - |
+| title-width | 标题占位图宽度 | `Number | String` | `40%` | - |
+| avatar | 是否显示头像占位图 | `Boolean` | `false` | - |
+| avatar-size | 头像占位图大小 | `Number | String` | `32px` | - |
+| avatar-shape | 头像占位图形状，可选值为`square` | `String` | `round` | - |
+| loading | 是否显示占位图，传`false`时会展示子组件内容 | `Boolean` | `true` | - |
+| animate | 是否开启动画 | `Boolean` | `true` | - |