From ac3c5aa9513d0f4826f2a20c04b756d62e861d66 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=B8=8F=E5=AD=A6=E5=90=BE=E7=97=95?= Date: Thu, 24 Jun 2021 09:49:08 +0800 Subject: [PATCH] docs: fix format errors (#8919) * docs: fix format errors * docs: fix format errors --- src/action-bar/README.zh-CN.md | 2 +- src/checkbox/README.md | 4 ++-- src/coupon-list/README.md | 2 +- src/index-bar/README.md | 2 +- src/notice-bar/README.md | 2 +- src/notify/README.md | 6 +++--- src/notify/README.zh-CN.md | 4 ++-- src/tab/README.md | 2 +- src/toast/README.zh-CN.md | 2 +- 9 files changed, 13 insertions(+), 13 deletions(-) diff --git a/src/action-bar/README.zh-CN.md b/src/action-bar/README.zh-CN.md index 6f53d61e2..3debb8f36 100644 --- a/src/action-bar/README.zh-CN.md +++ b/src/action-bar/README.zh-CN.md @@ -113,7 +113,7 @@ export default { ### ActionBarButton Props | 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | --- | +| --- | --- | --- | --- | | text | 按钮文字 | _string_ | - | | type | 按钮类型，可选值为 `primary` `info` `warning` `danger` | _string_ | `default` | | color | 按钮颜色，支持传入 `linear-gradient` 渐变色 | _string_ | - | diff --git a/src/checkbox/README.md b/src/checkbox/README.md index d78f97e72..813f50944 100644 --- a/src/checkbox/README.md +++ b/src/checkbox/README.md @@ -246,7 +246,7 @@ export default { ### Checkbox Props | Attribute | Description | Type | Default | -| --- | --- | --- | --- | --- | +| --- | --- | --- | --- | | v-model | Check status | _boolean_ | `false` | | name | Checkbox name | _any_ | - | | shape | Can be set to `square` | _string_ | `round` | @@ -260,7 +260,7 @@ export default { ### CheckboxGroup Props | Attribute | Description | Type | Default | -| --- | --- | --- | --- | --- | +| --- | --- | --- | --- | | v-model | Names of all checked checkboxes | _any[]_ | - | | disabled | Whether to disable all checkboxes | _boolean_ | `false` | | max | Maximum amount of checked options | _number \| string_ | `0`(Unlimited) | diff --git a/src/coupon-list/README.md b/src/coupon-list/README.md index 76ac52014..85fcce404 100644 --- a/src/coupon-list/README.md +++ b/src/coupon-list/README.md @@ -102,7 +102,7 @@ export default { ### CouponList Props | Attribute | Description | Type | Default | -| --- | --- | --- | --- | --- | +| --- | --- | --- | --- | | v-model | Current exchange code | _string_ | - | | chosen-coupon | Index of chosen coupon | _number_ | `-1` | | coupons | Coupon list | _Coupon[]_ | `[]` | diff --git a/src/index-bar/README.md b/src/index-bar/README.md index e7f358f53..fb66ee6c9 100644 --- a/src/index-bar/README.md +++ b/src/index-bar/README.md @@ -70,7 +70,7 @@ export default { ### IndexBar Props | Attribute | Description | Type | Default | -| --- | --- | --- | --- | --- | +| --- | --- | --- | --- | | index-list | Index List | _string[] \| number[]_ | `A-Z` | | z-index | z-index | _number \| string_ | `1` | | sticky | Whether to enable anchor sticky top | _boolean_ | `true` | diff --git a/src/notice-bar/README.md b/src/notice-bar/README.md index f5d94118c..02662dd17 100644 --- a/src/notice-bar/README.md +++ b/src/notice-bar/README.md @@ -88,7 +88,7 @@ app.use(NoticeBar); ### Props | Attribute | Description | Type | Default | -| --- | --- | --- | --- | --- | +| --- | --- | --- | --- | | mode | Mode, can be set to `closeable` `link` | _string_ | `''` | | text | Notice text content | _string_ | `''` | - | | color | Text color | _string_ | `#f60` | diff --git a/src/notify/README.md b/src/notify/README.md index 780a6958b..44714e567 100644 --- a/src/notify/README.md +++ b/src/notify/README.md @@ -97,8 +97,8 @@ export default { ### Methods | Methods | Attribute | Return value | Description | -| --- | --- | --- | --- | --- | -| Notify | `options | message` | notify instance | Show notify | +| --- | --- | --- | --- | +| Notify | `options \| message` | notify instance | Show notify | | Notify.clear | - | `void` | Close notify | | Notify.setDefaultOptions | `options` | `void` | Set default options of all notifies | | Notify.resetDefaultOptions | - | `void` | Reset default options of all notifies | @@ -106,7 +106,7 @@ export default { ### Options | Attribute | Description | Type | Default | -| --- | --- | --- | --- | --- | +| --- | --- | --- | --- | | type | Can be set to `primary` `success` `warning` | _string_ | `danger` | | message | Message | _string_ | - | | duration | Duration(ms), won't disappear if value is 0 | _number \| string_ | `3000` | diff --git a/src/notify/README.zh-CN.md b/src/notify/README.zh-CN.md index 5b159be6e..e0365823d 100644 --- a/src/notify/README.zh-CN.md +++ b/src/notify/README.zh-CN.md @@ -130,8 +130,8 @@ export default { ### 方法 | 方法名 | 说明 | 参数 | 返回值 | -| --- | --- | --- | --- | --- | -| Notify | 展示提示 | `options | message` | notify 实例 | +| --- | --- | --- | --- | +| Notify | 展示提示 | `options \| message` | notify 实例 | | Notify.clear | 关闭提示 | - | `void` | | Notify.setDefaultOptions | 修改默认配置，对所有 Notify 生效 | `options` | `void` | | Notify.resetDefaultOptions | 重置默认配置，对所有 Notify 生效 | - | `void` | diff --git a/src/tab/README.md b/src/tab/README.md index 43896cede..038a7aa73 100644 --- a/src/tab/README.md +++ b/src/tab/README.md @@ -233,7 +233,7 @@ export default { ### Tabs Props | Attribute | Description | Type | Default | -| --- | --- | --- | --- | --- | +| --- | --- | --- | --- | | v-model:active | Index of active tab | _number \| string_ | `0` | | type | Can be set to `line` `card` | _string_ | `line` | | color | Tab color | _string_ | `#ee0a24` | diff --git a/src/toast/README.zh-CN.md b/src/toast/README.zh-CN.md index ed1764809..1f77e71d6 100644 --- a/src/toast/README.zh-CN.md +++ b/src/toast/README.zh-CN.md @@ -165,7 +165,7 @@ Toast.resetDefaultOptions('loading'); ### Options | 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | --- | +| --- | --- | --- | --- | | type | 提示类型，可选值为 `loading` `success`
`fail` `html` | _string_ | `text` | | position | 位置，可选值为 `top` `bottom` | _string_ | `middle` | | message | 文本内容，支持通过`\n`换行 | _string_ | `''` | - |