diff --git a/src/action-sheet/README.md b/src/action-sheet/README.md index 13e0f19ba..940a5ce53 100644 --- a/src/action-sheet/README.md +++ b/src/action-sheet/README.md @@ -153,7 +153,7 @@ export default { | Event | Description | Arguments | |------|------|------| -| select | Triggered when click option | item, index | +| select | Triggered when click option | *action: Action, index: number* | | cancel | Triggered when cancel click | - | | click-overlay | Triggered when click overlay | - | | open | Triggered when open ActionSheet | - | diff --git a/src/action-sheet/README.zh-CN.md b/src/action-sheet/README.zh-CN.md index a152508af..8e410fac4 100644 --- a/src/action-sheet/README.zh-CN.md +++ b/src/action-sheet/README.zh-CN.md @@ -169,7 +169,7 @@ export default { | 事件名 | 说明 | 回调参数 | |------|------|------| -| select | 选中选项时触发，禁用或加载状态下不会触发 | item: 选项对应的对象, index: 选择对应的索引 | +| select | 选中选项时触发，禁用或加载状态下不会触发 | *action: Action, index: number* | | cancel | 取消按钮点击时触发 | - | | click-overlay | 点击遮罩层时触发 | - | | open | 打开菜单时触发 | - | diff --git a/src/button/README.md b/src/button/README.md index 0937207e4..a0164f6c1 100644 --- a/src/button/README.md +++ b/src/button/README.md @@ -125,5 +125,5 @@ Vue.use(Button); | Event | Description | Arguments | |------|------|------| -| click | Triggered when click button and not disabled or loading | event: Event | -| touchstart | Triggered when touch start | event: TouchEvent | +| click | Triggered when click button and not disabled or loading | *event: Event* | +| touchstart | Triggered when touch start | *event: TouchEvent* | diff --git a/src/button/README.zh-CN.md b/src/button/README.zh-CN.md index 148b0dce5..a8c53967f 100644 --- a/src/button/README.zh-CN.md +++ b/src/button/README.zh-CN.md @@ -148,5 +148,5 @@ Vue.use(Button); | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击按钮，且按钮状态不为加载或禁用时触发 | event: Event | -| touchstart | 开始触摸按钮时触发 | event: TouchEvent | +| click | 点击按钮，且按钮状态不为加载或禁用时触发 | *event: Event* | +| touchstart | 开始触摸按钮时触发 | *event: TouchEvent* | diff --git a/src/calendar/README.md b/src/calendar/README.md index ab9093ab7..af0d30730 100644 --- a/src/calendar/README.md +++ b/src/calendar/README.md @@ -249,8 +249,8 @@ Set `poppable` to `false`, the calendar will be displayed directly on the page i | Event | Description | Arguments | |------|------|------| -| select | Triggered when select date | value: Date \| Date[] | -| confirm | Triggered after date selection is complete，if `show-confirm` is` true`, it is triggered after clicking the confirm button | value: Date \| Date[] | +| select | Triggered when select date | *value: Date \| Date[]* | +| confirm | Triggered after date selection is complete，if `show-confirm` is` true`, it is triggered after clicking the confirm button | *value: Date \| Date[]* | ### Slots diff --git a/src/calendar/README.zh-CN.md b/src/calendar/README.zh-CN.md index 567d4dfaa..b9cc1079c 100644 --- a/src/calendar/README.zh-CN.md +++ b/src/calendar/README.zh-CN.md @@ -251,8 +251,8 @@ export default { | 事件名 | 说明 | 回调参数 | |------|------|------| -| select | 点击任意日期时触发 | value: Date \| Date[] | -| confirm | 日期选择完成后触发，若`show-confirm`为`true`，则点击确认按钮后触发 | value: Date \| Date[] | +| select | 点击任意日期时触发 | *value: Date \| Date[]* | +| confirm | 日期选择完成后触发，若`show-confirm`为`true`，则点击确认按钮后触发 | *value: Date \| Date[]* | ### Slots diff --git a/src/card/README.md b/src/card/README.md index 8ab9534a0..dfd4e7c2a 100644 --- a/src/card/README.md +++ b/src/card/README.md @@ -82,8 +82,8 @@ Use slot to custom content. | Event | Description | Arguments | |------|------|------| -| click | Triggered when clicked | event: Event | -| click-thumb | Triggered when thumb clicked | event: Event | +| click | Triggered when clicked | *event: Event* | +| click-thumb | Triggered when thumb clicked | *event: Event* | ### Slots diff --git a/src/card/README.zh-CN.md b/src/card/README.zh-CN.md index 2b5948779..7e5274764 100644 --- a/src/card/README.zh-CN.md +++ b/src/card/README.zh-CN.md @@ -84,8 +84,8 @@ Vue.use(Card); | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击时触发 | event: Event | -| click-thumb | 点击自定义图片时触发 | event: Event | +| click | 点击时触发 | *event: Event* | +| click-thumb | 点击自定义图片时触发 | *event: Event* | ### Slots diff --git a/src/cell/README.md b/src/cell/README.md index b3c1cfe7a..84cf1b072 100644 --- a/src/cell/README.md +++ b/src/cell/README.md @@ -137,7 +137,7 @@ Vue.use(CellGroup); | Event | Description | Arguments | |------|------|------| -| click | Triggered when click cell | event: Event | +| click | Triggered when click cell | *event: Event* | ### CellGroup Slots diff --git a/src/cell/README.zh-CN.md b/src/cell/README.zh-CN.md index 8efc5d813..8efdc3e39 100644 --- a/src/cell/README.zh-CN.md +++ b/src/cell/README.zh-CN.md @@ -148,7 +148,7 @@ Vue.use(CellGroup); | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击单元格时触发 | event: Event | +| click | 点击单元格时触发 | *event: Event* | ### CellGroup Slots diff --git a/src/col/README.md b/src/col/README.md index 456fd1e18..99ff5584f 100644 --- a/src/col/README.md +++ b/src/col/README.md @@ -112,10 +112,10 @@ Setting `type` to `flex` to enable flex layout | Event | Description | Arguments | |------|------|------| -| click | Triggered when click row | event: Event | +| click | Triggered when click row | *event: Event* | ### Col Events | Event | Description | Arguments | |------|------|------| -| click | Triggered when click col | event: Event | +| click | Triggered when click col | *event: Event* | diff --git a/src/col/README.zh-CN.md b/src/col/README.zh-CN.md index a539f59c3..8731ef7b2 100644 --- a/src/col/README.zh-CN.md +++ b/src/col/README.zh-CN.md @@ -115,10 +115,10 @@ Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置 | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击时触发 | event: Event | +| click | 点击时触发 | *event: Event* | ### Col Events | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击时触发 | event: Event | +| click | 点击时触发 | *event: Event* | diff --git a/src/contact-card/README.md b/src/contact-card/README.md index c8b74c382..84880d732 100644 --- a/src/contact-card/README.md +++ b/src/contact-card/README.md @@ -145,7 +145,7 @@ export default { | Event | Description | Arguments | |------|------|------| -| click | Triggered when clicked | event: Event | +| click | Triggered when clicked | *event: Event* | ### ContactList Props diff --git a/src/contact-card/README.zh-CN.md b/src/contact-card/README.zh-CN.md index eba9f75a2..2f2d65837 100644 --- a/src/contact-card/README.zh-CN.md +++ b/src/contact-card/README.zh-CN.md @@ -149,7 +149,7 @@ export default { | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击时触发 | event: Event | +| click | 点击时触发 | *event: Event* | ### ContactList Props diff --git a/src/count-down/README.md b/src/count-down/README.md index aad50c501..6d3e618f7 100644 --- a/src/count-down/README.md +++ b/src/count-down/README.md @@ -130,15 +130,15 @@ export default { | Event | Description | Arguments | |------|------|------| | finish | Triggered when count down finished | - | -| change `v2.4.4` | Triggered when count down changed | timeData | +| change `v2.4.4` | Triggered when count down changed | *timeData: TimeData* | ### Slots | Name | Description | SlotProps | |------|------|------| -| default | Custom Content | timeData | +| default | Custom Content | *timeData: TimeData* | -### timeData Structure +### TimeData Structure | Name | Description | Type | |------|------|------| diff --git a/src/count-down/README.zh-CN.md b/src/count-down/README.zh-CN.md index 661151de5..4587609aa 100644 --- a/src/count-down/README.zh-CN.md +++ b/src/count-down/README.zh-CN.md @@ -140,15 +140,15 @@ export default { | 事件名 | 说明 | 回调参数 | |------|------|------| | finish | 倒计时结束时触发 | - | -| change `v2.4.4` | 倒计时变化时触发 | timeData | +| change `v2.4.4` | 倒计时变化时触发 | *timeData: TimeData* | ### Slots | 名称 | 说明 | SlotProps | |------|------|------| -| default | 自定义内容 | timeData | +| default | 自定义内容 | *timeData: TimeData* | -### timeData 格式 +### TimeData 格式 | 名称 | 说明 | 类型 | |------|------|------| diff --git a/src/field/README.md b/src/field/README.md index 7310ff529..1996d9b26 100644 --- a/src/field/README.md +++ b/src/field/README.md @@ -249,13 +249,13 @@ Field support all native events of input tag | Event | Description | Parameters | |------|------|------| -| input | Triggered when input value changed | value: current value | -| focus | Triggered when input gets focus | event: Event | -| blur | Triggered when input loses focus | event: Event | -| clear | Triggered when click clear icon | event: Event | -| click | Triggered when click Field | event: Event | -| click-left-icon | Triggered when click the left icon of Field | event: Event | -| click-right-icon | Triggered when click the right icon of Field | event: Event | +| input | Triggered when input value changed | *value: string* | +| focus | Triggered when input gets focus | *event: Event* | +| blur | Triggered when input loses focus | *event: Event* | +| clear | Triggered when click clear icon | *event: Event* | +| click | Triggered when click Field | *event: Event* | +| click-left-icon | Triggered when click the left icon of Field | *event: Event* | +| click-right-icon | Triggered when click the right icon of Field | *event: Event* | ### Methods diff --git a/src/field/README.zh-CN.md b/src/field/README.zh-CN.md index 33b3ca8f9..ab154edaa 100644 --- a/src/field/README.zh-CN.md +++ b/src/field/README.zh-CN.md @@ -268,13 +268,13 @@ export default { | 事件 | 说明 | 回调参数 | |------|------|------| -| input | 输入框内容变化时触发 | value: 输入框当前值 | -| focus | 输入框获得焦点时触发 | event: Event | -| blur | 输入框失去焦点时触发 | event: Event | -| clear | 点击清除按钮时触发 | event: Event | -| click | 点击时触发 | event: Event | -| click-left-icon | 点击左侧图标时触发 | event: Event | -| click-right-icon | 点击右侧图标时触发 | event: Event | +| input | 输入框内容变化时触发 | *value: string (当前输入的值)* | +| focus | 输入框获得焦点时触发 | *event: Event* | +| blur | 输入框失去焦点时触发 | *event: Event* | +| clear | 点击清除按钮时触发 | *event: Event* | +| click | 点击时触发 | *event: Event* | +| click-left-icon | 点击左侧图标时触发 | *event: Event* | +| click-right-icon | 点击右侧图标时触发 | *event: Event* | ### 方法 diff --git a/src/grid/README.md b/src/grid/README.md index 1008a055a..b3b37a7cc 100644 --- a/src/grid/README.md +++ b/src/grid/README.md @@ -126,7 +126,7 @@ Vue.use(GridItem); | Event | Description | Arguments | |------|------|------| -| click | Triggered when clicked | event: Event | +| click | Triggered when clicked | *event: Event* | ### GridItem Slots diff --git a/src/grid/README.zh-CN.md b/src/grid/README.zh-CN.md index c77ab6ae3..a4c5c5e7c 100644 --- a/src/grid/README.zh-CN.md +++ b/src/grid/README.zh-CN.md @@ -144,7 +144,7 @@ Vue.use(GridItem); | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击格子时触发 | event: Event | +| click | 点击格子时触发 | *event: Event* | ### GridItem Slots diff --git a/src/icon/README.md b/src/icon/README.md index cf6deef47..63da9842e 100644 --- a/src/icon/README.md +++ b/src/icon/README.md @@ -97,4 +97,4 @@ import 'vant/lib/icon/local.css'; | Event | Description | Arguments | |------|------|------| -| click | Triggered when click icon | event: Event | +| click | Triggered when click icon | *event: Event* | diff --git a/src/icon/README.zh-CN.md b/src/icon/README.zh-CN.md index 521a528b1..23e06b76c 100644 --- a/src/icon/README.zh-CN.md +++ b/src/icon/README.zh-CN.md @@ -103,4 +103,4 @@ import 'vant/lib/icon/local.css'; | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击图标时触发 | event: Event | +| click | 点击图标时触发 | *event: Event* | diff --git a/src/image/README.md b/src/image/README.md index 94fd6f8f9..101d86206 100644 --- a/src/image/README.md +++ b/src/image/README.md @@ -96,7 +96,7 @@ Vue.use(Lazyload); | Event | Description | Arguments | |------|------|------| -| click | Triggered when click image | event: Event | +| click | Triggered when click image | *event: Event* | | load | Triggered when image loaded | - | | error | Triggered when image load failed | - | diff --git a/src/image/README.zh-CN.md b/src/image/README.zh-CN.md index 4e3470361..e13642aba 100644 --- a/src/image/README.zh-CN.md +++ b/src/image/README.zh-CN.md @@ -128,7 +128,7 @@ Vue.use(Lazyload); | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击图片时触发 | event: Event | +| click | 点击图片时触发 | *event: Event* | | load | 图片加载完毕时触发 | - | | error | 图片加载失败时触发 | - | diff --git a/src/notice-bar/README.md b/src/notice-bar/README.md index caeefec9d..08adb596b 100644 --- a/src/notice-bar/README.md +++ b/src/notice-bar/README.md @@ -77,8 +77,8 @@ Vue.use(NoticeBar); | Event | Description | Arguments | |------|------|------| -| click | Triggered when click NoticeBar | event: Event | -| close | Triggered when closed | event: Event | +| click | Triggered when click NoticeBar | *event: Event* | +| close | Triggered when closed | *event: Event* | ### Slots diff --git a/src/notice-bar/README.zh-CN.md b/src/notice-bar/README.zh-CN.md index 2f1556d17..18651ea9e 100644 --- a/src/notice-bar/README.zh-CN.md +++ b/src/notice-bar/README.zh-CN.md @@ -85,8 +85,8 @@ Vue.use(NoticeBar); | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击通知栏时触发 | event: Event | -| close | 关闭通知栏时触发 | event: Event | +| click | 点击通知栏时触发 | *event: Event* | +| close | 关闭通知栏时触发 | *event: Event* | ### Slots diff --git a/src/overlay/README.md b/src/overlay/README.md index 7543bfb33..0147b4e61 100644 --- a/src/overlay/README.md +++ b/src/overlay/README.md @@ -69,7 +69,7 @@ export default { | Event | Description | Arguments | |------|------|------| -| click | Triggered when clicked | event: Event | +| click | Triggered when clicked | *event: Event* | ### Slots diff --git a/src/overlay/README.zh-CN.md b/src/overlay/README.zh-CN.md index 79afff5f7..195270ef2 100644 --- a/src/overlay/README.zh-CN.md +++ b/src/overlay/README.zh-CN.md @@ -75,7 +75,7 @@ export default { | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击时触发 | event: Event | +| click | 点击时触发 | *event: Event* | ### Slots diff --git a/src/popup/README.md b/src/popup/README.md index 853573b45..c5e309570 100644 --- a/src/popup/README.md +++ b/src/popup/README.md @@ -139,7 +139,7 @@ export default { | Event | Description | Arguments | |------|------|------| -| click | Triggered when click Popup | event: Event | +| click | Triggered when click Popup | *event: Event* | | open | Triggered when open Popup | - | | opened | Triggered when opened Popup | - | | close | Triggered when close Popup | - | diff --git a/src/popup/README.zh-CN.md b/src/popup/README.zh-CN.md index e029ce892..53ce1277b 100644 --- a/src/popup/README.zh-CN.md +++ b/src/popup/README.zh-CN.md @@ -150,7 +150,7 @@ export default { | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击弹出层时触发 | event: Event | +| click | 点击弹出层时触发 | *event: Event* | | open | 打开弹出层时触发 | - | | opened | 打开弹出层且动画结束后触发 | - | | close | 关闭弹出层时触发 | - | diff --git a/src/search/README.md b/src/search/README.md index 402c306c9..02b4d7029 100644 --- a/src/search/README.md +++ b/src/search/README.md @@ -135,11 +135,11 @@ Use `action` slot to custom right button, `cancel` event will no longer be trigg | Event | Description | Arguments | |------|------|------| -| search | Triggered when confirm search | value: current value | -| input | Triggered when input value changed | value: current value | -| focus | Triggered when input gets focus | event: Event | -| blur | Triggered when input loses focus | event: Event | -| clear | Triggered when click clear icon | event: Event | +| search | Triggered when confirm search | *value: string* | +| input | Triggered when input value changed | *value: string* | +| focus | Triggered when input gets focus | *event: Event* | +| blur | Triggered when input loses focus | *event: Event* | +| clear | Triggered when click clear icon | *event: Event* | | cancel | Triggered when click cancel button | - | ### Slots diff --git a/src/search/README.zh-CN.md b/src/search/README.zh-CN.md index b2ad3a00e..a8d02390f 100644 --- a/src/search/README.zh-CN.md +++ b/src/search/README.zh-CN.md @@ -135,11 +135,11 @@ export default { | 事件名 | 说明 | 回调参数 | |------|------|------| -| search | 确定搜索时触发 | value: 输入框当前值 | -| input | 输入框内容变化时触发 | value: 输入框当前值 | -| focus | 输入框获得焦点时触发 | event: Event | -| blur | 输入框失去焦点时触发 | event: Event | -| clear | 点击清除按钮后触发 | event: Event | +| search | 确定搜索时触发 | *value: string (当前输入的值)* | +| input | 输入框内容变化时触发 | *value: string (当前输入的值)* | +| focus | 输入框获得焦点时触发 | *event: Event* | +| blur | 输入框失去焦点时触发 | *event: Event* | +| clear | 点击清除按钮后触发 | *event: Event* | | cancel | 点击取消按钮时触发 | - | ### Slots diff --git a/src/stepper/README.md b/src/stepper/README.md index 232684b16..829fb5a42 100644 --- a/src/stepper/README.md +++ b/src/stepper/README.md @@ -130,9 +130,9 @@ export default { | Event | Description | Arguments | |------|------|------| -| change | Triggered when value change | value: current value, detail: Detail info, contains name | +| change | Triggered when value change | *value: string, detail: { name: string }* | | overlimit | Triggered when click disabled button | - | | plus | Triggered when click plus button | - | | minus | Triggered when click minus button | - | -| focus | Triggered when input focused | event: Event | -| blur | Triggered when input blured | event: Event | +| focus | Triggered when input focused | *event: Event* | +| blur | Triggered when input blured | *event: Event* | diff --git a/src/stepper/README.zh-CN.md b/src/stepper/README.zh-CN.md index 728d25f78..dbe90766e 100644 --- a/src/stepper/README.zh-CN.md +++ b/src/stepper/README.zh-CN.md @@ -131,7 +131,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | |------|------|------|------| -| v-model | 当前输入值 | *number \| string* | - | +| v-model | 当前输入的值 | *number \| string* | - | | min | 最小值 | *number \| string* | `1` | | max | 最大值 | *number \| string* | - | | default-value | 初始值，当 v-model 为空时生效 | *number \| string* | `1` | @@ -154,9 +154,9 @@ export default { | 事件名 | 说明 | 回调参数 | |------|------|------| -| change | 当绑定值变化时触发的事件 | value: 当前组件的值, detail: 额外信息，包含 name 的字段 | +| change | 当绑定值变化时触发的事件 | *value: string, detail: { name: string }* | | overlimit | 点击不可用的按钮时触发 | - | | plus | 点击增加按钮时触发 | - | | minus | 点击减少按钮时触发 | - | -| focus | 输入框聚焦时触发 | event: Event | -| blur | 输入框失焦时触发 | event: Event | +| focus | 输入框聚焦时触发 | *event: Event* | +| blur | 输入框失焦时触发 | *event: Event* | diff --git a/src/swipe/README.md b/src/swipe/README.md index ad7a02682..e737a8c70 100644 --- a/src/swipe/README.md +++ b/src/swipe/README.md @@ -170,7 +170,7 @@ export default { | Event | Description | Arguments | |------|------|------| -| click | Triggered when clicked | event: Event | +| click | Triggered when clicked | *event: Event* | ### Swipe Methods diff --git a/src/swipe/README.zh-CN.md b/src/swipe/README.zh-CN.md index 0c927b408..6ffc18647 100644 --- a/src/swipe/README.zh-CN.md +++ b/src/swipe/README.zh-CN.md @@ -176,7 +176,7 @@ export default { | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击时触发 | event: Event | +| click | 点击时触发 | *event: Event* | ### Swipe 方法 diff --git a/src/switch/README.md b/src/switch/README.md index 6c0d2233c..377cbfb96 100644 --- a/src/switch/README.md +++ b/src/switch/README.md @@ -91,7 +91,7 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| -| v-model | Check status of Switch | *any* | `false` | +| v-model | Check status of Switch | *ActiveValue \| InactiveValue* | `false` | | loading | Whether to show loading icon | *boolean* | `false` | | disabled | Whether to disable switch | *boolean* | `false` | | size `v2.2.11` | Size of switch | *number \| string* | `30px` | @@ -104,5 +104,5 @@ export default { | Event | Description | Parameters | |------|------|------| -| change | Triggered when check status changed | checked: is switch checked | -| click `v2.2.11` | Triggered when clicked | event: Event | +| change | Triggered when check status changed | *value: any* | +| click `v2.2.11` | Triggered when clicked | *event: Event* | diff --git a/src/switch/README.zh-CN.md b/src/switch/README.zh-CN.md index 43042eb16..040babd08 100644 --- a/src/switch/README.zh-CN.md +++ b/src/switch/README.zh-CN.md @@ -109,12 +109,12 @@ export default { | size `v2.2.11` | 开关尺寸，默认单位为`px` | *number \| string* | `30px` | | active-color | 打开时的背景色 | *string* | `#1989fa` | | inactive-color | 关闭时的背景色 | *string* | `white` | -| active-value | 打开时的值 | *any* | `true` | -| inactive-value | 关闭时的值 | *any* | `false` | +| active-value | 打开时对应的值 | *any* | `true` | +| inactive-value | 关闭时对应的值 | *any* | `false` | ### Events | 事件名 | 说明 | 回调参数 | |------|------|------| -| change | 开关状态切换回调 | checked: 是否选中开关 | -| click `v2.2.11` | 点击时触发 | event: Event | +| change | 开关状态切换时触发 | *value: any* | +| click `v2.2.11` | 点击时触发 | *event: Event* | diff --git a/src/tag/README.md b/src/tag/README.md index 71f538bc6..30fafaebc 100644 --- a/src/tag/README.md +++ b/src/tag/README.md @@ -135,5 +135,5 @@ export default { | Event | Description | Arguments | |------|------|------| -| click | Triggered when clicked | event: Event | +| click | Triggered when clicked | *event: Event* | | close | Triggered when click close icon | - | diff --git a/src/tag/README.zh-CN.md b/src/tag/README.zh-CN.md index d92bf7249..da2db434b 100644 --- a/src/tag/README.zh-CN.md +++ b/src/tag/README.zh-CN.md @@ -145,5 +145,5 @@ export default { | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击时触发 | event: Event | +| click | 点击时触发 | *event: Event* | | close | 关闭标签时触发 | - |