Skip to content

Commit 39db890

Browse files
author
Zerone
committed
docs: update docs
1 parent 52b0f31 commit 39db890

File tree

2 files changed

+18
-11
lines changed

2 files changed

+18
-11
lines changed

‎README.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ A Vue 3.0 custom directives plugin package, built-in with `v-loading`, `v-skelet
3838
- [Thanks](#thanks)
3939
- [LICENSE](#license)
4040

41-
4241
## Installation
4342

4443
```sh
@@ -374,13 +373,17 @@ app.use(vueDefaultPage, {
374373
| enable | Enable the directive (Enable when [Global Configuration](#global-configuration)) | boolean | false |
375374
| animation | Animation | boolean | true |
376375
| avatarMaxSize | Maximum size of avatar | number / string | 54 |
376+
| zIndex | The stack level of the directive | number / string | 100 |
377+
| background | Background color of the mask | string | #fff |
377378

378379
### VdpSkeletonList
379380

380-
| Name | Description | Type | Default |
381-
| --------- | -------------------------------------------------------------------------------- | ------- | ------- |
382-
| enable | Enable the directive (Enable when [Global Configuration](#global-configuration)) | boolean | false |
383-
| animation | Animation | boolean | true |
381+
| Name | Description | Type | Default |
382+
| ---------- | -------------------------------------------------------------------------------- | --------------- | ------- |
383+
| enable | Enable the directive (Enable when [Global Configuration](#global-configuration)) | boolean | false |
384+
| animation | Animation | boolean | true |
385+
| zIndex | The stack level of the directive | number / string | 100 |
386+
| background | Background color of the mask | string | #fff |
384387

385388
## v-error
386389

@@ -465,7 +468,7 @@ The maximum icon size can be adjusted using the `iconMaxSize` or the `vdp-empty-
465468
| text | Text | string | No Data |
466469
| textColor | Text color | string | #999 |
467470
| icon | Custom icon | string | — |
468-
| miniIcon | Custom mini icon | boolean / string | true |
471+
| miniIcon | Custom mini icon | boolean / string | false |
469472
| iconMaxSize | Maximum size of icon | number / string | 180 |
470473
| iconShowText | Whether to show text when using large | boolean | true |
471474
| zIndex | The stack level of the directive | number / string | 100 |

‎README.zh-CN.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -371,13 +371,17 @@ app.use(vueDefaultPage, {
371371
| enable | 是否使用指令（仅在[全局配置](#全局配置)时生效） | boolean | false |
372372
| animation | 动画 | boolean | true |
373373
| avatarMaxSize | 头像最大尺寸 | number / string | 54 |
374+
| zIndex | 指令的层叠顺序 | number / string | 100 |
375+
| background | 背景遮罩的颜色 | string | #fff |
374376

375377
### VdpSkeletonList 配置项
376378

377-
| 名称 | 说明 | 类型 | 默认值 |
378-
| --------- | ----------------------------------------------- | ------- | ------ |
379-
| enable | 是否使用指令（仅在[全局配置](#全局配置)时生效） | boolean | false |
380-
| animation | 动画 | boolean | true |
379+
| 名称 | 说明 | 类型 | 默认值 |
380+
| ---------- | ----------------------------------------------- | --------------- | ------ |
381+
| enable | 是否使用指令（仅在[全局配置](#全局配置)时生效） | boolean | false |
382+
| animation | 动画 | boolean | true |
383+
| zIndex | 指令的层叠顺序 | number / string | 100 |
384+
| background | 背景遮罩的颜色 | string | #fff |
381385

382386
## v-error
383387

@@ -462,7 +466,7 @@ app.use(vueDefaultPage, {
462466
| text | 文案 | string | No Data |
463467
| textColor | 文案颜色 | string | #999 |
464468
| icon | 自定义图标 | string | — |
465-
| miniIcon | 自定义小图标 | boolean / string | true |
469+
| miniIcon | 自定义小图标 | boolean / string | false |
466470
| iconMaxSize | 图标最大尺寸 | number / string | 180 |
467471
| iconShowText | 大图标时是否显示文案 | boolean | true |
468472
| zIndex | 指令的层叠顺序 | number / string | 100 |

0 commit comments

Comments
 (0)