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

docs(SwipeCell): improve event param (#8413)

Browse Source
This commit is contained in:
neverland 2021-03-26 17:55:38 +08:00 committed by GitHub
parent 20bb718ab6
commit 1a6930fa73
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/swipe-cell/README.md
View File

@ -122,17 +122,16 @@ export default {
| Event | Description | Arguments | | Event | Description | Arguments |
| --- | --- | --- | | --- | --- | --- |
| click | Emitted when SwipeCell is clicked | Click positon (`left` `right` `cell` `outside`) | | click | Emitted when SwipeCell is clicked | _position: 'left' \| 'right' \| 'cell' \| 'outside'_ |
| open | Emitted when SwipeCell is opened | { position: 'left' \| 'right' , name: string } | | open | Emitted when SwipeCell is opened | _{ name: string \| number, position: 'left' \| 'right' }_ |
| close | Emitted when SwipeCell is closed | { position: string , name: string } | | close | Emitted when SwipeCell is closed | _{ name: string \| number, position: 'left' \| 'right' \| 'cell' \| 'outside' }_ |
### beforeClose Params ### beforeClose Params
| Attribute | Description | Type | | Attribute | Description | Type |
| --------- | ----------------------------------------------- | ----------- | | --------- | ------------- | ------------------------------------------ |
| name | Name | _string_ | | name | Name | _string \| number_ |
| position | Click positon (`left` `right` `cell` `outside`) | _string_ | | position | Click positon | _'left' \| 'right' \| 'cell' \| 'outside'_ |
| instance | SwipeCell instance | _SwipeCell_ |
### Methods ### Methods

24
src/swipe-cell/README.zh-CN.md
View File

@ -114,7 +114,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | | 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| name | 标识符，可以在事件参数中获取到 | _number \| string_ | - | | name | 标识符，可以在事件参数中获取到 | _number \| string_ | `''` |
| left-width | 指定左侧滑动区域宽度，单位为 `px` | _number \| string_ | `auto` | | left-width | 指定左侧滑动区域宽度，单位为 `px` | _number \| string_ | `auto` |
| right-width | 指定右侧滑动区域宽度，单位为 `px` | _number \| string_ | `auto` | | right-width | 指定右侧滑动区域宽度，单位为 `px` | _number \| string_ | `auto` |
| before-close | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise | _(args) => boolean \| Promise_ | - | | before-close | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise | _(args) => boolean \| Promise_ | - |
@ -124,27 +124,27 @@ export default {
### Slots ### Slots
| 名称 | 说明 | | 名称 | 说明 |
| ------- | -------------- | | ------- | ------------------ |
| default | 自定义显示内容 | | default | 默认显示的内容 |
| left | 左侧滑动内容 | | left | 左侧滑动区域的内容 |
| right | 右侧滑动内容 | | right | 右侧滑动区域的内容 |
### Events ### Events
| 事件名 | 说明 | 回调参数 | | 事件名 | 说明 | 回调参数 |
| ------ | ---------- | -------------------------------------------------- | | --- | --- | --- |
| click | 点击时触发 | 关闭时的点击位置 (`left` `right` `cell` `outside`) | | click | 点击时触发 | _position: 'left' \| 'right' \| 'cell' \| 'outside'_ |
| open | 打开时触发 | { position: 'left' \| 'right' , name: string } | | open | 打开时触发 | _{ name: string \| number, position: 'left' \| 'right' }_ |
| close | 关闭时触发 | { position: string , name: string } | | close | 关闭时触发 | _{ name: string \| number, position: 'left' \| 'right' \| 'cell' \| 'outside' }_ |
### beforeClose 参数 ### beforeClose 参数
beforeClose 的第一个参数为对象，对象中包含以下属性： beforeClose 的第一个参数为对象，对象中包含以下属性：
| 参数名 | 说明 | 类型 | | 参数名 | 说明 | 类型 |
| -------- | -------------------------------------------------- | -------- | | -------- | ---------------- | ------------------------------------------ |
| name | 标识符 | _string_ | | name | 标识符 | _string \| number_ |
| position | 关闭时的点击位置 (`left` `right` `cell` `outside`) | _string_ | | position | 关闭时的点击位置 | _'left' \| 'right' \| 'cell' \| 'outside'_ |
### 方法 ### 方法