[Doc] update changelog

This commit is contained in:
陈嘉涵
2018-10-18 18:50:23 +08:00
parent 2228e46733
commit 2e8d7e0b4f
107 changed files with 810 additions and 1212 deletions
+5 -5
View File
@@ -59,7 +59,7 @@ export default {
### API
| Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|
|------|------|------|------|
| left-width | Width of the left scrollable area | `Number` | `0` |
| right-width | Width of the right scrollable area | `Number` | `0` |
| on-close | Callback function before close | `Function` | - |
@@ -68,7 +68,7 @@ export default {
### Slot
| name | Description |
|-----------|-----------|
|------|------|
| - | custom content |
| left | content of left scrollable area |
| right | content of right scrollabe area |
@@ -76,13 +76,13 @@ export default {
### Event
| Event | Description | Arguments |
|-----------|-----------|-----------|
|------|------|------|
| click | Triggered when clicked | Click positon (`left` `right` `cell` `outside`) |
### onClose Params
| Argument | Type | Description |
|-----------|-----------|-----------|
|------|------|------|
| clickPosition | `String` | Click positon (`left` `right` `cell` `outside`) |
| instance | `Object` | SwipeCell instance |
@@ -91,6 +91,6 @@ export default {
Use ref to get SwipeCell instance and call instance methods
| Name | Attribute | Return value | Description |
|-----------|-----------|-----------|-------------|
|------|------|------|------|
| open | position: 'left' \| 'right' | - | open SwipeCell |
| close | - | - | close SwipeCell |
+11 -21
View File
@@ -58,17 +58,17 @@ export default {
### API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| left-width | 左侧滑动区域宽度 | `Number` | `0` |
| right-width | 右侧滑动区域宽度 | `Number` | `0` |
| on-close | 关闭时的回调函数 | `Function` | - |
| disabled | 是否禁用滑动 | `Boolean` | `false` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| left-width | 左侧滑动区域宽度 | `Number` | `0` | - |
| right-width | 右侧滑动区域宽度 | `Number` | `0` | - |
| on-close | 关闭时的回调函数 | `Function` | - | - |
| disabled | 是否禁用滑动 | `Boolean` | `false` | 1.3.4 |
### Slot
| 名称 | 说明 |
|-----------|-----------|
|------|------|
| - | 自定义显示内容 |
| left | 左侧滑动内容 |
| right | 右侧滑动内容 |
@@ -76,13 +76,13 @@ export default {
### Event
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|
|------|------|------|
| click | 点击时触发 | 关闭时的点击位置 (`left` `right` `cell` `outside`) |
### onClose 参数
| 参数 | 类型 | 说明 |
|-----------|-----------|-----------|
|------|------|------|
| clickPosition | `String` | 关闭时的点击位置 (`left` `right` `cell` `outside`) |
| instance | `Object` | SwipeCell 实例 |
@@ -91,16 +91,6 @@ export default {
通过 ref 可以获取到 SwipeCell 实例并调用实例方法
| 方法名 | 参数 | 返回值 | 介绍 |
|-----------|-----------|-----------|-------------|
| open | position: 'left' \| 'right' | - | 打开单元格侧边栏 |
|------|------|------|------|
| open | position: `left | right` | - | 打开单元格侧边栏 |
| close | - | - | 收起单元格侧边栏 |
### 更新日志
| 版本 | 类型 | 内容 |
|-----------|-----------|-----------|
| 1.3.4 | feature | 新增 disabled 属性 |
| 1.3.3 | feature | 新增 click 事件 |
| 1.2.0 | breaking change | 组件命名由 CellSwipe 修改为 SwipeCell |
| 1.1.15 | feature | 新增 open 方法 |
| 1.0.5 | bugfix | 修复在垂直滑动时也会触发 Swipe 的问题 |