animated-number-vue - npm Package Compare versions

Comparing version 0.0.7 to 0.1.0

package.json

 {
   "name": "animated-number-vue",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "private": false,
@@ -5,0 +5,0 @@ "scripts": {

README.md

@@ -37,3 +37,3 @@ # animated-number-vue
       value: 1000
-    };
+    }
   },
@@ -53,3 +53,3 @@ methods: {
 ## Props
-Follwing `props` are used while initialization
+Following `props` are used while initialization
 > Note : Only `value` is a required prop. Others are optional
@@ -60,5 +60,46 @@
 | value `(required)`| [ Number, String] | number that will be animated |
-| formatValue `(optional)`| Function | a function that will manipulate the animated value |
 | duration `(optional)`| Number | the duration of animation |
+| delay `(optional)`| Number | the delay of animation |
+| easing `(optional)`| String | you can found all valid values [here](https://github.com/juliangarnier/anime#easing-functions) |
 
----
+
+
+#### Callbacks props
+
+Execute a function at the beginning, during or when an animation or timeline is completed.
+
+| Names | Types | Arguments | Info
+| --- | --- | --- | ---
+| formatValue | Function | value `String` | A function that will manipulate the animated value |
+| update | Function| animation `Object` | Called at time = 0
+| run | Function| animation `Object` | Called after delay is finished
+| begin | Function | animation `Object` | Called after animation delay is over
+| complete | Function | animation `Object` | Called only after all the loops are completed
+
+### Format Value
+
+`formatValue()` is used to format the animatedValue.
+
+### Update
+
+`update()` is called on every frame while the instance is playing.
+
+
+### Begin
+
+`begin()` is called once after the delay is finished.
+
+
+
+Check if the animation has begun with `myAnimation.began`, return `true` or `false`.
+
+
+### Run
+
+`run()` is called every frame after the delay is finished.
+
+
+### Complete
+
+`complete()` is called once after the animation is finished.
+

No alert changes

Improved metrics

Total package byte prevSize

186342

3.97%

Number of package files

23

21.05%

Lines of code

898

11.41%

Number of lines in readme file

103

68.85%

No dependency changes