@material/animation - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "@material/animation",
   "description": "Animation Variables and Mixins used by Material Components for the web",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "license": "Apache-2.0",
+  "main": "index.js",
   "repository": {
@@ -7,0 +8,0 @@ "type": "git",

README.md

 # mdc-animation
 
-mdc-animation is a sass / css library which provides variables, mixins, and classes for Material Design animation, based off of the [motion guidelines](https://material.google.com/motion/duration-easing.html#duration-easing-common-durations). Currently, it only covers easing curves.
+mdc-animation is a Sass / CSS / JavaScript library which provides a toolbelt for Material Design animation, based off of the [motion guidelines](https://material.google.com/motion/duration-easing.html#duration-easing-common-durations). Currently, it only covers easing curves.
 
@@ -100,1 +100,19 @@ ## Installation
 arise.
+
+### JavaScript
+
+MDC Web ships with a set of utility functions designed to make animations easier to implement.
+
+### Using Utility Functions
+
+To use:
+```js
+import {getCorrectEventName} from '@material/mdc-animation';
+
+const eventToListenFor = getCorrectEventName(window, 'animationstart');
+```
+
+| Method Signature | Description |
+| --- | --- |
+| `getCorrectEventName(windowObj: Object, eventType: string)` | Returns a JavaScript event name. Prefixed if necessary. |
+| `getCorrectPropertyName(windowObj: Object, eventType: string)` | Returns a CSS property name. Prefixed if necessary. |

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14378

increased by44.87%

Number of package files

9

increased by12.5%

Lines of code

173

increased by170.31%

Number of lines in readme file

118

increased by18%

No dependency changes