[Doc] add toast english document (#307)

* fix: Tabbar icon line-height

* [new feature] progress add showPivot prop

* [new feature] TabItem support vue-router

* [new feature] update document header style

* [Doc] add toast english ducoment
This commit is contained in:
neverland 2017-11-10 21:53:03 -06:00 committed by GitHub
parent 0aab9ba7be
commit 5e8c5a7b6c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 43 additions and 39 deletions

View File

@ -115,6 +115,8 @@ export default {
} }
``` ```
完整数据见 [Area.json](https://github.com/youzan/vant/blob/dev/docs/mock/area.json)
#### 点击完成时返回的Data Structure #### 点击完成时返回的Data Structure
返回的数据整体为一个数组,数组内包含 `columnsNum` 个数据, 每个数据对应一列选项中被选中的数据。 返回的数据整体为一个数组,数组内包含 `columnsNum` 个数据, 每个数据对应一列选项中被选中的数据。

View File

@ -4,29 +4,29 @@ import { Toast } from 'packages';
export default { export default {
methods: { methods: {
showToast() { showToast() {
Toast('我是提示文案,建议不超过十五字~'); Toast('Some messages');
}, },
showLoadingToast() { showLoadingToast() {
Toast.loading({ mask: true }); Toast.loading({ mask: true });
}, },
showSuccessToast() { showSuccessToast() {
Toast.success('成功文案'); Toast.success('Success');
}, },
showFailToast() { showFailToast() {
Toast.fail('失败文案'); Toast.fail('Fail');
}, },
showCustomizedToast(duration) { showCustomizedToast(duration) {
const toast = Toast.loading({ const toast = Toast.loading({
duration: 0, duration: 0,
forbidClick: true, forbidClick: true,
message: '倒计时 3 秒' message: '3 seconds'
}); });
let second = 3; let second = 3;
const timer = setInterval(() => { const timer = setInterval(() => {
second--; second--;
if (second) { if (second) {
toast.message = `倒计时 ${second} 秒`; toast.message = `${second} seconds`;
} else { } else {
clearInterval(timer); clearInterval(timer);
Toast.clear(); Toast.clear();
@ -47,29 +47,29 @@ import { Toast } from 'vant';
### Usage ### Usage
#### 文字提示 #### Text
:::demo 文字提示 :::demo Text
```html ```html
<van-button @click="showToast">文字提示</van-button> <van-button @click="showToast">Show Text</van-button>
``` ```
```javascript ```javascript
export default { export default {
methods: { methods: {
showToast() { showToast() {
Toast('我是提示文案,建议不超过十五字~'); Toast('Some messages');
} }
} }
} }
``` ```
::: :::
#### 加载提示 #### Loading
:::demo 加载提示 :::demo Loading
```html ```html
<van-button @click="showLoadingToast">加载提示</van-button> <van-button @click="showLoadingToast">Show Loading</van-button>
``` ```
```javascript ```javascript
@ -83,22 +83,22 @@ export default {
``` ```
::: :::
#### 成功/失败提示 #### Success/Fail
:::demo 成功/失败提示 :::demo Success/Fail
```html ```html
<van-button @click="showSuccessToast">成功提示</van-button> <van-button @click="showSuccessToast">Show Success</van-button>
<van-button @click="showFailToast">失败提示</van-button> <van-button @click="showFailToast">Show Fail</van-button>
``` ```
```javascript ```javascript
export default { export default {
methods: { methods: {
showSuccessToast() { showSuccessToast() {
Toast.success('成功文案'); Toast.success('Success');
}, },
showFailToast() { showFailToast() {
Toast.fail('失败文案'); Toast.fail('Fail');
} }
} }
} }
@ -117,16 +117,16 @@ export default {
methods: { methods: {
showCustomizedToast() { showCustomizedToast() {
const toast = Toast.loading({ const toast = Toast.loading({
duration: 0, // 持续展示 toast duration: 0, // continuous display toast
forbidClick: true, // 禁用背景点击 forbidClick: true, // forbid click background
message: '倒计时 3 秒' message: '3 seconds'
}); });
let second = 3; let second = 3;
const timer = setInterval(() => { const timer = setInterval(() => {
second--; second--;
if (second) { if (second) {
toast.message = `倒计时 ${second} 秒`; toast.message = `${second} seconds`;
} else { } else {
clearInterval(timer); clearInterval(timer);
Toast.clear(); Toast.clear();
@ -138,23 +138,23 @@ export default {
``` ```
::: :::
### 方法 ### Methods
| 方法名 | Attribute | 返回值 | 介绍 | | Methods | Attribute | Return value | Description |
|-----------|-----------|-----------|-------------| |-----------|-----------|-----------|-------------|
| Toast | `options | message` | toast 实例 | 展示提示 | | Toast | `options | message` | toast instance | Show toast |
| Toast.loading | `options | message` | toast 实例 | 展示加载提示 | | Toast.loading | `options | message` | toast instance | Show loading toast |
| Toast.success | `options | message` | toast 实例 | 展示成功提示 | | Toast.success | `options | message` | toast instance | Show success toast |
| Toast.fail | `options | message` | toast 实例 | 展示失败提示 | | Toast.fail | `options | message` | toast instance | Show fail toast |
| Toast.clear | - | `void` | 关闭提示 | | Toast.clear | - | `void` | Close |
### Options ### Options
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default | Accepted Values |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|-------------|
| type | 提示类型 | `String` | `text` | `loading` `success` `fail` `html` | | type | Type | `String` | `text` | `loading` `success` `fail` `html` |
| message | 内容 | `String` | `''` | - | | message | Message | `String` | `''` | - |
| position | 位置 | `String` | `middle` | `top` `bottom` | | position | Position | `String` | `middle` | `top` `bottom` |
| mask | 是否显示背景蒙层 | `Boolean` | `false` | - | | mask | Whether to show mask | `Boolean` | `false` | - |
| forbidClick | 禁止背景点击 | `Boolean` | `false` | - | | forbidClick | Whether to forbid click background | `Boolean` | `false` | - |
| duration | 时长(ms) | `Number` | `3000` | 值为 0 时toast 不会消失 | | duration | Toast duration(ms) | `Number` | `3000` | Toast won't disappear if value is 0 |

View File

@ -115,6 +115,8 @@ export default {
} }
``` ```
完整数据见 [Area.json](https://github.com/youzan/vant/blob/dev/docs/mock/area.json)
#### 点击完成时返回的数据格式 #### 点击完成时返回的数据格式
返回的数据整体为一个数组,数组内包含 `columnsNum` 个数据, 每个数据对应一列选项中被选中的数据。 返回的数据整体为一个数组,数组内包含 `columnsNum` 个数据, 每个数据对应一列选项中被选中的数据。

View File

@ -118,6 +118,6 @@
"webpack-bundle-analyzer": "^2.9.0", "webpack-bundle-analyzer": "^2.9.0",
"webpack-dev-server": "^2.9.4", "webpack-dev-server": "^2.9.4",
"webpack-merge": "^4.1.1", "webpack-merge": "^4.1.1",
"zan-doc": "0.3.10" "zan-doc": "0.3.11"
} }
} }

View File

@ -8217,9 +8217,9 @@ yeast@0.1.2:
version "0.1.2" version "0.1.2"
resolved "https://registry.yarnpkg.com/yeast/-/yeast-0.1.2.tgz#008e06d8094320c372dbc2f8ed76a0ca6c8ac419" resolved "https://registry.yarnpkg.com/yeast/-/yeast-0.1.2.tgz#008e06d8094320c372dbc2f8ed76a0ca6c8ac419"
zan-doc@0.3.10: zan-doc@0.3.11:
version "0.3.10" version "0.3.11"
resolved "https://registry.yarnpkg.com/zan-doc/-/zan-doc-0.3.10.tgz#c3130c81cbb66e0feceb6d5a84d89b39db69659a" resolved "https://registry.yarnpkg.com/zan-doc/-/zan-doc-0.3.11.tgz#5a74a409b98a97536a93fb04ca9d634aea182e4d"
dependencies: dependencies:
cheerio "0.22.0" cheerio "0.22.0"
decamelize "^1.2.0" decamelize "^1.2.0"