From 73932fc691c081d97886e0cb0e137973d5876e94 Mon Sep 17 00:00:00 2001 From: nemo-shen Date: Mon, 17 Jan 2022 10:06:17 +0800 Subject: [PATCH] docs(Component): fix mistake (#4761) --- packages/calendar/README.md | 18 +++++++++--------- packages/count-down/README.md | 4 ++-- packages/datetime-picker/README.md | 8 ++++---- packages/goods-action/README.md | 2 +- packages/image/README.md | 6 +++--- packages/notice-bar/README.md | 4 ++-- packages/picker/README.md | 6 +++--- packages/rate/README.md | 4 ++-- packages/share-sheet/README.md | 8 ++++---- packages/sticky/README.md | 2 +- packages/submit-bar/README.md | 2 +- packages/swipe-cell/README.md | 6 +++--- packages/tag/README.md | 2 +- packages/uploader/README.md | 2 +- 14 files changed, 37 insertions(+), 37 deletions(-) diff --git a/packages/calendar/README.md b/packages/calendar/README.md index dd6f110a..111f6a3a 100644 --- a/packages/calendar/README.md +++ b/packages/calendar/README.md @@ -325,15 +325,15 @@ Page({ | 事件名 | 说明 | 回调参数 | | --- | --- | --- | -| select | 点击任意日期时触发 | _value: Date \| Date[]_ | -| unselect | 当 Calendar 的 `type` 为 `multiple` 时,点击已选中的日期时触发 | _value: Date_ | -| confirm | 日期选择完成后触发，若`show-confirm`为`true`，则点击确认按钮后触发 | _value: Date \| Date[]_ | -| open | 打开弹出层时触发 | - | -| close | 关闭弹出层时触发 | - | -| opened | 打开弹出层且动画结束后触发 | - | -| closed | 关闭弹出层且动画结束后触发 | - | -| over-range | 范围选择超过最多可选天数时触发 | - | -| click-subtitle `v1.8.1` | 点击日历副标题时触发 | _WechatMiniprogram.TouchEvent_ | +| bind:select | 点击任意日期时触发 | _value: Date \| Date[]_ | +| bind:unselect | 当 Calendar 的 `type` 为 `multiple` 时,点击已选中的日期时触发 | _value: Date_ | +| bind:confirm | 日期选择完成后触发，若`show-confirm`为`true`，则点击确认按钮后触发 | _value: Date \| Date[]_ | +| bind:open | 打开弹出层时触发 | - | +| bind:close | 关闭弹出层时触发 | - | +| bind:opened | 打开弹出层且动画结束后触发 | - | +| bind:closed | 关闭弹出层且动画结束后触发 | - | +| bind:over-range | 范围选择超过最多可选天数时触发 | - | +| bind:click-subtitle `v1.8.1` | 点击日历副标题时触发 | _WechatMiniprogram.TouchEvent_ | ### Slots diff --git a/packages/count-down/README.md b/packages/count-down/README.md index f90b5914..399fc09a 100644 --- a/packages/count-down/README.md +++ b/packages/count-down/README.md @@ -150,8 +150,8 @@ Page({ | 事件名 | 说明 | 回调参数 | | ------ | -------------------------------------------- | -------- | -| finish | 倒计时结束时触发 | - | -| change | 时间变化时触发，仅在开启`use-slot`后才会触发 | timeData | +| bind:finish | 倒计时结束时触发 | - | +| bind:change | 时间变化时触发，仅在开启`use-slot`后才会触发 | timeData | ### timeData 格式 diff --git a/packages/datetime-picker/README.md b/packages/datetime-picker/README.md index d1675b47..e7eba0db 100644 --- a/packages/datetime-picker/README.md +++ b/packages/datetime-picker/README.md @@ -199,10 +199,10 @@ Page({ | 事件名称 | 说明 | 回调参数 | | -------- | ------------------------ | ---------- | -| input | 当值变化时触发的事件 | 当前 value | -| change | 当值变化时触发的事件 | 组件实例 | -| confirm | 点击完成按钮时触发的事件 | 当前 value | -| cancel | 点击取消按钮时触发的事件 | - | +| bind:input | 当值变化时触发的事件 | 当前 value | +| bind:change | 当值变化时触发的事件 | 组件实例 | +| bind:confirm | 点击完成按钮时触发的事件 | 当前 value | +| bind:cancel | 点击取消按钮时触发的事件 | - | ### change 事件 diff --git a/packages/goods-action/README.md b/packages/goods-action/README.md index cc4e2ed5..857ca9b9 100644 --- a/packages/goods-action/README.md +++ b/packages/goods-action/README.md @@ -146,7 +146,7 @@ Page({ | 事件名 | 说明 | 参数 | | ------ | ---------------- | ---- | -| click | 按钮点击事件回调 | - | +| bind:click | 按钮点击事件回调 | - | ### GoodsActionIcon Slot diff --git a/packages/image/README.md b/packages/image/README.md index eebdc36b..6b43b9a6 100644 --- a/packages/image/README.md +++ b/packages/image/README.md @@ -120,9 +120,9 @@ | 事件名 | 说明 | 回调参数 | | ------ | ------------------ | ------------ | -| click | 点击图片时触发 | event: Event | -| load | 图片加载完毕时触发 | event: Event | -| error | 图片加载失败时触发 | event: Event | +| bind:click | 点击图片时触发 | event: Event | +| bind:load | 图片加载完毕时触发 | event: Event | +| bind:error | 图片加载失败时触发 | event: Event | ### Slots diff --git a/packages/notice-bar/README.md b/packages/notice-bar/README.md index aecb2ded..4dea62c2 100644 --- a/packages/notice-bar/README.md +++ b/packages/notice-bar/README.md @@ -110,8 +110,8 @@ | 事件名 | 说明 | 参数 | | ------ | ---------------- | -------------- | -| click | 点击通知栏时触发 | _event: Event_ | -| close | 关闭通知栏时触发 | _event: Event_ | +| bind:click | 点击通知栏时触发 | _event: Event_ | +| bind:close | 关闭通知栏时触发 | _event: Event_ | ### Slot diff --git a/packages/picker/README.md b/packages/picker/README.md index 83d93753..b6c26326 100644 --- a/packages/picker/README.md +++ b/packages/picker/README.md @@ -166,9 +166,9 @@ Picker 组件的事件会根据 columns 是单列或多列返回不同的参数 | 事件名 | 说明 | 参数 | | --- | --- | --- | -| confirm | 点击完成按钮时触发 | 单列：选中值，选中值对应的索引
多列：所有列选中值，所有列选中值对应的索引 | -| cancel | 点击取消按钮时触发 | 单列：选中值，选中值对应的索引
多列：所有列选中值，所有列选中值对应的索引 | -| change | 选项改变时触发 | 单列：Picker 实例，选中值，选中值对应的索引
多列：Picker 实例，所有列选中值，当前列对应的索引 | +| bind:confirm | 点击完成按钮时触发 | 单列：选中值，选中值对应的索引
多列：所有列选中值，所有列选中值对应的索引 | +| bind:cancel | 点击取消按钮时触发 | 单列：选中值，选中值对应的索引
多列：所有列选中值，所有列选中值对应的索引 | +| bind:change | 选项改变时触发 | 单列：Picker 实例，选中值，选中值对应的索引
多列：Picker 实例，所有列选中值，当前列对应的索引 | ### Columns 数据结构 diff --git a/packages/rate/README.md b/packages/rate/README.md index 64fd42e0..0195770d 100644 --- a/packages/rate/README.md +++ b/packages/rate/README.md @@ -140,7 +140,7 @@ Page({ | icon | 选中时的图标名称或图片链接，可选值见 [Icon 组件](#/icon) | _string_ | `star` | | void-icon | 未选中时的图标名称或图片链接，可选值见 [Icon 组件](#/icon) | _string_ | `star-o` | | allow-half | 是否允许半选 | _boolean_ | `false` | -| readonly | 是否为只读状态  | _boolean_ | `false` | +| readonly | 是否为只读状态 | _boolean_ | `false` | | disabled | 是否禁用评分 | _boolean_ | `false` | | disabled-color | 禁用时的颜色 | _string_ | `#bdbdbd` | | touchable | 是否可以通过滑动手势选择评分 | _boolean_ | `true` | @@ -149,7 +149,7 @@ Page({ | 事件名称 | 说明 | 回调参数 | | -------- | ------------------------ | --------------------- | -| change | 当前分值变化时触发的事件 | event.detail:当前分值 | +| bind:change | 当前分值变化时触发的事件 | event.detail:当前分值 | ### 外部样式类 diff --git a/packages/share-sheet/README.md b/packages/share-sheet/README.md index a9761ac6..7854ee2f 100644 --- a/packages/share-sheet/README.md +++ b/packages/share-sheet/README.md @@ -183,10 +183,10 @@ Page({ | 事件名 | 说明 | 回调参数 | | ------------- | ------------------ | ------------------------------- | -| select | 点击分享选项时触发 | _option: Option, index: number_ | -| close | 关闭时触发 | - | -| cancel | 点击取消按钮时触发 | - | -| click-overlay | 点击遮罩层时触发 | - | +| bind:select | 点击分享选项时触发 | _option: Option, index: number_ | +| bind:close | 关闭时触发 | - | +| bind:cancel | 点击取消按钮时触发 | - | +| bind:click-overlay | 点击遮罩层时触发 | - | ### Slots diff --git a/packages/sticky/README.md b/packages/sticky/README.md index 54f6a944..1d57f4b4 100644 --- a/packages/sticky/README.md +++ b/packages/sticky/README.md @@ -119,4 +119,4 @@ Page({ | 事件名 | 说明 | 回调参数 | | ------ | ---------- | ---------------------------------------------- | -| scroll | 滚动时触发 | { scrollTop: 距离顶部位置, isFixed: 是否吸顶 } | +| bind:scroll | 滚动时触发 | { scrollTop: 距离顶部位置, isFixed: 是否吸顶 } | diff --git a/packages/submit-bar/README.md b/packages/submit-bar/README.md index 7bd704b6..3dd5b2d4 100644 --- a/packages/submit-bar/README.md +++ b/packages/submit-bar/README.md @@ -93,7 +93,7 @@ | 事件名 | 说明 | 参数 | | ------ | ---------------- | ---- | -| submit | 按钮点击事件回调 | - | +| bind:submit | 按钮点击事件回调 | - | ### Slot diff --git a/packages/swipe-cell/README.md b/packages/swipe-cell/README.md index adb016e7..3b29a61a 100644 --- a/packages/swipe-cell/README.md +++ b/packages/swipe-cell/README.md @@ -133,9 +133,9 @@ Page({ | 事件名 | 说明 | 参数 | | --- | --- | --- | -| click | 点击时触发 | 关闭时的点击位置 (`left` `right` `cell` `outside`) | -| close | 关闭时触发 | { position: 'left' \| 'right' , instance , name: string } | -| open | 打开时触发 | { position: 'left' \| 'right' , name: string } | +| bind:click | 点击时触发 | 关闭时的点击位置 (`left` `right` `cell` `outside`) | +| bind:close | 关闭时触发 | { position: 'left' \| 'right' , instance , name: string } | +| bind:open | 打开时触发 | { position: 'left' \| 'right' , name: string } | ### close 参数 diff --git a/packages/tag/README.md b/packages/tag/README.md index 193d336f..49794909 100644 --- a/packages/tag/README.md +++ b/packages/tag/README.md @@ -145,7 +145,7 @@ Page({ | 事件名 | 说明 | 回调参数 | | ------ | -------------- | -------- | -| close | 关闭标签时触发 | - | +| bind:close | 关闭标签时触发 | - | ### 外部样式类 diff --git a/packages/uploader/README.md b/packages/uploader/README.md index 05b3edce..13065732 100644 --- a/packages/uploader/README.md +++ b/packages/uploader/README.md @@ -274,7 +274,7 @@ uploadFilePromise(fileName, chooseResult) { | ---- | -------------- | | - | 自定义上传区域 | -### Event +### Events | 事件名 | 说明 | 回调参数 | | --- | --- | --- |