From 9bcfddc95809d3a2211325bc5240e60b844fa8c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=99=88=E5=98=89=E6=B6=B5?= Date: Sat, 18 Jan 2020 08:25:24 +0800 Subject: [PATCH] docs: add import when using Toast or Notify --- src/action-sheet/README.md | 10 ++++++---- src/action-sheet/README.zh-CN.md | 10 ++++++---- src/address-edit/README.md | 5 +++-- src/address-edit/README.zh-CN.md | 5 +++-- src/address-list/README.md | 5 +++-- src/address-list/README.zh-CN.md | 6 +++--- src/area/README.md | 4 ++-- src/area/README.zh-CN.md | 6 +++--- src/checkbox/README.md | 4 ++-- src/checkbox/README.zh-CN.md | 4 ++-- src/count-down/README.md | 4 +++- src/count-down/README.zh-CN.md | 4 +++- src/coupon-list/README.md | 2 +- src/coupon-list/README.zh-CN.md | 2 +- src/datetime-picker/README.md | 2 +- src/datetime-picker/README.zh-CN.md | 4 ++-- src/dialog/README.md | 4 ++-- src/dialog/README.zh-CN.md | 4 ++-- src/goods-action/README.md | 4 +++- src/goods-action/README.zh-CN.md | 4 +++- src/image-preview/README.md | 6 +++--- src/image-preview/README.zh-CN.md | 6 +++--- src/lazyload/README.md | 2 +- src/lazyload/README.zh-CN.md | 2 +- src/nav-bar/README.md | 2 ++ src/nav-bar/README.zh-CN.md | 2 ++ src/number-keyboard/README.md | 7 ++++--- src/number-keyboard/README.zh-CN.md | 7 ++++--- src/pagination/README.md | 2 +- src/pagination/README.zh-CN.md | 2 +- src/password-input/README.md | 4 ++-- src/password-input/README.zh-CN.md | 4 ++-- src/picker/README.md | 12 ++++++++---- src/picker/README.zh-CN.md | 12 ++++++++---- src/popup/README.md | 2 +- src/popup/README.zh-CN.md | 2 +- src/pull-refresh/README.md | 7 ++++--- src/pull-refresh/README.zh-CN.md | 7 ++++--- src/radio/README.md | 2 +- src/radio/README.zh-CN.md | 2 +- src/rate/README.md | 4 ++-- src/rate/README.zh-CN.md | 4 ++-- src/search/README.md | 2 +- src/sidebar/README.md | 2 ++ src/sidebar/README.zh-CN.md | 2 ++ src/sku/README.md | 16 ++++++++-------- src/sku/README.zh-CN.md | 16 ++++++++-------- src/slider/README.md | 5 +++-- src/slider/README.zh-CN.md | 5 +++-- src/stepper/README.md | 7 ++++--- src/stepper/README.zh-CN.md | 7 ++++--- src/steps/README.md | 2 +- src/steps/README.zh-CN.md | 2 +- src/swipe/README.md | 4 +++- src/swipe/README.zh-CN.md | 4 +++- src/switch-cell/README.md | 2 +- src/switch-cell/README.zh-CN.md | 2 +- src/switch/README.md | 2 +- src/switch/README.zh-CN.md | 2 +- src/tab/README.md | 12 ++++++++---- src/tab/README.zh-CN.md | 12 ++++++++---- src/tabbar/README.md | 8 +++++--- src/tabbar/README.zh-CN.md | 8 +++++--- src/toast/README.md | 10 +++++----- src/tree-select/README.md | 6 +++--- src/tree-select/README.zh-CN.md | 6 +++--- src/uploader/README.md | 9 +++++---- src/uploader/README.zh-CN.md | 9 +++++---- 68 files changed, 206 insertions(+), 149 deletions(-) diff --git a/src/action-sheet/README.md b/src/action-sheet/README.md index 6f91abe7d..1388c5803 100644 --- a/src/action-sheet/README.md +++ b/src/action-sheet/README.md @@ -19,7 +19,9 @@ Use `actions` prop to set options of action-sheet. ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { @@ -31,7 +33,6 @@ export default { ] }; }, - methods: { onSelect(item) { this.show = false; @@ -47,7 +48,7 @@ export default { ``` -```javascript +```js export default { data() { return { @@ -74,13 +75,14 @@ export default { ``` ```js +import { Toast } from 'vant'; + export default { data() { return { show: false }; }, - methods: { onCancel() { this.show = false; diff --git a/src/action-sheet/README.zh-CN.md b/src/action-sheet/README.zh-CN.md index faa670a9b..c3cf02280 100644 --- a/src/action-sheet/README.zh-CN.md +++ b/src/action-sheet/README.zh-CN.md @@ -19,7 +19,9 @@ Vue.use(ActionSheet); ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { @@ -31,7 +33,6 @@ export default { ] }; }, - methods: { onSelect(item) { // 默认情况下，点击选项时不会自动关闭菜单 @@ -51,7 +52,7 @@ export default { ``` -```javascript +```js export default { data() { return { @@ -80,13 +81,14 @@ export default { ``` ```js +import { Toast } from 'vant'; + export default { data() { return { show: false }; }, - methods: { onCancel() { this.show = false; diff --git a/src/address-edit/README.md b/src/address-edit/README.md index 95d23f88f..65736d5b3 100644 --- a/src/address-edit/README.md +++ b/src/address-edit/README.md @@ -28,7 +28,9 @@ Vue.use(AddressEdit); /> ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { @@ -36,7 +38,6 @@ export default { searchResult: [] } }, - methods: { onSave() { Toast('save'); diff --git a/src/address-edit/README.zh-CN.md b/src/address-edit/README.zh-CN.md index 33aad1913..b5daa9777 100644 --- a/src/address-edit/README.zh-CN.md +++ b/src/address-edit/README.zh-CN.md @@ -28,7 +28,9 @@ Vue.use(AddressEdit); /> ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { @@ -36,7 +38,6 @@ export default { searchResult: [] } }, - methods: { onSave() { Toast('save'); diff --git a/src/address-list/README.md b/src/address-list/README.md index 386680fa5..f75786909 100644 --- a/src/address-list/README.md +++ b/src/address-list/README.md @@ -25,7 +25,9 @@ Vue.use(AddressList); /> ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { @@ -54,7 +56,6 @@ export default { ] } }, - methods: { onAdd() { Toast('Add'); diff --git a/src/address-list/README.zh-CN.md b/src/address-list/README.zh-CN.md index 0465d9586..912d1c9c2 100644 --- a/src/address-list/README.zh-CN.md +++ b/src/address-list/README.zh-CN.md @@ -25,7 +25,9 @@ Vue.use(AddressList); /> ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { @@ -54,12 +56,10 @@ export default { ] } }, - methods: { onAdd() { Toast('新增地址'); }, - onEdit(item, index) { Toast('编辑地址:' + index); } diff --git a/src/area/README.md b/src/area/README.md index 0200a354c..758bd4e46 100644 --- a/src/area/README.md +++ b/src/area/README.md @@ -94,7 +94,7 @@ Each property is a simple key-value object, key is a 6-bit code of the area of w Example of `AreaList` -```javascript +```js { province_list: { 110000: 'Beijing', @@ -123,7 +123,7 @@ All code of China: [Area.json](https://github.com/youzan/vant/blob/dev/src/area/ An array contains selected area objects. `code` - code of selected area, `name` - name of selected area -```javascript +```js [{ code: '330000', name: 'Zhejiang Province' diff --git a/src/area/README.zh-CN.md b/src/area/README.zh-CN.md index e2ef3e728..884dfe79c 100644 --- a/src/area/README.zh-CN.md +++ b/src/area/README.zh-CN.md @@ -6,7 +6,7 @@ ### 引入 -```javascript +```js import Vue from 'vue'; import { Area } from 'vant'; @@ -94,7 +94,7 @@ Vue.use(Area); `AreaList`具体格式如下： -```javascript +```js { province_list: { 110000: '北京市', @@ -129,7 +129,7 @@ Vue.use(Area); `code` 代表被选中的地区编码， `name` 代表被选中的地区名称 -```javascript +```js [ { code: '110000', diff --git a/src/checkbox/README.md b/src/checkbox/README.md index 62251d816..e3571b8a9 100644 --- a/src/checkbox/README.md +++ b/src/checkbox/README.md @@ -18,7 +18,7 @@ Vue.use(CheckboxGroup); Checkbox ``` -```javascript +```js export default { data() { return { @@ -97,7 +97,7 @@ When Checkboxes are inside a CheckboxGroup, the checked checkboxes's name is an ``` -```javascript +```js export default { data() { return { diff --git a/src/checkbox/README.zh-CN.md b/src/checkbox/README.zh-CN.md index 807aa1c51..fb0a849b3 100644 --- a/src/checkbox/README.zh-CN.md +++ b/src/checkbox/README.zh-CN.md @@ -20,7 +20,7 @@ Vue.use(CheckboxGroup); 复选框 ``` -```javascript +```js export default { data() { return { @@ -107,7 +107,7 @@ export default { ``` -```javascript +```js export default { data() { return { diff --git a/src/count-down/README.md b/src/count-down/README.md index 0e4ce6bd7..a60290b97 100644 --- a/src/count-down/README.md +++ b/src/count-down/README.md @@ -89,6 +89,8 @@ export default { ``` ```js +import { Toast } from 'vant'; + export default { methods: { start() { @@ -101,7 +103,7 @@ export default { this.$refs.countDown.reset(); }, finish() { - this.$toast('Finished'); + Toast('Finished'); } } } diff --git a/src/count-down/README.zh-CN.md b/src/count-down/README.zh-CN.md index 21f83cfd7..a0737469f 100644 --- a/src/count-down/README.zh-CN.md +++ b/src/count-down/README.zh-CN.md @@ -99,6 +99,8 @@ export default { ``` ```js +import { Toast } from 'vant'; + export default { methods: { start() { @@ -111,7 +113,7 @@ export default { this.$refs.countDown.reset(); }, finish() { - this.$toast('倒计时结束'); + Toast('倒计时结束'); } } } diff --git a/src/coupon-list/README.md b/src/coupon-list/README.md index 6822bd92f..64dfab51b 100644 --- a/src/coupon-list/README.md +++ b/src/coupon-list/README.md @@ -39,7 +39,7 @@ Vue.use(CouponList); ``` -```javascript +```js const coupon = { available: 1, originCondition: 0, diff --git a/src/coupon-list/README.zh-CN.md b/src/coupon-list/README.zh-CN.md index 22712883b..94cb683d3 100644 --- a/src/coupon-list/README.zh-CN.md +++ b/src/coupon-list/README.zh-CN.md @@ -39,7 +39,7 @@ Vue.use(CouponList); ``` -```javascript +```js const coupon = { available: 1, condition: '无使用门槛\n最多优惠12元', diff --git a/src/datetime-picker/README.md b/src/datetime-picker/README.md index 6ba24aeb2..ad8b1887b 100644 --- a/src/datetime-picker/README.md +++ b/src/datetime-picker/README.md @@ -26,7 +26,7 @@ Vue.use(DatetimePicker); /> ``` -```javascript +```js export default { data() { return { diff --git a/src/datetime-picker/README.zh-CN.md b/src/datetime-picker/README.zh-CN.md index 4ce6823b4..8dac65144 100644 --- a/src/datetime-picker/README.zh-CN.md +++ b/src/datetime-picker/README.zh-CN.md @@ -6,7 +6,7 @@ ### 引入 -```javascript +```js import Vue from 'vue'; import { DatetimePicker } from 'vant'; @@ -26,7 +26,7 @@ Vue.use(DatetimePicker); /> ``` -```javascript +```js export default { data() { return { diff --git a/src/dialog/README.md b/src/dialog/README.md index 7f1fe7ea7..2d16497cf 100644 --- a/src/dialog/README.md +++ b/src/dialog/README.md @@ -15,7 +15,7 @@ Vue.use(Dialog); Used to prompt for some messages, only including one confirm button -```javascript +```js Dialog.alert({ title: 'Title', message: 'Content' @@ -34,7 +34,7 @@ Dialog.alert({ Used to confirm some messages, including a confirm button and a cancel button -```javascript +```js Dialog.confirm({ title: 'Title', message: 'Content' diff --git a/src/dialog/README.zh-CN.md b/src/dialog/README.zh-CN.md index 38ebc2763..93c7fe271 100644 --- a/src/dialog/README.zh-CN.md +++ b/src/dialog/README.zh-CN.md @@ -41,7 +41,7 @@ export default { 用于提示一些消息，只包含一个确认按钮 -```javascript +```js Dialog.alert({ title: '标题', message: '弹窗内容' @@ -60,7 +60,7 @@ Dialog.alert({ 用于确认消息，包含取消和确认按钮 -```javascript +```js Dialog.confirm({ title: '标题', message: '弹窗内容' diff --git a/src/goods-action/README.md b/src/goods-action/README.md index 23af6e739..471b5f519 100644 --- a/src/goods-action/README.md +++ b/src/goods-action/README.md @@ -24,7 +24,9 @@ Vue.use(GoodsActionIcon); ``` -```javascript +```js +import { Toast } from 'vant'; + export default { methods: { onClickIcon() { diff --git a/src/goods-action/README.zh-CN.md b/src/goods-action/README.zh-CN.md index bc09d2af9..03fec879b 100644 --- a/src/goods-action/README.zh-CN.md +++ b/src/goods-action/README.zh-CN.md @@ -24,7 +24,9 @@ Vue.use(GoodsActionIcon); ``` -```javascript +```js +import { Toast } from 'vant'; + export default { methods: { onClickIcon() { diff --git a/src/image-preview/README.md b/src/image-preview/README.md index 7657748fd..59f3b0e90 100644 --- a/src/image-preview/README.md +++ b/src/image-preview/README.md @@ -13,7 +13,7 @@ Vue.use(ImagePreview); ### Basic Usage -```javascript +```js ImagePreview([ 'https://img.yzcdn.cn/vant/apple-1.jpg', 'https://img.yzcdn.cn/vant/apple-2.jpg' @@ -22,7 +22,7 @@ ImagePreview([ ### Custom config -```javascript +```js ImagePreview({ images: [ 'https://img.yzcdn.cn/vant/apple-1.jpg', @@ -37,7 +37,7 @@ ImagePreview({ ### Async Close -```javascript +```js const instance = ImagePreview({ images: [ 'https://img.yzcdn.cn/vant/apple-1.jpg', diff --git a/src/image-preview/README.zh-CN.md b/src/image-preview/README.zh-CN.md index 0d74d4ecf..38007a9e1 100644 --- a/src/image-preview/README.zh-CN.md +++ b/src/image-preview/README.zh-CN.md @@ -17,7 +17,7 @@ Vue.use(ImagePreview); 直接传入图片数组，即可展示图片预览 -```javascript +```js ImagePreview([ 'https://img.yzcdn.cn/1.jpg', 'https://img.yzcdn.cn/2.jpg' @@ -28,7 +28,7 @@ ImagePreview([ 通过传入配置对象，可以指定初始图片的位置、监听关闭事件 -```javascript +```js ImagePreview({ images: [ 'https://img.yzcdn.cn/1.jpg', @@ -45,7 +45,7 @@ ImagePreview({ 通过`asyncClose`属性可以开启异步关闭，开启后异步关闭后，只能通过实例上的 close 方法关闭图片预览 -```javascript +```js const instance = ImagePreview({ images: [ 'https://img.yzcdn.cn/1.jpg', diff --git a/src/lazyload/README.md b/src/lazyload/README.md index 0388cef0b..b85cd4a69 100644 --- a/src/lazyload/README.md +++ b/src/lazyload/README.md @@ -22,7 +22,7 @@ Vue.use(Lazyload, { ``` -```javascript +```js export default { data() { return { diff --git a/src/lazyload/README.zh-CN.md b/src/lazyload/README.zh-CN.md index 31af8b1dc..425879da9 100644 --- a/src/lazyload/README.zh-CN.md +++ b/src/lazyload/README.zh-CN.md @@ -26,7 +26,7 @@ Vue.use(Lazyload, { ``` -```javascript +```js export default { data() { return { diff --git a/src/nav-bar/README.md b/src/nav-bar/README.md index d6e57b63e..e6757f497 100644 --- a/src/nav-bar/README.md +++ b/src/nav-bar/README.md @@ -25,6 +25,8 @@ Vue.use(NavBar); ``` ```js +import { Toast } from 'vant'; + export default { methods: { onClickLeft() { diff --git a/src/nav-bar/README.zh-CN.md b/src/nav-bar/README.zh-CN.md index 13800fd01..c3bc700bc 100644 --- a/src/nav-bar/README.zh-CN.md +++ b/src/nav-bar/README.zh-CN.md @@ -25,6 +25,8 @@ Vue.use(NavBar); ``` ```js +import { Toast } from 'vant'; + export default { methods: { onClickLeft() { diff --git a/src/number-keyboard/README.md b/src/number-keyboard/README.md index c53ed2662..d805dfd4b 100644 --- a/src/number-keyboard/README.md +++ b/src/number-keyboard/README.md @@ -28,14 +28,15 @@ Vue.use(NumberKeyboard); /> ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { show: true } }, - methods: { onInput(value) { Toast(value); @@ -79,7 +80,7 @@ export default { /> ``` -```javascript +```js export default { data() { return { diff --git a/src/number-keyboard/README.zh-CN.md b/src/number-keyboard/README.zh-CN.md index 0edc0f4df..c3187aeb4 100644 --- a/src/number-keyboard/README.zh-CN.md +++ b/src/number-keyboard/README.zh-CN.md @@ -32,14 +32,15 @@ Vue.use(NumberKeyboard); /> ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { show: true } }, - methods: { onInput(value) { Toast(value); @@ -85,7 +86,7 @@ export default { /> ``` -```javascript +```js export default { data() { return { diff --git a/src/pagination/README.md b/src/pagination/README.md index ed727a99f..de376ff0b 100644 --- a/src/pagination/README.md +++ b/src/pagination/README.md @@ -21,7 +21,7 @@ Vue.use(Pagination); /> ``` -```javascript +```js export default { data() { return { diff --git a/src/pagination/README.zh-CN.md b/src/pagination/README.zh-CN.md index 82e0e1b66..c93101cc4 100644 --- a/src/pagination/README.zh-CN.md +++ b/src/pagination/README.zh-CN.md @@ -22,7 +22,7 @@ Vue.use(Pagination); /> ``` -```javascript +```js export default { data() { return { diff --git a/src/password-input/README.md b/src/password-input/README.md index f393a5485..7adfd78e6 100644 --- a/src/password-input/README.md +++ b/src/password-input/README.md @@ -36,7 +36,7 @@ Vue.use(NumberKeyboard); /> ``` -```javascript +```js export default { data() { return { @@ -101,7 +101,7 @@ Use `error-info` prop to set error message. For example, a password error is pro /> ``` -```javascript +```js export default { data() { return { diff --git a/src/password-input/README.zh-CN.md b/src/password-input/README.zh-CN.md index 0bdaac347..b0b0203fd 100644 --- a/src/password-input/README.zh-CN.md +++ b/src/password-input/README.zh-CN.md @@ -36,7 +36,7 @@ Vue.use(NumberKeyboard); /> ``` -```javascript +```js export default { data() { return { @@ -101,7 +101,7 @@ export default { /> ``` -```javascript +```js export default { data() { return { diff --git a/src/picker/README.md b/src/picker/README.md index 05275fe40..50d05daac 100644 --- a/src/picker/README.md +++ b/src/picker/README.md @@ -21,7 +21,9 @@ Vue.use(Picker); ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { @@ -58,7 +60,9 @@ export default { /> ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { @@ -122,7 +126,7 @@ export default { ``` -```javascript +```js export default { data() { return { @@ -142,7 +146,7 @@ export default { ``` -```javascript +```js const states = { 'Group1': ['Delaware', 'Florida', 'Georqia', 'Indiana', 'Maine'], 'Group2': ['Alabama', 'Kansas', 'Louisiana', 'Texas'] diff --git a/src/picker/README.zh-CN.md b/src/picker/README.zh-CN.md index c00d61190..373a05e7c 100644 --- a/src/picker/README.zh-CN.md +++ b/src/picker/README.zh-CN.md @@ -23,7 +23,9 @@ Vue.use(Picker); ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { @@ -64,7 +66,9 @@ export default { /> ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { @@ -130,7 +134,7 @@ export default { ``` -```javascript +```js export default { data() { return { @@ -150,7 +154,7 @@ export default { ``` -```javascript +```js const citys = { '浙江': ['杭州', '宁波', '温州', '嘉兴', '湖州'], '福建': ['福州', '厦门', '莆田', '三明', '泉州'] diff --git a/src/popup/README.md b/src/popup/README.md index 8a32a45ed..6d2a4f0ab 100644 --- a/src/popup/README.md +++ b/src/popup/README.md @@ -19,7 +19,7 @@ Vue.use(Popup); Content ``` -```javascript +```js export default { data() { return { diff --git a/src/popup/README.zh-CN.md b/src/popup/README.zh-CN.md index ecf1ff694..714129377 100644 --- a/src/popup/README.zh-CN.md +++ b/src/popup/README.zh-CN.md @@ -25,7 +25,7 @@ Vue.use(Popup); 内容 ``` -```javascript +```js export default { data() { return { diff --git a/src/pull-refresh/README.md b/src/pull-refresh/README.md index 39ba2d2b0..357bcc535 100644 --- a/src/pull-refresh/README.md +++ b/src/pull-refresh/README.md @@ -21,7 +21,9 @@ The `refresh` event will be triggered when pull refresh, you should set `v-model ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { @@ -29,11 +31,10 @@ export default { isLoading: false } }, - methods: { onRefresh() { setTimeout(() => { - this.$toast('Refresh Success'); + Toast('Refresh Success'); this.isLoading = false; this.count++; }, 1000); diff --git a/src/pull-refresh/README.zh-CN.md b/src/pull-refresh/README.zh-CN.md index 9918cfb3e..90a0e5cdf 100644 --- a/src/pull-refresh/README.zh-CN.md +++ b/src/pull-refresh/README.zh-CN.md @@ -21,7 +21,9 @@ Vue.use(PullRefresh); ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { @@ -29,11 +31,10 @@ export default { isLoading: false } }, - methods: { onRefresh() { setTimeout(() => { - this.$toast('刷新成功'); + Toast('刷新成功'); this.isLoading = false; this.count++; }, 1000); diff --git a/src/radio/README.md b/src/radio/README.md index 2bb296a54..a4464271b 100644 --- a/src/radio/README.md +++ b/src/radio/README.md @@ -23,7 +23,7 @@ Use `v-model` to bind the name of checked radio ``` -```javascript +```js export default { data() { return { diff --git a/src/radio/README.zh-CN.md b/src/radio/README.zh-CN.md index 04f77530a..a8992d374 100644 --- a/src/radio/README.zh-CN.md +++ b/src/radio/README.zh-CN.md @@ -23,7 +23,7 @@ Vue.use(RadioGroup); ``` -```javascript +```js export default { data() { return { diff --git a/src/rate/README.md b/src/rate/README.md index 64034a1a6..0b77fd234 100644 --- a/src/rate/README.md +++ b/src/rate/README.md @@ -17,7 +17,7 @@ Vue.use(Rate); ``` -```javascript +```js export default { data() { return { @@ -60,7 +60,7 @@ export default { /> ``` -```javascript +```js export default { data() { return { diff --git a/src/rate/README.zh-CN.md b/src/rate/README.zh-CN.md index 9cc37a1d6..5d24bc926 100644 --- a/src/rate/README.zh-CN.md +++ b/src/rate/README.zh-CN.md @@ -17,7 +17,7 @@ Vue.use(Rate); ``` -```javascript +```js export default { data() { return { @@ -60,7 +60,7 @@ export default { /> ``` -```javascript +```js export default { data() { return { diff --git a/src/search/README.md b/src/search/README.md index c7b2a4236..04428533b 100644 --- a/src/search/README.md +++ b/src/search/README.md @@ -17,7 +17,7 @@ Vue.use(Search); ``` -```javascript +```js export default { data() { value: '' diff --git a/src/sidebar/README.md b/src/sidebar/README.md index eab8f9b06..52d225ce8 100644 --- a/src/sidebar/README.md +++ b/src/sidebar/README.md @@ -63,6 +63,8 @@ export default { ``` ```js +import { Notify } from 'vant'; + export default { data() { return { diff --git a/src/sidebar/README.zh-CN.md b/src/sidebar/README.zh-CN.md index ed1d62428..cf0367dec 100644 --- a/src/sidebar/README.zh-CN.md +++ b/src/sidebar/README.zh-CN.md @@ -72,6 +72,8 @@ export default { ``` ```js +import { Notify } from 'vant'; + export default { data() { return { diff --git a/src/sku/README.md b/src/sku/README.md index 883683cb4..059d117b5 100644 --- a/src/sku/README.md +++ b/src/sku/README.md @@ -2,7 +2,7 @@ ### Install -```javascript +```js import Vue from 'vue'; import { Sku } from 'vant'; @@ -182,7 +182,7 @@ Use [ref](https://vuejs.org/v2/api/#ref) to get Sku instance and call instance m ### Sku Data Structure -```javascript +```js sku: { tree: [ { @@ -253,7 +253,7 @@ sku: { ### properties Data Structure -```javascript +```js [ { k_id: 123, @@ -277,7 +277,7 @@ sku: { ### initialSku Data Structure -```javascript +```js { // Key：skuKeyStr // Value：skuValueId @@ -292,7 +292,7 @@ sku: { ### Goods Data Structure -```javascript +```js goods: { title: 'Title', picture: 'https://img.yzcdn.cn/1.jpg' @@ -302,7 +302,7 @@ goods: { ### customStepperConfig Data Structure -```javascript +```js customStepperConfig: { // custom quota text quotaText: 'only 5 can buy', @@ -334,7 +334,7 @@ customStepperConfig: { ### messageConfig Data Structure -```javascript +```js messageConfig: { // the upload image callback uploadImg: () => { @@ -355,7 +355,7 @@ messageConfig: { ### Events Params Data Structure -```javascript +```js skuData: { goodsId: '946755', messages: { diff --git a/src/sku/README.zh-CN.md b/src/sku/README.zh-CN.md index 006e33783..7372a4182 100644 --- a/src/sku/README.zh-CN.md +++ b/src/sku/README.zh-CN.md @@ -2,7 +2,7 @@ ### 引入 -```javascript +```js import Vue from 'vue'; import { Sku } from 'vant'; @@ -188,7 +188,7 @@ Sku 组件默认划分好了若干区块，这些区块都定义成了插槽， ### sku 对象结构 -```javascript +```js sku: { // 所有sku规格类目与其值的从属关系，比如商品有颜色和尺码两大类规格，颜色下面又有红色和蓝色两个规格值。 // 可以理解为一个商品可以有多个规格类目，一个规格类目下可以有多个规格值。 @@ -244,7 +244,7 @@ sku: { ### properties 对象结构 -```javascript +```js [ // 商品属性 { k_id: 123, // 属性id @@ -268,7 +268,7 @@ sku: { ### initialSku 对象结构 -```javascript +```js { // 键：skuKeyStr（sku 组合列表中当前类目对应的 key 值） // 值：skuValueId（规格值 id） @@ -287,7 +287,7 @@ sku: { ### goods 对象结构 -```javascript +```js goods: { // 商品标题 title: '测试商品', @@ -298,7 +298,7 @@ goods: { ### customStepperConfig 对象结构 -```javascript +```js customStepperConfig: { // 自定义限购文案 quotaText: '每次限购xxx件', @@ -330,7 +330,7 @@ customStepperConfig: { ### messageConfig Data Structure -```javascript +```js messageConfig: { // 图片上传回调，需要返回一个promise，promise正确执行的结果需要是一个图片url uploadImg: () => { @@ -351,7 +351,7 @@ messageConfig: { ### 添加购物车和点击购买回调函数接收的 skuData 对象结构 -```javascript +```js skuData: { // 商品 id goodsId: '946755', diff --git a/src/slider/README.md b/src/slider/README.md index 7aab6986c..4a6514793 100644 --- a/src/slider/README.md +++ b/src/slider/README.md @@ -18,16 +18,17 @@ Vue.use(Slider); ``` ```js +import { Toast } from 'vant'; + export default { data() { return { value: 50 }; }, - methods: { onChange(value) { - this.$toast('Current value：' + value); + Toast('Current value：' + value); } } }; diff --git a/src/slider/README.zh-CN.md b/src/slider/README.zh-CN.md index c3e91dba8..24e4e1307 100644 --- a/src/slider/README.zh-CN.md +++ b/src/slider/README.zh-CN.md @@ -18,16 +18,17 @@ Vue.use(Slider); ``` ```js +import { Toast } from 'vant'; + export default { data() { return { value: 50 }; }, - methods: { onChange(value) { - this.$toast('当前值：' + value); + Toast('当前值：' + value); } } }; diff --git a/src/stepper/README.md b/src/stepper/README.md index 265e4d8fe..530a5ca47 100644 --- a/src/stepper/README.md +++ b/src/stepper/README.md @@ -17,7 +17,7 @@ Vue.use(Stepper); ``` -```javascript +```js export default { data() { return { @@ -79,14 +79,15 @@ export default { /> ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { value: 1 } }, - methods: { onChange(value) { Toast.loading({ forbidClick: true }); diff --git a/src/stepper/README.zh-CN.md b/src/stepper/README.zh-CN.md index 2734c47dc..2d8533613 100644 --- a/src/stepper/README.zh-CN.md +++ b/src/stepper/README.zh-CN.md @@ -23,7 +23,7 @@ Vue.use(Stepper); ``` -```javascript +```js export default { data() { return { @@ -101,14 +101,15 @@ export default { /> ``` -```javascript +```js +import { Toast } from 'vant'; + export default { data() { return { value: 1 } }, - methods: { onChange(value) { Toast.loading({ forbidClick: true }); diff --git a/src/steps/README.md b/src/steps/README.md index 00a5c6e98..3c700c19f 100644 --- a/src/steps/README.md +++ b/src/steps/README.md @@ -23,7 +23,7 @@ Vue.use(Steps); ``` -```javascript +```js export default { data() { return { diff --git a/src/steps/README.zh-CN.md b/src/steps/README.zh-CN.md index 76c320ad7..5f2359e27 100644 --- a/src/steps/README.zh-CN.md +++ b/src/steps/README.zh-CN.md @@ -23,7 +23,7 @@ Vue.use(Steps); ``` -```javascript +```js export default { data() { return { diff --git a/src/swipe/README.md b/src/swipe/README.md index a8b1fe810..304be066c 100644 --- a/src/swipe/README.md +++ b/src/swipe/README.md @@ -37,7 +37,7 @@ Use [Lazyload](#/en-US/lazyload) component to lazyload image ``` -```javascript +```js export default { data() { return { @@ -62,6 +62,8 @@ export default { ``` ```js +import { Toast } from 'vant'; + export default { methods: { onChange(index) { diff --git a/src/swipe/README.zh-CN.md b/src/swipe/README.zh-CN.md index fba9695c9..f699cca9e 100644 --- a/src/swipe/README.zh-CN.md +++ b/src/swipe/README.zh-CN.md @@ -37,7 +37,7 @@ Vue.use(SwipeItem); ``` -```javascript +```js export default { data() { return { @@ -62,6 +62,8 @@ export default { ``` ```js +import { Toast } from 'vant'; + export default { methods: { onChange(index) { diff --git a/src/switch-cell/README.md b/src/switch-cell/README.md index d4328021a..d61da9f06 100644 --- a/src/switch-cell/README.md +++ b/src/switch-cell/README.md @@ -23,7 +23,7 @@ Vue.use(SwitchCell); ``` -```javascript +```js export default { data() { return { diff --git a/src/switch-cell/README.zh-CN.md b/src/switch-cell/README.zh-CN.md index 859dc9bd8..9234cb4c8 100644 --- a/src/switch-cell/README.zh-CN.md +++ b/src/switch-cell/README.zh-CN.md @@ -23,7 +23,7 @@ Vue.use(SwitchCell); ``` -```javascript +```js export default { data() { return { diff --git a/src/switch/README.md b/src/switch/README.md index ce10e35a4..f26253c6d 100644 --- a/src/switch/README.md +++ b/src/switch/README.md @@ -17,7 +17,7 @@ Vue.use(Switch); ``` -```javascript +```js export default { data() { return { diff --git a/src/switch/README.zh-CN.md b/src/switch/README.zh-CN.md index 63364a41e..33eb2f02a 100644 --- a/src/switch/README.zh-CN.md +++ b/src/switch/README.zh-CN.md @@ -19,7 +19,7 @@ Vue.use(Switch); ``` -```javascript +```js export default { data() { return { diff --git a/src/tab/README.md b/src/tab/README.md index 2b5478b07..7fac6ea9c 100644 --- a/src/tab/README.md +++ b/src/tab/README.md @@ -78,11 +78,13 @@ You can set `disabled` attribute on the corresponding `van-tab`. ``` -```javascript +```js +import { Toast } from 'vant'; + export default { methods: { onClickDisabled(name, title) { - this.$toast(title + ' is disabled'); + Toast(title + ' is disabled'); } } }; @@ -110,11 +112,13 @@ Tabs styled as cards. ``` -```javascript +```js +import { Toast } from 'vant'; + export default { methods: { onClick(name, title) { - this.$toast(title); + Toast(title); } } }; diff --git a/src/tab/README.zh-CN.md b/src/tab/README.zh-CN.md index 9057f0e04..82c0bdae8 100644 --- a/src/tab/README.zh-CN.md +++ b/src/tab/README.zh-CN.md @@ -81,11 +81,13 @@ export default { ``` -```javascript +```js +import { Toast } from 'vant'; + export default { methods: { onClickDisabled(name, title) { - this.$toast(name + '已被禁用'); + Toast(name + '已被禁用'); } } }; @@ -114,11 +116,13 @@ export default { ``` -```javascript +```js +import { Toast } from 'vant'; + export default { methods: { onClick(name, title) { - this.$toast(title); + Toast(title); } } }; diff --git a/src/tabbar/README.md b/src/tabbar/README.md index 599cbd003..449f111bf 100644 --- a/src/tabbar/README.md +++ b/src/tabbar/README.md @@ -23,7 +23,7 @@ Vue.use(TabbarItem); ``` -```javascript +```js export default { data() { return { @@ -44,7 +44,7 @@ export default { ``` -```javascript +```js export default { data() { return { @@ -84,7 +84,7 @@ Use `icon` slot to custom icon ``` -```javascript +```js export default { data() { return { @@ -126,6 +126,8 @@ export default { ``` ```js +import { Notify } from 'vant'; + export default { methods: { onChange(index) { diff --git a/src/tabbar/README.zh-CN.md b/src/tabbar/README.zh-CN.md index 56ec14302..2b879e7cb 100644 --- a/src/tabbar/README.zh-CN.md +++ b/src/tabbar/README.zh-CN.md @@ -25,7 +25,7 @@ Vue.use(TabbarItem); ``` -```javascript +```js export default { data() { return { @@ -48,7 +48,7 @@ export default { ``` -```javascript +```js export default { data() { return { @@ -90,7 +90,7 @@ export default { ``` -```javascript +```js export default { data() { return { @@ -131,6 +131,8 @@ export default { ``` ```js +import { Notify } from 'vant'; + export default { methods: { onChange(index) { diff --git a/src/toast/README.md b/src/toast/README.md index 2d4887724..644ca39de 100644 --- a/src/toast/README.md +++ b/src/toast/README.md @@ -2,7 +2,7 @@ ### Install -```javascript +```js import Vue from 'vue'; import { Toast } from 'vant'; @@ -13,13 +13,13 @@ Vue.use(Toast); ### Text -```javascript +```js Toast('Some messages'); ``` ### Loading -```javascript +```js Toast.loading({ message: 'Loading...', forbidClick: true @@ -34,7 +34,7 @@ Toast.loading({ ### Success/Fail -```javascript +```js Toast.success('Success'); Toast.fail('Fail'); ``` @@ -55,7 +55,7 @@ Toast({ ### Update Message -```javascript +```js const toast = Toast.loading({ duration: 0, // continuous display toast forbidClick: true, diff --git a/src/tree-select/README.md b/src/tree-select/README.md index 620393276..39547aedf 100644 --- a/src/tree-select/README.md +++ b/src/tree-select/README.md @@ -21,7 +21,7 @@ Vue.use(TreeSelect); /> ``` -```javascript +```js export default { data() { return { @@ -43,7 +43,7 @@ export default { /> ``` -```javascript +```js export default { data() { return { @@ -136,7 +136,7 @@ export default { In every tree object, `text` property defines `id` stands for the unique key while the `children` contains sub-tree objects. -```javascript +```js [ { // name of the parent node diff --git a/src/tree-select/README.zh-CN.md b/src/tree-select/README.zh-CN.md index deccbc639..1f504b3d6 100644 --- a/src/tree-select/README.zh-CN.md +++ b/src/tree-select/README.zh-CN.md @@ -23,7 +23,7 @@ Vue.use(TreeSelect); /> ``` -```javascript +```js export default { data() { return { @@ -47,7 +47,7 @@ export default { /> ``` -```javascript +```js export default { data() { return { @@ -142,7 +142,7 @@ export default { `items` 整体为一个数组，数组内包含一系列描述分类的对象，每个分类里，`text`表示当前分类的名称，`children`表示分类里的可选项。 -```javascript +```js [ { // 导航名称 diff --git a/src/uploader/README.md b/src/uploader/README.md index 783a6165f..d600862cf 100644 --- a/src/uploader/README.md +++ b/src/uploader/README.md @@ -17,7 +17,7 @@ Vue.use(Uploader); ``` -```javascript +```js export default { methods: { afterRead(file) { @@ -33,7 +33,7 @@ export default { ``` -```javascript +```js export default { data() { return { @@ -55,7 +55,7 @@ export default { /> ``` -```javascript +```js export default { data() { return { @@ -80,6 +80,8 @@ export default { ``` ```js +import { Toast } from 'vant'; + export default { methods: { beforeRead(file) { @@ -90,7 +92,6 @@ export default { return true; }, - asyncBeforeRead(file) { return new Promise((resolve, reject) => { if (file.type !== 'image/jpeg') { diff --git a/src/uploader/README.zh-CN.md b/src/uploader/README.zh-CN.md index 8ce4affd6..aeb088d6d 100644 --- a/src/uploader/README.zh-CN.md +++ b/src/uploader/README.zh-CN.md @@ -19,7 +19,7 @@ Vue.use(Uploader); ``` -```javascript +```js export default { methods: { afterRead(file) { @@ -38,7 +38,7 @@ export default { ``` -```javascript +```js export default { data() { return { @@ -65,7 +65,7 @@ export default { /> ``` -```javascript +```js export default { data() { return { @@ -94,6 +94,8 @@ export default { ``` ```js +import { Toast } from 'vant'; + export default { methods: { // 返回布尔值 @@ -105,7 +107,6 @@ export default { return true; }, - // 返回 Promise asyncBeforeRead(file) { return new Promise((resolve, reject) => {