docs: prettier all markdown files

2020-04-11 09:17:33 +08:00
parent 48067f79db
commit 7f84f8a487
140 changed files with 4441 additions and 4723 deletions
@@ -30,9 +30,9 @@ Vue.use(Dialog);
 // 局部注册
 export default {
  components: {
-    [Dialog.Component.name]: Dialog.Component
-  }
-}
+    [Dialog.Component.name]: Dialog.Component,
+  },
+};
 ```

 ## 代码演示
@@ -44,13 +44,13 @@ export default {
 ```js
 Dialog.alert({
  title: '标题',
-  message: '弹窗内容'
+  message: '弹窗内容',
 }).then(() => {
  // on close
 });

 Dialog.alert({
-  message: '弹窗内容'
+  message: '弹窗内容',
 }).then(() => {
  // on close
 });
@@ -63,12 +63,14 @@ Dialog.alert({
 ```js
 Dialog.confirm({
  title: '标题',
-  message: '弹窗内容'
-}).then(() => {
-  // on confirm
-}).catch(() => {
-  // on cancel
-});
+  message: '弹窗内容',
+})
+  .then(() => {
+    // on confirm
+  })
+  .catch(() => {
+    // on cancel
+  });
 ```

 ### 异步关闭
@@ -85,22 +87,22 @@ function beforeClose(action, done) {
 Dialog.confirm({
  title: '标题',
  message: '弹窗内容',
-  beforeClose
+  beforeClose,
 });
 ```

 ### 全局方法

-引入 Dialog 组件后，会自动在 Vue 的 prototype 上挂载 $dialog 方法，在所有组件内部都可以直接调用此方法
+引入 Dialog 组件后，会自动在 Vue 的 prototype 上挂载 \$dialog 方法，在所有组件内部都可以直接调用此方法

 ```js
 export default {
  mounted() {
    this.$dialog.alert({
-      message: '弹窗内容'
+      message: '弹窗内容',
    });
-  }
-}
+  },
+};
 ```

 ### 组件调用
@@ -109,7 +111,7 @@ export default {

 ```html
 <van-dialog v-model="show" title="标题" show-cancel-button>
-  <img src="https://img.yzcdn.cn/vant/apple-3.jpg">
+  <img src="https://img.yzcdn.cn/vant/apple-3.jpg" />
 </van-dialog>
 ```

@@ -117,19 +119,18 @@ export default {
 export default {
  data() {
    return {
-      show: false
+      show: false,
    };
-  }
-}
+  },
+};
 ```

-
 ## API

 ### 方法

 | 方法名 | 说明 | 参数 | 返回值 |
-|------|------|------|------|
+| --- | --- | --- | --- |
 | Dialog | 展示弹窗 | `options` | `Promise` |
 | Dialog.alert | 展示消息提示弹窗 | `options` | `Promise` |
 | Dialog.confirm | 展示消息确认弹窗 | `options` | `Promise` |
@@ -142,74 +143,74 @@ export default {
 通过函数调用 `Dialog` 时，支持传入以下选项：

 | 参数 | 说明 | 类型 | 默认值 |
-|------|------|------|------|
-| title | 标题 | *string* | - |
-| width `v2.2.7` | 弹窗宽度，默认单位为`px` | *number \| string* | `320px` |
-| message | 文本内容，支持通过`\n`换行 | *string* | - |
-| messageAlign | 内容对齐方式，可选值为`left` `right` | *string* | `center` |
-| className | 自定义类名 | *any* | - |
-| showConfirmButton | 是否展示确认按钮 | *boolean* | `true` |
-| showCancelButton | 是否展示取消按钮 | *boolean* | `false` |
-| confirmButtonText | 确认按钮文案 | *string* | `确认` |
-| confirmButtonColor | 确认按钮颜色 | *string* | `#1989fa` |
-| cancelButtonText | 取消按钮文案 | *string* | `取消` |
-| cancelButtonColor | 取消按钮颜色 | *string* | `black` |
-| overlay | 是否展示遮罩层 | *boolean* | `true` |
-| overlayClass `v2.2.7` | 自定义遮罩层类名 | *string* | - |
-| overlayStyle `v2.2.7` | 自定义遮罩层样式 | *object* | - |
-| closeOnPopstate `v2.0.5` | 是否在页面回退时自动关闭 | *boolean* | `false` |
-| closeOnClickOverlay | 是否在点击遮罩层后关闭弹窗 | *boolean* | `false` |
-| lockScroll | 是否锁定背景滚动 | *boolean* | `true` |
-| beforeClose | 关闭前的回调函数，<br>调用 done() 后关闭弹窗，<br>调用 done(false) 阻止弹窗关闭 | *(action, done) => void* | - |
-| transition `v2.2.6` | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | *string* | - |
-| getContainer | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | `body` |
+| --- | --- | --- | --- |
+| title | 标题 | _string_ | - |
+| width `v2.2.7` | 弹窗宽度，默认单位为`px` | _number \| string_ | `320px` |
+| message | 文本内容，支持通过`\n`换行 | _string_ | - |
+| messageAlign | 内容对齐方式，可选值为`left` `right` | _string_ | `center` |
+| className | 自定义类名 | _any_ | - |
+| showConfirmButton | 是否展示确认按钮 | _boolean_ | `true` |
+| showCancelButton | 是否展示取消按钮 | _boolean_ | `false` |
+| confirmButtonText | 确认按钮文案 | _string_ | `确认` |
+| confirmButtonColor | 确认按钮颜色 | _string_ | `#1989fa` |
+| cancelButtonText | 取消按钮文案 | _string_ | `取消` |
+| cancelButtonColor | 取消按钮颜色 | _string_ | `black` |
+| overlay | 是否展示遮罩层 | _boolean_ | `true` |
+| overlayClass `v2.2.7` | 自定义遮罩层类名 | _string_ | - |
+| overlayStyle `v2.2.7` | 自定义遮罩层样式 | _object_ | - |
+| closeOnPopstate `v2.0.5` | 是否在页面回退时自动关闭 | _boolean_ | `false` |
+| closeOnClickOverlay | 是否在点击遮罩层后关闭弹窗 | _boolean_ | `false` |
+| lockScroll | 是否锁定背景滚动 | _boolean_ | `true` |
+| beforeClose | 关闭前的回调函数，<br>调用 done() 后关闭弹窗，<br>调用 done(false) 阻止弹窗关闭 | _(action, done) => void_ | - |
+| transition `v2.2.6` | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | _string_ | - |
+| getContainer | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| () => Element_ | `body` |

 ### Props

 通过组件调用 `Dialog` 时，支持以下 Props：

 | 参数 | 说明 | 类型 | 默认值 |
-|------|------|------|------|
-| v-model | 是否显示弹窗 | *boolean* | - |
-| title | 标题 | *string* | - |
-| width `v2.2.7` | 弹窗宽度，默认单位为`px` | *number \| string* | `320px` |
-| message | 文本内容，支持通过`\n`换行 | *string* | - |
-| message-align | 内容对齐方式，可选值为`left` `right` | *string* | `center` |
-| show-confirm-button | 是否展示确认按钮 | *boolean* |  `true` |
-| show-cancel-button | 是否展示取消按钮 | *boolean* |  `false` |
-| confirm-button-text | 确认按钮文案 | *string* | `确认` |
-| confirm-button-color | 确认按钮颜色 | *string* | `#1989fa` |
-| cancel-button-text | 取消按钮文案 | *string* | `取消` |
-| cancel-button-color | 取消按钮颜色 | *string* | `black` |
-| overlay | 是否展示遮罩层 | *boolean* | `true` |
-| overlay-class `v2.2.7` | 自定义遮罩层类名 | *string* | - |
-| overlay-style `v2.2.7` | 自定义遮罩层样式 | *object* | - |
-| close-on-popstate `v2.0.5` | 是否在页面回退时自动关闭 | *boolean* | `false` |
-| close-on-click-overlay | 是否在点击遮罩层后关闭弹窗 | *boolean* | `false` |
-| lazy-render | 是否在显示弹层时才渲染节点 | *boolean* | `true` |
-| lock-scroll | 是否锁定背景滚动 | *boolean* | `true` |
-| before-close | 关闭前的回调函数，<br>调用 done() 后关闭弹窗，<br>调用 done(false) 阻止弹窗关闭 | *(action, done) => void* | - |
-| transition `v2.2.6` | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | *string* | - |
-| get-container | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | - |
+| --- | --- | --- | --- |
+| v-model | 是否显示弹窗 | _boolean_ | - |
+| title | 标题 | _string_ | - |
+| width `v2.2.7` | 弹窗宽度，默认单位为`px` | _number \| string_ | `320px` |
+| message | 文本内容，支持通过`\n`换行 | _string_ | - |
+| message-align | 内容对齐方式，可选值为`left` `right` | _string_ | `center` |
+| show-confirm-button | 是否展示确认按钮 | _boolean_ | `true` |
+| show-cancel-button | 是否展示取消按钮 | _boolean_ | `false` |
+| confirm-button-text | 确认按钮文案 | _string_ | `确认` |
+| confirm-button-color | 确认按钮颜色 | _string_ | `#1989fa` |
+| cancel-button-text | 取消按钮文案 | _string_ | `取消` |
+| cancel-button-color | 取消按钮颜色 | _string_ | `black` |
+| overlay | 是否展示遮罩层 | _boolean_ | `true` |
+| overlay-class `v2.2.7` | 自定义遮罩层类名 | _string_ | - |
+| overlay-style `v2.2.7` | 自定义遮罩层样式 | _object_ | - |
+| close-on-popstate `v2.0.5` | 是否在页面回退时自动关闭 | _boolean_ | `false` |
+| close-on-click-overlay | 是否在点击遮罩层后关闭弹窗 | _boolean_ | `false` |
+| lazy-render | 是否在显示弹层时才渲染节点 | _boolean_ | `true` |
+| lock-scroll | 是否锁定背景滚动 | _boolean_ | `true` |
+| before-close | 关闭前的回调函数，<br>调用 done() 后关闭弹窗，<br>调用 done(false) 阻止弹窗关闭 | _(action, done) => void_ | - |
+| transition `v2.2.6` | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | _string_ | - |
+| get-container | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| () => Element_ | - |

 ### Events

 通过组件调用 `Dialog` 时，支持以下事件：

-| 事件 | 说明 | 回调参数 |
-|------|------|------|
-| confirm | 点击确认按钮时触发 | - |
-| cancel | 点击取消按钮时触发 | - |
-| open | 打开弹窗时触发 | - |
-| close | 关闭弹窗时触发 | - |
-| opened | 打开弹窗且动画结束后触发 | - |
-| closed | 关闭弹窗且动画结束后触发 | - |
+| 事件    | 说明                     | 回调参数 |
+| ------- | ------------------------ | -------- |
+| confirm | 点击确认按钮时触发       | -        |
+| cancel  | 点击取消按钮时触发       | -        |
+| open    | 打开弹窗时触发           | -        |
+| close   | 关闭弹窗时触发           | -        |
+| opened  | 打开弹窗且动画结束后触发 | -        |
+| closed  | 关闭弹窗且动画结束后触发 | -        |

 ### Slots

 通过组件调用 `Dialog` 时，支持以下插槽：

-| 名称 | 说明 |
-|------|------|
+| 名称    | 说明       |
+| ------- | ---------- |
 | default | 自定义内容 |
-| title | 自定义标题 |
+| title   | 自定义标题 |