flip-your-number - npm Package Compare versions

Comparing version 0.0.1-beta.3 to 0.0.1-beta.4

lib/flipNumber.js

@@ -108,2 +108,3 @@ 'use strict';
       clearTimeout(this.updateNumberTimeout);
+      this.makeStatic.cancel();
     }
@@ -110,0 +111,0 @@ }, {

package.json

 {
   "name": "flip-your-number",
-  "version": "0.0.1-beta.3",
+  "version": "0.0.1-beta.4",
   "description": "flip number",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -1,2 +0,50 @@
-# react-simple-count-number
-React simple number counting 
+[![npm version](https://img.shields.io/npm/v/flip-your-number.svg?style=flat-square)](https://www.npmjs.com/package/flip-your-number)
+[![npm downloads](https://img.shields.io/npm/dm/flip-your-number.svg?style=flat-square)](https://www.npmjs.com/package/flip-your-number)
+[![npm](https://img.shields.io/npm/dt/flip-your-number.svg?style=flat-square)](https://www.npmjs.com/package/flip-your-number)
+[![npm](https://img.shields.io/npm/l/flip-your-number.svg?style=flat-square)](https://www.npmjs.com/package/flip-your-number)
+
+> **Make number animation looks sexy** :clap:
+
+Features:
+
+* Flip your nubmer in 3D space
+* Super easy to use
+
+## Install
+
+    $ yarn add flip-your-number
+    or
+    $ npm install flip-your-number -S
+
+## Quick start
+
+    import react from 'react';
+    import FlipNumbers from 'flip-your-number';
+
+    export default function SexyComponent(props) {
+        return <div>
+            <FlipNumbers
+                height="12px"
+                width="12px"
+                color="red"
+                background="white"
+                startAnimation
+                numbersToDisplay={12345}
+          />
+        </div>;
+    }
+
+## API
+
+| Prop                  | Type     | Required | Description                                                                            |
+| :-------------------- | :------- | :------: | :------------------------------------------------------------------------------------- |
+| `numbers`      | string  |    ✓     |                                  |
+| `nonNumberStyle`            | string    |          | Css inline style for not number eg , : . |
+| `height`              | number |    ✓      | Individual number height |
+| `width`              | number |    ✓      | Individual number width |
+| `color`              | string |     ✓     | Number color |
+| `background`              | string |    ✓      | Background color |
+| `perspective`              | number |          | Css 3D transition perspective |
+| `durationSeconds`              | number |          |  |
+| `delaySeconds`              | number |          |  |
+| `startAnimation`              | boolean |     ✓     | Start the animation |

src/flipNumber.js

@@ -63,2 +63,3 @@ // @flow
     clearTimeout(this.updateNumberTimeout);
+    this.makeStatic.cancel();
   }
@@ -65,0 +66,0 @@

No alert changes

Improved metrics

Total package byte prevSize

233451

increased by0.94%

Lines of code

613

increased by0.33%

Number of lines in readme file

51

increased by1600%

No dependency changes