blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-05 05:42:44 +08:00
Code Issues Projects Releases Wiki Activity

docs: improve click event typing (#8106)

Browse Source
This commit is contained in:
neverland 2021-02-09 16:35:54 +08:00 committed by GitHub
parent 8c58097121
commit dcef90a2a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
38 changed files with 150 additions and 150 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
packages/create-vant-cli-app/generators/vue2/src/demo-button/README.md
View File

@ -32,9 +32,9 @@ Vue.use(DemoButton);
### Events
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | ------------ |
| click | 点击时触发 | event: Event |
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | ------------------- |
| click | 点击时触发 | _event: MouseEvent_ |
### Slots

6
packages/create-vant-cli-app/generators/vue3/src/demo-button/README.md
View File

@ -32,9 +32,9 @@ Vue.use(DemoButton);
### Events
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | ------------ |
| click | 点击时触发 | event: Event |
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | ------------------- |
| click | 点击时触发 | _event: MouseEvent_ |
### Slots

2
src/button/README.md
View File

@ -132,7 +132,7 @@ app.use(Button);
| Event | Description | Arguments |
| --- | --- | --- |
| click | Emitted when button is clicked and not disabled or loading | _event: Event_ |
| click | Emitted when button is clicked and not disabled or loading | _event: MouseEvent_ |
| touchstart | Emitted when button is touched | _event: TouchEvent_ |
### Slots

2
src/button/README.zh-CN.md
View File

@ -159,7 +159,7 @@ app.use(Button);
| 事件名 | 说明 | 回调参数 |
| ---------- | ---------------------------------------- | ------------------- |
| click | 点击按钮，且按钮状态不为加载或禁用时触发 | _event: Event_ |
| click | 点击按钮，且按钮状态不为加载或禁用时触发 | _event: MouseEvent_ |
| touchstart | 开始触摸按钮时触发 | _event: TouchEvent_ |
### Slots

8
src/card/README.md
View File

@ -81,10 +81,10 @@ Use slot to custom content.
### Events
| Event | Description | Arguments |
| ----------- | --------------------------------- | -------------- |
| click | Emitted when component is clicked | _event: Event_ |
| click-thumb | Emitted when thumb is clicked | _event: Event_ |
| Event | Description | Arguments |
| ----------- | --------------------------------- | ------------------- |
| click | Emitted when component is clicked | _event: MouseEvent_ |
| click-thumb | Emitted when thumb is clicked | _event: MouseEvent_ |
### Slots

8
src/card/README.zh-CN.md
View File

@ -87,10 +87,10 @@ app.use(Card);
### Events
| 事件名 | 说明 | 回调参数 |
| ----------- | -------------------- | -------------- |
| click | 点击时触发 | _event: Event_ |
| click-thumb | 点击自定义图片时触发 | _event: Event_ |
| 事件名 | 说明 | 回调参数 |
| ----------- | -------------------- | ------------------- |
| click | 点击时触发 | _event: MouseEvent_ |
| click-thumb | 点击自定义图片时触发 | _event: MouseEvent_ |
### Slots

6
src/cell/README.md
View File

@ -154,9 +154,9 @@ app.use(CellGroup);
### Cell Events
| Event | Description | Arguments |
| ----- | ---------------------------- | -------------- |
| click | Emitted when cell is clicked | _event: Event_ |
| Event | Description | Arguments |
| ----- | ---------------------------- | ------------------- |
| click | Emitted when cell is clicked | _event: MouseEvent_ |
### CellGroup Slots

6
src/cell/README.zh-CN.md
View File

@ -161,9 +161,9 @@ app.use(CellGroup);
### Cell Events
| 事件名 | 说明 | 回调参数 |
| ------ | ---------------- | -------------- |
| click | 点击单元格时触发 | _event: Event_ |
| 事件名 | 说明 | 回调参数 |
| ------ | ---------------- | ------------------- |
| click | 点击单元格时触发 | _event: MouseEvent_ |
### CellGroup Slots

8
src/checkbox/README.md
View File

@ -264,10 +264,10 @@ export default {
### Checkbox Events
| Event | Description | Parameters |
| ------ | ------------------------------------ | ------------------ |
| change | Emitted when value changed | _checked: boolean_ |
| click | Emitted when the checkbox is clicked | _event: Event_ |
| Event | Description | Parameters |
| ------ | ------------------------------------ | ------------------- |
| change | Emitted when value changed | _checked: boolean_ |
| click | Emitted when the checkbox is clicked | _event: MouseEvent_ |
### CheckboxGroup Events

8
src/checkbox/README.zh-CN.md
View File

@ -286,10 +286,10 @@ export default {
### Checkbox Events
| 事件名 | 说明 | 回调参数 |
| ------ | ------------------------ | ------------------ |
| change | 当绑定值变化时触发的事件 | _checked: boolean_ |
| click | 点击复选框时触发 | _event: Event_ |
| 事件名 | 说明 | 回调参数 |
| ------ | ------------------------ | ------------------- |
| change | 当绑定值变化时触发的事件 | _checked: boolean_ |
| click | 点击复选框时触发 | _event: MouseEvent_ |
### CheckboxGroup Events

12
src/col/README.md
View File

@ -100,12 +100,12 @@ Set grid spacing using `gutter` attribute. The default value is 0.
### Row Events
| Event | Description | Arguments |
| ----- | ------------------------------- | -------------- |
| click | Emitted when the row is clicked | _event: Event_ |
| Event | Description | Arguments |
| ----- | ------------------------------- | ------------------- |
| click | Emitted when the row is clicked | _event: MouseEvent_ |
### Col Events
| Event | Description | Arguments |
| ----- | ------------------------------- | -------------- |
| click | Emitted when the col is clicked | _event: Event_ |
| Event | Description | Arguments |
| ----- | ------------------------------- | ------------------- |
| click | Emitted when the col is clicked | _event: MouseEvent_ |

12
src/col/README.zh-CN.md
View File

@ -105,12 +105,12 @@ Layout 组件提供了 `24列栅格`，通过在 `Col` 上添加 `span` 属性
### Row Events
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | -------------- |
| click | 点击时触发 | _event: Event_ |
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | ------------------- |
| click | 点击时触发 | _event: MouseEvent_ |
### Col Events
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | -------------- |
| click | 点击时触发 | _event: Event_ |
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | ------------------- |
| click | 点击时触发 | _event: MouseEvent_ |

6
src/contact-card/README.md
View File

@ -86,9 +86,9 @@ export default {
### Events
| Event | Description | Arguments |
| ----- | --------------------------------- | -------------- |
| click | Emitted when component is clicked | _event: Event_ |
| Event | Description | Arguments |
| ----- | --------------------------------- | ------------------- |
| click | Emitted when component is clicked | _event: MouseEvent_ |
### Less Variables

6
src/contact-card/README.zh-CN.md
View File

@ -85,9 +85,9 @@ export default {
### Events
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | -------------- |
| click | 点击时触发 | _event: Event_ |
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | ------------------- |
| click | 点击时触发 | _event: MouseEvent_ |
### 样式变量

10
src/field/README.md
View File

@ -276,11 +276,11 @@ Field support all native events of input tag
| update:model-value | Emitted when input value changed | _value: string_ |
| focus | Emitted when input is focused | _event: Event_ |
| blur | Emitted when input is blured | _event: Event_ |
| clear | Emitted when the clear icon is clicked | _event: Event_ |
| click | Emitted when component is clicked | _event: Event_ |
| click-input | Emitted when the input is clicked | _event: Event_ |
| click-left-icon | Emitted when the left icon is clicked | _event: Event_ |
| click-right-icon | Emitted when the right icon is clicked | _event: Event_ |
| clear | Emitted when the clear icon is clicked | _event: MouseEvent_ |
| click | Emitted when component is clicked | _event: MouseEvent_ |
| click-input | Emitted when the input is clicked | _event: MouseEvent_ |
| click-left-icon | Emitted when the left icon is clicked | _event: MouseEvent_ |
| click-right-icon | Emitted when the right icon is clicked | _event: MouseEvent_ |
### Methods

10
src/field/README.zh-CN.md
View File

@ -297,11 +297,11 @@ export default {
| update:model-value | 输入框内容变化时触发 | _value: string (当前输入的值)_ |
| focus | 输入框获得焦点时触发 | _event: Event_ |
| blur | 输入框失去焦点时触发 | _event: Event_ |
| clear | 点击清除按钮时触发 | _event: Event_ |
| click | 点击 Field 时触发 | _event: Event_ |
| click-input | 点击输入区域时触发 | _event: Event_ |
| click-left-icon | 点击左侧图标时触发 | _event: Event_ |
| click-right-icon | 点击右侧图标时触发 | _event: Event_ |
| clear | 点击清除按钮时触发 | _event: MouseEvent_ |
| click | 点击 Field 时触发 | _event: MouseEvent_ |
| click-input | 点击输入区域时触发 | _event: MouseEvent_ |
| click-left-icon | 点击左侧图标时触发 | _event: MouseEvent_ |
| click-right-icon | 点击右侧图标时触发 | _event: MouseEvent_ |
### 方法

6
src/grid/README.md
View File

@ -122,9 +122,9 @@ app.use(GridItem);
### GridItem Events
| Event | Description | Arguments |
| ----- | --------------------------------- | -------------- |
| click | Emitted when component is clicked | _event: Event_ |
| Event | Description | Arguments |
| ----- | --------------------------------- | ------------------- |
| click | Emitted when component is clicked | _event: MouseEvent_ |
### GridItem Slots

6
src/grid/README.zh-CN.md
View File

@ -142,9 +142,9 @@ app.use(GridItem);
### GridItem Events
| 事件名 | 说明 | 回调参数 |
| ------ | -------------- | -------------- |
| click | 点击格子时触发 | _event: Event_ |
| 事件名 | 说明 | 回调参数 |
| ------ | -------------- | ------------------- |
| click | 点击格子时触发 | _event: MouseEvent_ |
### GridItem Slots

6
src/icon/README.md
View File

@ -97,6 +97,6 @@ import 'vant/lib/icon/local.css';
### Events
| Event | Description | Arguments |
| ----- | ---------------------------- | -------------- |
| click | Emitted when icon is clicked | _event: Event_ |
| Event | Description | Arguments |
| ----- | ---------------------------- | ------------------- |
| click | Emitted when icon is clicked | _event: MouseEvent_ |

6
src/icon/README.zh-CN.md
View File

@ -103,6 +103,6 @@ import 'vant/lib/icon/local.css';
### Events
| 事件名 | 说明 | 回调参数 |
| ------ | -------------- | -------------- |
| click | 点击图标时触发 | _event: Event_ |
| 事件名 | 说明 | 回调参数 |
| ------ | -------------- | ------------------- |
| click | 点击图标时触发 | _event: MouseEvent_ |

10
src/image/README.md
View File

@ -97,11 +97,11 @@ app.use(Lazyload);
### Events
| Event | Description | Arguments |
| ----- | ------------------------------ | -------------- |
| click | Emitted when image is clicked | _event: Event_ |
| load | Emitted when image loaded | - |
| error | Emitted when image load failed | - |
| Event | Description | Arguments |
| ----- | ------------------------------ | ------------------- |
| click | Emitted when image is clicked | _event: MouseEvent_ |
| load | Emitted when image loaded | - |
| error | Emitted when image load failed | - |
### Slots

10
src/image/README.zh-CN.md
View File

@ -129,11 +129,11 @@ app.use(Lazyload);
### Events
| 事件名 | 说明 | 回调参数 |
| ------ | ------------------ | -------------- |
| click | 点击图片时触发 | _event: Event_ |
| load | 图片加载完毕时触发 | - |
| error | 图片加载失败时触发 | - |
| 事件名 | 说明 | 回调参数 |
| ------ | ------------------ | ------------------- |
| click | 点击图片时触发 | _event: MouseEvent_ |
| load | 图片加载完毕时触发 | - |
| error | 图片加载失败时触发 | - |
### Slots

8
src/nav-bar/README.md
View File

@ -76,10 +76,10 @@ export default {
### Events
| Event | Description | Arguments |
| ----------- | ---------------------------------------- | --------- |
| click-left | Emitted when the left button is clicked | - |
| click-right | Emitted when the right button is clicked | - |
| Event | Description | Arguments |
| ----------- | ---------------------------------------- | ------------------- |
| click-left | Emitted when the left button is clicked | _event: MouseEvent_ |
| click-right | Emitted when the right button is clicked | _event: MouseEvent_ |
### Less Variables

8
src/nav-bar/README.zh-CN.md
View File

@ -78,10 +78,10 @@ export default {
### Events
| 事件名 | 说明 | 回调参数 |
| ----------- | ------------------ | -------- |
| click-left | 点击左侧按钮时触发 | - |
| click-right | 点击右侧按钮时触发 | - |
| 事件名 | 说明 | 回调参数 |
| ----------- | ------------------ | ------------------- |
| click-left | 点击左侧按钮时触发 | _event: MouseEvent_ |
| click-right | 点击右侧按钮时触发 | _event: MouseEvent_ |
### 样式变量

10
src/notice-bar/README.md
View File

@ -95,11 +95,11 @@ app.use(NoticeBar);
### Events
| Event | Description | Arguments |
| ------ | ---------------------------------- | -------------- |
| click | Emitted when NoticeBar is clicked | _event: Event_ |
| close | Emitted when NoticeBar is closed | _event: Event_ |
| replay | Emitted when NoticeBar is replayed | - |
| Event | Description | Arguments |
| ------ | ---------------------------------- | ------------------- |
| click | Emitted when NoticeBar is clicked | _event: MouseEvent_ |
| close | Emitted when NoticeBar is closed | _event: MouseEvent_ |
| replay | Emitted when NoticeBar is replayed | - |
### Slots

10
src/notice-bar/README.zh-CN.md
View File

@ -120,11 +120,11 @@ app.use(NoticeBar);
### Events
| 事件名 | 说明 | 回调参数 |
| ------ | ---------------------------- | -------------- |
| click | 点击通知栏时触发 | _event: Event_ |
| close | 关闭通知栏时触发 | _event: Event_ |
| replay | 每当滚动栏重新开始滚动时触发 | - |
| 事件名 | 说明 | 回调参数 |
| ------ | ---------------------------- | ------------------- |
| click | 点击通知栏时触发 | _event: MouseEvent_ |
| close | 关闭通知栏时触发 | _event: MouseEvent_ |
| replay | 每当滚动栏重新开始滚动时触发 | - |
### Slots

6
src/overlay/README.md
View File

@ -70,9 +70,9 @@ export default {
### Events
| Event | Description | Arguments |
| ----- | --------------------------------- | -------------- |
| click | Emitted when component is clicked | _event: Event_ |
| Event | Description | Arguments |
| ----- | --------------------------------- | ------------------- |
| click | Emitted when component is clicked | _event: MouseEvent_ |
### Slots

6
src/overlay/README.zh-CN.md
View File

@ -76,9 +76,9 @@ export default {
### Events
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | -------------- |
| click | 点击时触发 | _event: Event_ |
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | ------------------- |
| click | 点击时触发 | _event: MouseEvent_ |
### Slots

18
src/popup/README.md
View File

@ -137,15 +137,15 @@ export default {
### Events
| Event | Description | Arguments |
| ---------------- | ---------------------------------- | -------------- |
| click | Emitted when Popup is clicked | _event: Event_ |
| click-overlay | Emitted when overlay is clicked | - |
| click-close-icon | Emitted when close icon is clicked | _event: Event_ |
| open | Emitted when opening Popup | - |
| close | Emitted when closing Popup | - |
| opened | Emitted when Popup is opened | - |
| closed | Emitted when Popup is closed | - |
| Event | Description | Arguments |
| ---------------- | ---------------------------------- | ------------------- |
| click | Emitted when Popup is clicked | _event: MouseEvent_ |
| click-overlay | Emitted when overlay is clicked | - |
| click-close-icon | Emitted when close icon is clicked | _event: MouseEvent_ |
| open | Emitted when opening Popup | - |
| close | Emitted when closing Popup | - |
| opened | Emitted when Popup is opened | - |
| closed | Emitted when Popup is closed | - |
### Less Variables

18
src/popup/README.zh-CN.md
View File

@ -147,15 +147,15 @@ export default {
### Events
| 事件名 | 说明 | 回调参数 |
| ---------------- | -------------------------- | -------------- |
| click | 点击弹出层时触发 | _event: Event_ |
| click-overlay | 点击遮罩层时触发 | - |
| click-close-icon | 点击关闭图标时触发 | _event: Event_ |
| open | 打开弹出层时触发 | - |
| close | 关闭弹出层时触发 | - |
| opened | 打开弹出层且动画结束后触发 | - |
| closed | 关闭弹出层且动画结束后触发 | - |
| 事件名 | 说明 | 回调参数 |
| ---------------- | -------------------------- | ------------------- |
| click | 点击弹出层时触发 | _event: MouseEvent_ |
| click-overlay | 点击遮罩层时触发 | - |
| click-close-icon | 点击关闭图标时触发 | _event: MouseEvent_ |
| open | 打开弹出层时触发 | - |
| close | 关闭弹出层时触发 | - |
| opened | 打开弹出层且动画结束后触发 | - |
| closed | 关闭弹出层且动画结束后触发 | - |
### 样式变量

6
src/radio/README.md
View File

@ -176,9 +176,9 @@ export default {
### Radio Events
| Event | Description | Parameters |
| ----- | ----------------------------- | -------------- |
| click | Emitted when radio is clicked | _event: Event_ |
| Event | Description | Parameters |
| ----- | ----------------------------- | ------------------- |
| click | Emitted when radio is clicked | _event: MouseEvent_ |
### RadioGroup Events

6
src/radio/README.zh-CN.md
View File

@ -194,9 +194,9 @@ export default {
### Radio Events
| 事件名 | 说明 | 回调参数 |
| ------ | ---------------- | -------------- |
| click | 点击单选框时触发 | _event: Event_ |
| 事件名 | 说明 | 回调参数 |
| ------ | ---------------- | ------------------- |
| click | 点击单选框时触发 | _event: MouseEvent_ |
### RadioGroup Events

6
src/swipe/README.md
View File

@ -175,9 +175,9 @@ export default {
### SwipeItem Events
| Event | Description | Arguments |
| ----- | --------------------------------- | -------------- |
| click | Emitted when component is clicked | _event: Event_ |
| Event | Description | Arguments |
| ----- | --------------------------------- | ------------------- |
| click | Emitted when component is clicked | _event: MouseEvent_ |
### Swipe Methods

6
src/swipe/README.zh-CN.md
View File

@ -185,9 +185,9 @@ export default {
### SwipeItem Events
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | -------------- |
| click | 点击时触发 | _event: Event_ |
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | ------------------- |
| click | 点击时触发 | _event: MouseEvent_ |
### Swipe 方法

8
src/switch/README.md
View File

@ -110,10 +110,10 @@ export default {
### Events
| Event | Description | Parameters |
| ------ | --------------------------------- | -------------- |
| change | Emitted when check status changed | _value: any_ |
| click | Emitted when component is clicked | _event: Event_ |
| Event | Description | Parameters |
| ------ | --------------------------------- | ------------------- |
| change | Emitted when check status changed | _value: any_ |
| click | Emitted when component is clicked | _event: MouseEvent_ |
### Less Variables

8
src/switch/README.zh-CN.md
View File

@ -126,10 +126,10 @@ export default {
### Events
| 事件名 | 说明 | 回调参数 |
| ------ | ------------------ | -------------- |
| change | 开关状态切换时触发 | _value: any_ |
| click | 点击时触发 | _event: Event_ |
| 事件名 | 说明 | 回调参数 |
| ------ | ------------------ | ------------------- |
| change | 开关状态切换时触发 | _value: any_ |
| click | 点击时触发 | _event: MouseEvent_ |
### 样式变量

8
src/tag/README.md
View File

@ -105,10 +105,10 @@ export default {
### Events
| Event | Description | Arguments |
| ----- | ---------------------------------- | -------------- |
| click | Emitted when component is clicked | _event: Event_ |
| close | Emitted when close icon is clicked | - |
| Event | Description | Arguments |
| ----- | ---------------------------------- | ------------------- |
| click | Emitted when component is clicked | _event: MouseEvent_ |
| close | Emitted when close icon is clicked | - |
### Less Variables

8
src/tag/README.zh-CN.md
View File

@ -119,10 +119,10 @@ export default {
### Events
| 事件名 | 说明 | 回调参数 |
| ------ | -------------- | -------------- |
| click | 点击时触发 | _event: Event_ |
| close | 关闭标签时触发 | - |
| 事件名 | 说明 | 回调参数 |
| ------ | -------------- | ------------------- |
| click | 点击时触发 | _event: MouseEvent_ |
| close | 关闭标签时触发 | - |
### 样式变量