vue-canvas-countdown - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

index.js

 import countDown from './src/components/countDown.vue'
 
 export default countDown

package.json

 {
   "name": "vue-canvas-countdown",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A Vue.js component (canvas实现类似时钟的倒计时效果)",
@@ -17,3 +17,4 @@ "author": "Damon",
   "dependencies": {
-    "vue": "^2.5.2"
+    "vue": "^2.5.2",
+    "vue-canvas-countdown": "^1.0.0"
   },
@@ -20,0 +21,0 @@ "devDependencies": {

README.md

@@ -1,24 +0,43 @@
-# vue-countdown
+# vue-countdown ![downloads](https://img.shields.io/badge/downloads-8k-brightgreen.svg) ![downloads](https://img.shields.io/badge/license-MIT-brightgreen.svg)
 a cool && nice  countdown timer component (canvas used) for vue2.x
 
-> canvas实现类似时钟倒计时效果的vue插件。移动端友好。
+> vue + canvas实现炫酷时钟倒计时效果的vue插件。移动端友好。
 
 ## show result 效果展示
 
+#### 效果图gif展示
+  说明：此gif清晰度很低，因为转成gif图的时候，质量受损，帧数减少，所以倒计时转到红色时候看起来变的很模糊。但是实际在浏览器上效果全程都是很清晰和连贯的
+
 ![Damon风](https://github.com/Damon0820/vue-countdown/blob/master/static/img/show1.gif "Damon风")
+#### 运动过程的高清截图展示
+  说明：由于git图清晰度低，辅助用以下几张高清截图展示效果
+
+<br/>![Damon风](https://github.com/Damon0820/vue-countdown/blob/master/static/img/countdown-1.png "Damon风") ![Damon风](https://github.com/Damon0820/vue-countdown/blob/master/static/img/countdown-2.png "Damon风") ![Damon风](https://github.com/Damon0820/vue-countdown/blob/master/static/img/countdown-3.png "Damon风") <img src="https://github.com/Damon0820/vue-countdown/blob/master/static/img/countdown-4.png" width="140" hegiht="140" align=center />
 </br>[Damon风的blog地址](https://www.cnblogs.com/damonFeng/)
 
+#### 动画步骤分析：假如设定倒计时总时间为15s， 变黄色时机为10s，变红色时机为5s。
+1. 开始倒计时后颜色为绿色。绿色含义是：倒计时的时间离结束时间还很长。
+2. 10s后变黄色。黄色的含义是：倒计时的时间离结束时间挺近了，第一次加速，起警告作用。动画中，出现快速旋转的扇形。
+3. 5s后变红色。红色的含义是：倒计时的时间马上就要结束了，第二次加速，起强烈警告作用。动画中，快速旋转的扇形速度加快。
+4. 0s倒计时结束。动画消失。静态圆形框中显示提示文字。
+
 ## Installation
 
-### npm
+### npm 下载
 ```
-尽请期待：目前可直接下载源码目录下src/components/countDown.vue组件直接引用）
+npm install vue-canvas-countdown --save-dev
 ````
 
-### import
+### import 引入
+
+####  es6
 ````
-尽请期待：目前可直接下载源码目录下src/components/countDown.vue组件直接引用）
+import countDown from 'vue-canvas-countdown'
 ````
+####  commonjs
+````
+const countDown = require('vue-canvas-countdown')
+````
 
-### Usage
+### Usage 使用方法
 
@@ -30,9 +49,8 @@ ``` html
       <countDown 
+        ref="countDown"
         :fire="fire"
-        :time="time"
-        :width="width"
-        :height="height"
+        time="15"
         :tiping="tiping"
         :tipend="tipend"
-        :bgCir="bgCir"
+        @onStatusChange="onStatusChange"
         @onEnd="onEnd"/>
@@ -46,3 +64,3 @@ </div>
 
-import countDown from './components/countDown'
+import countDown from 'vue-canvas-countdown'
 export default {
@@ -56,14 +74,10 @@ name: 'App',
       fire: 0,
-      time: 16,
-      width: 200,
-      height: 200,
       tiping: {
-        text: '倒计时啊',
+        text: '倒计时进行中',
         color: '#fff'
       },
       tipend: {
-        text: '结束了',
+        text: '倒计时结束',
         color: '#fff'
-      },
-      bgCir: 'rgba(0, 0, 0, .6)'
+      }
     }
@@ -73,26 +87,22 @@ },
     fireCD () {
-      // 自定义参数设置
-      this.time = 33
-      this.width = 300
-      this.height = 300
-      this.tiping = 'gogogo'
-      this.bgCir = 'rgba(255, 255, 111, .6)'
+      // 配置参数（更多配置如下表）
       this.tiping = {
-        text: '倒计了啊',
-        color: '#3f3'
+        text: '请下注',
+        color: '#fff'
       }
       this.tipend = {
-        text: 'over',
-        color: '#f33'
+        text: '停止下注',
+        color: '#fff'
       }
-      // 启动倒计时
-      this.fire++
+
+      // 启动倒计时(效果如上图所示)      
+      // 也支持：this.$refs.countDown.startCd()方式 启动倒计时
+      this.fire++ 
     },
+    onStatusChange (payload) {
+      console.log('倒计时状态改变：', payload)
+    },
     onEnd () {
       console.log('倒计时结束的回调函数')
     }
-  },
-  mounted () {
-    // 启动倒计时
-    this.fire++    
   }
@@ -103,14 +113,21 @@ }
 
+
 ### Props 参数
-        属性           可选  类型     单位    默认值                   备注
+属性 | 可选 | 类型 | 单位 | 默认值 | 备注
+--- | :--: | :--: | :--: | :--: | :--:
+fire: |         必选 |  [Number]  | -  |     200   |                   在父组件this.fire++ 即可启动倒计时(也支持：ref组件引用调用startCd方法启动倒计时)
+width,height: | 可选 | [Number] | px  |   200 200 |                 设置宽高
+bgCir:  |      可选 | [String] |  - |    rgba(0, 0, 0, .6)  |               倒计时圆盘背景颜色
+time:   |     可选 | [Number] | 秒/s  |  15         |              倒计时所用
+statusChange: | 可选 | [Array] | 毫秒/ms | [10000, 500]       |                倒计时状态改变的时机/时间点（绿=>黄=>红）
+tiping:    |   可选 | [Object]  |  -  |  {text: '倒计时', color: '#fff'} |    倒计时进行时的静态文本内容和颜色(注意：color和text都得设置)
+tipend:     |  可选 | [Object]   |  - |   {text: 'END', color: '#fff'}     |  倒计时结束时的静态文本内容和颜色(注意：color和text都得设置)
 
-      * fire:         必选  [Number]  px   default: 200        在父组件this.fire++ 即可启动倒计时
-      * width,height: 可选  [Number]  px   default: 200 200    设置宽高
-      * bgCir:        可选  [String]       rgba(0, 0, 0, .6)   倒计时圆盘背景颜色
-      * time:         可选  [Number]  px   default: 15         倒计时所用
-      * statusChange: 可选  [Array]        [10000, 500]        倒计时状态改变的时机/时间点（绿=>黄=>红）
-      * tiping:       可选  [Object]       {text: '倒计时', color: '#fff'}    倒计时进行时的静态文本内容和颜色(注意：color和text都得设置)
-      * tipend:       可选  [Object]       {text: 'END', color: '#fff'}       倒计时结束时的静态文本内容和颜色(注意：color和text都得设置)
+### Method 事件
+事件名 | 方法说明 | 参数说明
+--- | :--: | :--:
+onStatusChange: |  倒计时状态的变化：从开启->第一次加快->第二次加快->结束 <br>（使用场景：例如给倒计时在不同状态添加音效） | 0倒计时未启动/结束， 1开始倒计时， 2倒计时第一次加快， 3倒计时第二次加快
+onEnd: |  倒计时结束    | 等价于 onStatusChange事件0的状态
 
 ### Describe 说明 
-  welcome your issue  and commit
+  welcome your issue  and PR

No alert changes

Improved metrics

Total package byte prevSize

3074410

3.76%

Number of package files

37

8.82%

Number of lines in readme file

129

15.18%

Worsened metrics

Dependency count

2

100%

Dependency changes

• + Added

  vue-canvas-countdown@^1.0.0