vue-flip-down/README.md
2018-10-24 14:04:40 +08:00

47 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# vue-flip-down [![npm](https://img.shields.io/npm/v/vue-flip-down.svg)](https://www.npmjs.com/package/vue-flip-down) [![npm](https://img.shields.io/npm/dy/vue-flip-down.svg)](https://www.npmjs.com/package/vue-flip-down)
这是一个简单的翻页倒计时vue组件项目中有用到所以提取了一下。
### 示例
![img](https://github.com/javaLuo/vue-flip-down/blob/master/public/demo.gif)
### 安装
```
npm install vue-flip-down --save
```
```
yarn add vue-flip-down
```
### 使用
```
import FlipDown from 'vue-flip-down';
<FlipDown
:endDate="1540212399971" // 倒计时截止的日期
:type="4" // 倒计时类型
@timeUp="func" // 时间到了会触发timeUp事件
/>
```
### 参数
| 名称 | 类型 | 默认 | 描述 |
| ------- | ----------- | ---- | ------------------------------------------------------------------------------------- |
| endDate | Date/Number | 0 | 结束的时间即倒计时会从当前时间一直到endDate停止可以是一个日期对象也可以是毫秒数 |
| type | Number | 4 | 要怎么显示倒计时4-日时分秒3-时分秒2-分秒1-秒 |
### 事件
| 名称 | 返回值 | 描述 |
| ------ | ------ | --------------------------------------- |
| timeUp | null | 当倒计时走到0时会触发一次表示时间到了 |
### 说明
* 内部使用了setTimeout当倒计时结束后就会停止循环。但可以动态改变日期倒计时又会被激活。
* 基于本地时间做对比