Skip to content

Commit 63b9147

Browse files
committed
react-flip-toolkit 7.2.0
1 parent f8d54a1 commit 63b9147

File tree

3 files changed

+29
-17
lines changed

3 files changed

+29
-17
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,15 @@ Some unfortunately non-automated tasks that need to be done manually:
66
2. Run `yarn format-and-fix` in the top level dir
77
3. Make sure readme is up-to-date
88
4. Verify that no unintended deps were added to `dependencies` in either package.json.
9-
10-
### Beta Version
11-
12-
Publish a beta version by doing something like:
13-
14-
- manually increment the version number as appropriate
15-
16-
`npm publish --tag beta`
17-
18-
in `flip-toolkit` (first), then updating the version of `flip-toolkit` in `react-flip-toolkit` and repeating the steps.
19-
9+
2010
### Real release
2111

22-
1. Release `flip-toolkit`, wait a bit (30mins+) and ensure the correct version shows up on:
12+
1. Release `flip-toolkit`:
13+
- increment version number
14+
- run yarn build
15+
- run npm publish
16+
17+
Then, wait a bit (30mins+) and ensure the correct version shows up on:
2318
- npm: https://www.npmjs.com/package/flip-toolkit
2419
- unpkg: https://unpkg.com/flip-toolkit
2520
- package-phobia: https://packagephobia.com/result?p=flip-toolkit

packages/react-flip-toolkit/README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -467,14 +467,31 @@ spring({
467467
<img src="./example-assets/spring.gif" alt="spring example" width="200px"/>
468468
</a>
469469

470+
471+
## Global configuration functions
472+
473+
You can programmatically call the following functions if you need to disable (or re-enable) FLIP animations everywhere.
474+
475+
#### `disableFlip()`
476+
477+
Global switch to disable all animations in all `Flipper` containers.
478+
479+
#### `enableFlip()`
480+
481+
Global switch to (re-)enable all animations in all `Flipper` containers. Animations are enabled by default. Calling this function is needed only if animations were previously disabled with `disableFlip()`.
482+
483+
#### `isFlipEnabled()`
484+
485+
Returns a boolean indicating whether animations are globally enabled or disabled.
486+
487+
470488
## Library details
471489

472490
<a href="https://www.browserstack.com/">
473491
<img src="./example-assets/browserstack.png" alt="browserstack" width="140"/>
474492
</a>
475493

476-
- Tested in latest Chrome, Firefox, Safari, Edge, and IE 11 with [Browserstack](https://www.browserstack.com/).
477-
- For IE11 compatability, make sure you're polyfilling the `window.Promise` object.
494+
- Tested in latest Chrome, Firefox, Safari, and Edge with [Browserstack](https://www.browserstack.com/).
478495
- Requires React 16+
479496
- Uses [Rematrix](https://github.com/jlmakes/rematrix) for matrix calculations and a simplified fork of [Rebound](https://github.com/facebook/rebound-js) for spring animations
480497

@@ -517,4 +534,4 @@ When you trigger a complex FLIP animation with `react-flip-toolkit`, `React` cou
517534
}
518535
```
519536

520-
This [CSS property](https://dev.opera.com/articles/css-will-change-property/) tells the browser to anticipate changes to an element. It should be used with caution, because it can increase browser resource usage. If you notice rendering issues in your animation, I would recommend trying it out and seeing if it increases the performance of the animation.
537+
This [CSS property](https://dev.opera.com/articles/css-will-change-property/) tells the browser to anticipate changes to an element. It should be used with caution, because it can increase browser resource usage. If you notice rendering issues in your animation, try seeing if it increases the performance of the animation.

packages/react-flip-toolkit/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-flip-toolkit",
3-
"version": "7.1.0",
3+
"version": "7.2.0",
44
"description": "Configurable FLIP animation helpers for React",
55
"license": "MIT",
66
"source": "src/index.ts",
@@ -48,7 +48,7 @@
4848
"prepublish": "npm run build"
4949
},
5050
"dependencies": {
51-
"flip-toolkit": "7.1.0",
51+
"flip-toolkit": "7.2.0",
5252
"prop-types": "^15.8.1"
5353
},
5454
"peerDependencies": {

0 commit comments

Comments
 (0)