# hcg-swipe
**Repository Path**: haochenguang/hcg-swipe
## Basic Information
- **Project Name**: hcg-swipe
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 1
- **Forks**: 0
- **Created**: 2019-07-09
- **Last Updated**: 2022-06-04
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
## HSwipe
### 安装方式：
```
npm install hcg-swipe --save
yarn add hcg-swipe --save
```
### 使用方法：
#### vue-cli脚手架工具中
```vue
```
#### 在html文件中
```html
Document
```
### 配置参数
```javascript
/**
* @param {HTMLElement|String} option.el 轮播图外层容器，默认为 h-swipe-container
* @param {HTMLElement|String} option.wrapper 自定义轮播图wrapper容器选择器，默认为 h-swipe-wrapper
* @param {HTMLElement|String} option.slide 自定义轮播图slide容器选择器，默认为 h-swipe-slide
* @param {Number} option.activeIndex 自定义轮播图初始显示的图像，默认为 0
* @param {Number} option.duration 自定义动画消耗时间，默认800毫秒
* @param {Number} option.interval 自定义每帧停留时间，默认2000毫秒
* @param {Object|Boolean} option.pagination 选择配置分页器，传入true则使用默认选项
* @param {String} option.pagination.el 分页器选择器，默认el为 .h-swipe-pagination
* @param {String} option.pagination.tagName 分页器生成的标签，默认生成span标签
* @param {String} option.pagination.pageName 分页器的使用类名，默认使用 h-swipe-page-btn
* @param {String} option.pagination.activeClass 分页器激活使用的类名，默认激活使用active类名
* @param {Function} option.transitionEnd 每次动画执行完成之后的回调函数，第一个参数为当前激活的索引
* */
```
### 可以使用的方法：
```javascript
swipe.refresh(); // 实例上的方法，刷新结构,并重新开始轮播
swipe.off(); // 实例上的方法，关闭swipe
swipe = swipe.off(); // 彻底清除swipe实例
```