[new feature] add i18n support (#310)

* 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 * [new feature] add i18n support * feat: Extract demos from markdown * feat: Base components demos * [new feature] complete demo extract & translate * [fix] text cases * fix: add deepAssign test cases * fix: changelog detail * [new feature] AddressEdit support i18n
2017-11-15 20:08:51 -06:00
parent 05abf0d509
commit d8b6ad7d54
210 changed files with 5561 additions and 5528 deletions
@@ -0,0 +1,73 @@
+## Toast
+
+### Install
+
+```javascript
+import { Toast } from 'vant';
+```
+
+### Usage
+
+#### Text
+
+```javascript
+Toast('Some messages');
+```
+
+
+#### Loading
+
+```javascript
+Toast.loading({ mask: true });
+```
+
+
+#### Success/Fail
+
+```javascript
+Toast.success('Success');
+Toast.fail('Fail');
+```
+
+
+#### Advanced Usage
+
+```javascript
+const toast = Toast.loading({
+  duration: 0,       // continuous display toast
+  forbidClick: true, // forbid click background
+  message: '3 seconds'
+});
+
+let second = 3;
+const timer = setInterval(() => {
+  second--;
+  if (second) {
+    toast.message = `${second} seconds`;
+  } else {
+    clearInterval(timer);
+    Toast.clear();
+  }
+}, 1000);
+```
+
+### 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 |
+| Toast.fail | `options | message` | toast instance | Show fail toast |
+| Toast.clear | - | `void` | Close  |
+
+### Options
+
+| Attribute | Description | Type | Default | Accepted Values |
+|-----------|-----------|-----------|-------------|-------------|
+| type | Type | `String` | `text` | `loading` `success` `fail` `html` |
+| message | Message | `String` | `''` | - |
+| position | Position | `String` | `middle` | `top` `bottom` |
+| mask | Whether to show mask | `Boolean` | `false` | - |
+| forbidClick | Whether to forbid click background | `Boolean` | `false` | - |
+| duration | Toast duration(ms) | `Number` | `3000` | Toast won't disappear if value is 0 |