Skip to content

Commit

Permalink
fix: update readme to inform about MetroTween
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicolas committed Feb 9, 2018
1 parent 3b119fc commit 57912e8
Showing 1 changed file with 50 additions and 3 deletions.
53 changes: 50 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@

<a href="https://medium.com/@nicolasdelfino/introducing-react-metro-f766068212d5" target="_blank">Introducing React Metro</a>

### Important notes:
### Important note:

27/09: 1.4.0 introduces BREAKING CHANGES, improvements to the api, see docs below
1.9.1 uses custom tweener MetroTween.js, list of supported easing equations in docs.

#### Usage

Expand Down Expand Up @@ -121,7 +121,7 @@ renderLessVerboseContainer() {

```javascript
// Override Metro´s default animations settings for each unique item in your items
// array, see greensock tweenmax for reference.
// array, see MetroTween args further down.
// The animation settings are combined with the default animation settings, so
// you only have to specify the values you want to change.
const animationMap = [
Expand Down Expand Up @@ -180,6 +180,53 @@ const defaultAnimationOverride = {
};
```

#### MetroTween

MetroTween is Metro's new tween engine that replaces GSAP TweenMax.
It's 100% backward compatible with everything used in the codesandbox demo.

#### Supported tween equations:

```javascript
easeInSine;
easeOutSine;
easeInOutSine;
easeInQuad;
easeOutQuad;
easeInOutQuad;
easeInCubic;
easeOutCubic;
easeInOutCubic;
easeInQuart;
easeOutQuart;
easeInOutQuart;
easeInQuint;
easeOutQuint;
easeInOutQuint;
easeInExpo;
easeOutExpo;
easeInOutExpo;
easeInCirc;
easeOutCirc;
easeInOutCirc;
easeInBack;
easeOutBack;
easeInOutBack;
```

#### Tweenable properties

```javascript
x;
y;
skewX;
skewY;
scaleX;
scaleY;
rotation;
scale;
```

#### Methods

```javascript
Expand Down

0 comments on commit 57912e8

Please sign in to comment.