vue-flip-down/README.md
2021-04-16 14:54:54 +08:00

63 lines
2.3 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/dt/vue-flip-down.svg)](https://www.npmjs.com/package/vue-flip-down)
这是一个简单的翻页倒计时vue组件项目中有用到所以提取了一下。<br/>
你们也可以直接把`src/app.vue`文件拷贝到项目里直接用就是个普通vue组件就不用`npm install`
# 注意vue2.x 和 vue3.x
**vue-flip-down 1.x的版本仅适用于vue2.x**<br/>
**vue-flip-down 3.x的版本仅适用于vue3.x**
### 示例
![img](public/demo.gif)
### 在线DEMO
<a href="https://isluo.com/work/vue-flip-down/" target="_blank">https://isluo.com/work/vue-flip-down/</a>
### 安装
```
npm install vue-flip-down --save
```
### 使用
```vue
import FlipDown from 'vue-flip-down';
<FlipDown
:endDate="1540212399971" // 倒计时截止的日期
@timeUp="func" // 时间到了会触发timeUp事件
/>
```
### 参数
| 名称 | 类型 | 默认 | 描述 |
| ------- | ----------- | ---- | ------------------------------------------------------------------------------------- |
| endDate | Date/Number | 0 | 结束的时间即倒计时会从当前时间一直到endDate停止可以是一个日期对象也可以是毫秒数 |
| type | Number | 4 | 要怎么显示倒计时4-日时分秒3-时分秒2-分秒1-秒 |
|theme|Number|1|样式1-合并2-分离。见下图|
|timeUnit|Array|\[\]|时间单位,显示在空隙之间的文字,比如:\['天','时','分','秒'\] 或 \[':',':',':'\]|
#### :theme="1" 合并式
![img](public/1.gif)
> 合并式的,每个不同的时间单位是合在一起的
#### :theme="2" 分离式
![img](public/2.gif)
> 分离式的,每个数字都是单独分开的
### 事件
| 名称 | 返回值 | 描述 |
| ------ | ------ | --------------------------------------- |
| timeUp | null | 当倒计时走到0时会触发一次表示时间到了 |
### 说明
* 内部使用了setTimeout当倒计时结束后就会停止循环。但可以动态改变日期倒计时又会被激活。
* 基于本地时间做对比