[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

View File

@@ -123,7 +123,7 @@ export default {
### API
| Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|
|------|------|------|------|
| autoplay | Autoplay interval (ms) | `Number` | - |
| duration | Animation duration (ms) | `Number` | `500` |
| loop | Whether to enable loop | `Boolean` | `true` |
@@ -137,7 +137,7 @@ export default {
### Event
| Event | Description | Arguments |
|-----------|-----------|-----------|
|------|------|------|
| change | Triggered when current swipe change | index: index of current swipe |
### Methods
@@ -145,12 +145,12 @@ export default {
Use ref to get swipe instance and call instance methods
| Name | Attribute | Return value | Description |
|-----------|-----------|-----------|-------------|
|------|------|------|------|
| swipeTo | index: target index | void | Swipe to target index |
### Slot
| name | Description |
|-----------|-----------|
|------|------|
| - | Content |
| indicator | Custom indicator |

View File

@@ -122,22 +122,22 @@ export default {
### API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| autoplay | 自动轮播间隔,单位为 ms | `Number` | - |
| duration | 动画时长,单位为 ms | `Number` | `500` |
| loop | 是否开启循环播放 | `Boolean` | `true` |
| vertical | 是否为纵向滚动 | `Boolean` | `false` |
| touchable | 是否可以通过手势滑动 | `Boolean` | `true` |
| show-indicators | 是否显示指示器 | `Boolean` | `true` |
| initial-swipe | 初始位置,从 0 开始算 | `Number` | `0` |
| width | 设置滑块宽度 | `Number` | `0` |
| height | 设置滑块高度 | `Number` | `0` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| autoplay | 自动轮播间隔,单位为 ms | `Number` | - | - |
| duration | 动画时长,单位为 ms | `Number` | `500` | - |
| initial-swipe | 初始位置索引值 | `Number` | `0` | - |
| loop | 是否开启循环播放 | `Boolean` | `true` | - |
| show-indicators | 是否显示指示器 | `Boolean` | `true` | - |
| vertical | 是否为纵向滚动 | `Boolean` | `false` | 1.1.1 |
| touchable | 是否可以通过手势滑动 | `Boolean` | `true` | 1.1.1 |
| width | 滑块宽度 | `Number` | `0` | 1.2.1 |
| height | 滑块高度 | `Number` | `0` | 1.2.1 |
### 事件
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|
|------|------|------|
| change | 每一页轮播结束后触发 | index, 当前页的索引 |
### 方法
@@ -145,26 +145,12 @@ export default {
通过 ref 可以获取到 swipe 实例并调用实例方法
| 方法名 | 参数 | 返回值 | 介绍 |
|-----------|-----------|-----------|-------------|
|------|------|------|------|
| swipeTo | index: 目标位置的索引 | void | 滚动到目标位置 |
### 插槽
| 名称 | 说明 |
|-----------|-----------|
|------|------|
| - | 轮播内容 |
| indicator | 自定义指示器 |
### 更新日志
| 版本 | 类型 | 内容 |
|-----------|-----------|-----------|
| 1.3.0 | bugfix | 修复特定手势下可能出现位置错误的问题
| 1.2.1 | feature | 新增 width、height 属性
| 1.1.15 | feature | 新增 open 方法
| 1.1.13 | bugfix | 修复多指触控时导致空白的问题
| 1.1.12 | bugfix | 修复浏览器滚动时会触发轮播左右滚动的问题
| 1.1.12 | feature | 屏幕大小变化时自动调整宽度
| 1.1.7 | feature | 新增 swipeTo 方法
| 1.1.1 | feature | 新增 touchable 属性
| 1.1.1 | feature | 新增 vertical 属性,支持垂直布局