alighasami/vant
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: prettier all markdown files

Browse Source
This commit is contained in:
chenjiahan
2020-04-11 09:17:33 +08:00
committed by neverland
parent 48067f79db
commit 7f84f8a487
140 changed files with 4441 additions and 4723 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/toast/README.md
+27 -27
View File
@@ -22,13 +22,13 @@ Toast('Some messages');
```js
Toast.loading({
message: 'Loading...',
forbidClick: true
forbidClick: true,
});
Toast.loading({
message: 'Loading...',
forbidClick: true,
loadingType: 'spinner'
loadingType: 'spinner',
});
```
@@ -44,12 +44,12 @@ Toast.fail('Fail');
```js
Toast({
message: 'Custom Icon',
icon: 'like-o'
icon: 'like-o',
});
Toast({
message: 'Custom Image',
icon: 'https://img.yzcdn.cn/vant/logo.png'
icon: 'https://img.yzcdn.cn/vant/logo.png',
});
```
@@ -60,7 +60,7 @@ const toast = Toast.loading({
duration: 0, // continuous display toast
forbidClick: true,
loadingType: 'spinner',
message: '3 seconds'
message: '3 seconds',
});
let second = 3;
@@ -75,16 +75,16 @@ const timer = setInterval(() => {
}, 1000);
```
### $toast Method
### \$toast Method
After import the Toast component, the $toast method is automatically mounted on Vue.prototype, making it easy to call within a vue component.
After import the Toast component, the \$toast method is automatically mounted on Vue.prototype, making it easy to call within a vue component.
```js
export default {
mounted() {
this.$toast('Some messages');
}
}
},
};
```
### Singleton
@@ -124,7 +124,7 @@ Toast.resetDefaultOptions('loading');
### Methods
| Methods | Attribute | Return value | Description |
|------|------|------|------|
| --- | --- | --- | --- |
| Toast | `options | message` | toast instance | Show toast |
| Toast.loading | `options | message` | toast instance | Show loading toast |
| Toast.success | `options | message` | toast instance | Show success toast |
@@ -137,20 +137,20 @@ Toast.resetDefaultOptions('loading');
### Options
| Attribute | Description | Type | Default |
|------|------|------|------|
| type | Can be set to `loading` `success` `fail` `html` | *string* | `text` |
| position | Can be set to `top` `middle` `bottom` | *string* | `middle` |
| message | Message | *string* | `''` |
| icon `v2.0.1` | Custom icon | *string* | - |
| iconPrefix `v2.0.9` | Icon className prefix | *string* | `van-icon` |
| overlay `v2.2.13` | Whether to show overlay | *boolean* | `false` |
| forbidClick | Whether to forbid click background | *boolean* | `false` |
| closeOnClick `v2.1.5` | Whether to close after clicked | *boolean* | `false` |
| closeOnClickOverlay `v2.2.13` | Whether to close when click overlay | *boolean* | `false` |
| loadingType | Loading icon type, can be set to `spinner` | *string* | `circular` |
| duration | Toast duration(ms), won't disappear if value is 0 | *number* | `2000` |
| className | Custom className | *any* | - |
| onOpened | Callback function after opened | *Function* | - |
| onClose | Callback function after close | *Function* | - |
| transition `v2.2.6` | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | *string* | `van-fade` |
| getContainer | Return the mount node for Toast | *string \| () => Element* | `body` |
| --- | --- | --- | --- |
| type | Can be set to `loading` `success` `fail` `html` | _string_ | `text` |
| position | Can be set to `top` `middle` `bottom` | _string_ | `middle` |
| message | Message | _string_ | `''` |
| icon `v2.0.1` | Custom icon | _string_ | - |
| iconPrefix `v2.0.9` | Icon className prefix | _string_ | `van-icon` |
| overlay `v2.2.13` | Whether to show overlay | _boolean_ | `false` |
| forbidClick | Whether to forbid click background | _boolean_ | `false` |
| closeOnClick `v2.1.5` | Whether to close after clicked | _boolean_ | `false` |
| closeOnClickOverlay `v2.2.13` | Whether to close when click overlay | _boolean_ | `false` |
| loadingType | Loading icon type, can be set to `spinner` | _string_ | `circular` |
| duration | Toast duration(ms), won't disappear if value is 0 | _number_ | `2000` |
| className | Custom className | _any_ | - |
| onOpened | Callback function after opened | _Function_ | - |
| onClose | Callback function after close | _Function_ | - |
| transition `v2.2.6` | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | _string_ | `van-fade` |
| getContainer | Return the mount node for Toast | _string \| () => Element_ | `body` |
src/toast/README.zh-CN.md
+26 -26
View File
@@ -24,14 +24,14 @@ Toast('提示内容');
```js
Toast.loading({
message: '加载中...',
forbidClick: true
forbidClick: true,
});
// 自定义加载图标
Toast.loading({
message: '加载中...',
forbidClick: true,
loadingType: 'spinner'
loadingType: 'spinner',
});
```
@@ -47,12 +47,12 @@ Toast.fail('失败文案');
```js
Toast({
message: '自定义图标',
icon: 'like-o'
icon: 'like-o',
});
Toast({
message: '展示图片',
icon: 'https://img.yzcdn.cn/vant/logo.png'
icon: 'https://img.yzcdn.cn/vant/logo.png',
});
```
@@ -62,7 +62,7 @@ Toast({
const toast = Toast.loading({
duration: 0, // 持续展示 toast
forbidClick: true,
message: '倒计时 3 秒'
message: '倒计时 3 秒',
});
let second = 3;
@@ -80,14 +80,14 @@ const timer = setInterval(() => {
### 组件内调用
引入 Toast 组件后，会自动在 Vue 的 prototype 上挂载 $toast 方法，便于在组件内调用。
引入 Toast 组件后，会自动在 Vue 的 prototype 上挂载 \$toast 方法，便于在组件内调用。
```js
export default {
mounted() {
this.$toast('提示文案');
}
}
},
};
```
### 单例模式
@@ -127,7 +127,7 @@ Toast.resetDefaultOptions('loading');
### 方法
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|
| --- | --- | --- | --- |
| Toast | 展示提示 | `options | message` | toast 实例 |
| Toast.loading | 展示加载提示 | `options | message` | toast 实例 |
| Toast.success | 展示成功提示 | `options | message` | toast 实例 |
@@ -140,20 +140,20 @@ Toast.resetDefaultOptions('loading');
### Options
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| type | 提示类型，可选值为 `loading` `success`<br>`fail` `html` | *string* | `text` |
| position | 位置，可选值为 `top` `bottom` | *string* | `middle` |
| message | 文本内容，支持通过`\n`换行 | *string* | `''` | - |
| icon `v2.0.1` | 自定义图标，支持传入[图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
| iconPrefix `v2.0.9` | 图标类名前缀，同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | *string* | `van-icon` |
| overlay `v2.2.13` | 是否显示背景遮罩层 | *boolean* | `false` |
| forbidClick | 是否禁止背景点击 | *boolean* | `false` |
| closeOnClick `v2.1.5` | 是否在点击后关闭 | *boolean* | `false` |
| closeOnClickOverlay `v2.2.13` | 是否在点击遮罩层后关闭 | *boolean* | `false` |
| loadingType | [加载图标类型](#/zh-CN/loading), 可选值为 `spinner` | *string* | `circular` |
| duration | 展示时长(ms)，值为 0 时，toast 不会消失 | *number* | `2000` |
| className | 自定义类名 | *any* | - |
| onOpened | 完全展示后的回调函数 | *Function* | - |
| onClose | 关闭时的回调函数 | *Function* | - |
| transition `v2.2.6` | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | *string* | `van-fade` |
| getContainer | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | `body` |
| --- | --- | --- | --- |
| type | 提示类型，可选值为 `loading` `success`<br>`fail` `html` | _string_ | `text` |
| position | 位置，可选值为 `top` `bottom` | _string_ | `middle` |
| message | 文本内容，支持通过`\n`换行 | _string_ | `''` | - |
| icon `v2.0.1` | 自定义图标，支持传入[图标名称](#/zh-CN/icon)或图片链接 | _string_ | - |
| iconPrefix `v2.0.9` | 图标类名前缀，同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
| overlay `v2.2.13` | 是否显示背景遮罩层 | _boolean_ | `false` |
| forbidClick | 是否禁止背景点击 | _boolean_ | `false` |
| closeOnClick `v2.1.5` | 是否在点击后关闭 | _boolean_ | `false` |
| closeOnClickOverlay `v2.2.13` | 是否在点击遮罩层后关闭 | _boolean_ | `false` |
| loadingType | [加载图标类型](#/zh-CN/loading), 可选值为 `spinner` | _string_ | `circular` |
| duration | 展示时长(ms)，值为 0 时，toast 不会消失 | _number_ | `2000` |
| className | 自定义类名 | _any_ | - |
| onOpened | 完全展示后的回调函数 | _Function_ | - |
| onClose | 关闭时的回调函数 | _Function_ | - |
| transition `v2.2.6` | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | _string_ | `van-fade` |
| getContainer | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| () => Element_ | `body` |