alighasami/vant
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: prettier all markdown files

Browse Source
This commit is contained in:
chenjiahan
2020-04-11 09:17:33 +08:00
committed by neverland
parent 48067f79db
commit 7f84f8a487
140 changed files with 4441 additions and 4723 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/swipe-cell/README.zh-CN.md
+38 -43
View File
@@ -23,7 +23,7 @@ Vue.use(SwipeCell);
<van-cell :border="false" title="单元格" value="内容" />
<template #right>
<van-button square type="danger" text="删除" />
<van-button square type="primary" text="收藏"/>
<van-button square type="primary" text="收藏" />
</template>
</van-swipe-cell>
```
@@ -43,24 +43,19 @@ Vue.use(SwipeCell);
thumb="https://img.yzcdn.cn/vant/cat.jpeg"
/>
<template #right>
<van-button
square
text="删除"
type="danger"
class="delete-button"
/>
<van-button square text="删除" type="danger" class="delete-button" />
</template>
</van-swipe-cell>
<style>
.goods-card {
margin: 0;
background-color: @white;
}
.goods-card {
margin: 0;
background-color: @white;
}
.delete-button {
height: 100%;
}
.delete-button {
height: 100%;
}
</style>
```
@@ -94,15 +89,15 @@ export default {
break;
case 'right':
Dialog.confirm({
message: '确定删除吗？'
message: '确定删除吗？',
}).then(() => {
instance.close();
});
break;
}
}
}
}
},
},
};
```
## API
@@ -110,48 +105,48 @@ export default {
### Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| name `v2.0.4` | 标识符，可以在事件参数中获取到 | *number \| string* | - |
| left-width | 指定左侧滑动区域宽度，单位为`px` | *number \| string* | `auto` |
| right-width | 指定右侧滑动区域宽度，单位为`px` | *number \| string* | `auto` |
| before-close `v2.3.0` | 关闭前的回调函数 | *Function* | - |
| disabled | 是否禁用滑动 | *boolean* | `false` |
| stop-propagation `v2.1.0` | 是否阻止滑动事件冒泡 | *boolean* | `false` |
| --- | --- | --- | --- |
| name `v2.0.4` | 标识符，可以在事件参数中获取到 | _number \| string_ | - |
| left-width | 指定左侧滑动区域宽度，单位为`px` | _number \| string_ | `auto` |
| right-width | 指定右侧滑动区域宽度，单位为`px` | _number \| string_ | `auto` |
| before-close `v2.3.0` | 关闭前的回调函数 | _Function_ | - |
| disabled | 是否禁用滑动 | _boolean_ | `false` |
| stop-propagation `v2.1.0` | 是否阻止滑动事件冒泡 | _boolean_ | `false` |
### Slots
| 名称 | 说明 |
|------|------|
| 名称 | 说明 |
| ------- | -------------- |
| default | 自定义显示内容 |
| left | 左侧滑动内容 |
| right | 右侧滑动内容 |
| left | 左侧滑动内容 |
| right | 右侧滑动内容 |
### Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击时触发 | 关闭时的点击位置 (`left` `right` `cell` `outside`) |
| open | 打开时触发 | { position: 'left' \| 'right' , name: string } |
| close | 关闭时触发 | { position: string , name: string } |
| 事件名 | 说明 | 回调参数 |
| ------ | ---------- | -------------------------------------------------- |
| click | 点击时触发 | 关闭时的点击位置 (`left` `right` `cell` `outside`) |
| open | 打开时触发 | { position: 'left' \| 'right' , name: string } |
| close | 关闭时触发 | { position: string , name: string } |
### beforeClose 参数
beforeClose 的第一个参数为对象，对象中包含以下属性：
| 参数名 | 说明 | 类型 |
|------|------|------|
| name | 标识符 | *string* |
| position | 关闭时的点击位置 (`left` `right` `cell` `outside`) | *string* |
| instance | SwipeCell 实例，用于调用实例方法 | *SwipeCell* |
| 参数名 | 说明 | 类型 |
| -------- | -------------------------------------------------- | ----------- |
| name | 标识符 | _string_ |
| position | 关闭时的点击位置 (`left` `right` `cell` `outside`) | _string_ |
| instance | SwipeCell 实例，用于调用实例方法 | _SwipeCell_ |
### 方法
通过 ref 可以获取到 SwipeCell 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|
| open | 打开单元格侧边栏 | position: `left | right` | - |
| close | 收起单元格侧边栏 | - | - |
| 方法名 | 说明 | 参数 | 返回值 |
| ------ | ---------------- | ------------------------ | ------ |
| open | 打开单元格侧边栏 | position: `left | right` | - |
| close | 收起单元格侧边栏 | - | - |
## 常见问题