From 63b914792574c171e26dca47e25c12eb9615ab24 Mon Sep 17 00:00:00 2001 From: Alex Holachek Date: Thu, 4 Jul 2024 22:30:23 -0400 Subject: [PATCH] react-flip-toolkit 7.2.0 --- CONTRIBUTING.md | 19 +++++++------------ packages/react-flip-toolkit/README.md | 23 ++++++++++++++++++++--- packages/react-flip-toolkit/package.json | 4 ++-- 3 files changed, 29 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0432d05..4a35511 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,20 +6,15 @@ Some unfortunately non-automated tasks that need to be done manually: 2. Run `yarn format-and-fix` in the top level dir 3. Make sure readme is up-to-date 4. Verify that no unintended deps were added to `dependencies` in either package.json. - -### Beta Version - -Publish a beta version by doing something like: - -- manually increment the version number as appropriate - -`npm publish --tag beta` - -in `flip-toolkit` (first), then updating the version of `flip-toolkit` in `react-flip-toolkit` and repeating the steps. - + ### Real release -1. Release `flip-toolkit`, wait a bit (30mins+) and ensure the correct version shows up on: +1. Release `flip-toolkit`: + - increment version number + - run yarn build + - run npm publish + + Then, wait a bit (30mins+) and ensure the correct version shows up on: - npm: https://www.npmjs.com/package/flip-toolkit - unpkg: https://unpkg.com/flip-toolkit - package-phobia: https://packagephobia.com/result?p=flip-toolkit diff --git a/packages/react-flip-toolkit/README.md b/packages/react-flip-toolkit/README.md index b42661e..54dcad1 100644 --- a/packages/react-flip-toolkit/README.md +++ b/packages/react-flip-toolkit/README.md @@ -467,14 +467,31 @@ spring({ spring example + +## Global configuration functions + +You can programmatically call the following functions if you need to disable (or re-enable) FLIP animations everywhere. + +#### `disableFlip()` + +Global switch to disable all animations in all `Flipper` containers. + +#### `enableFlip()` + +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()`. + +#### `isFlipEnabled()` + +Returns a boolean indicating whether animations are globally enabled or disabled. + + ## Library details browserstack -- Tested in latest Chrome, Firefox, Safari, Edge, and IE 11 with [Browserstack](https://www.browserstack.com/). -- For IE11 compatability, make sure you're polyfilling the `window.Promise` object. +- Tested in latest Chrome, Firefox, Safari, and Edge with [Browserstack](https://www.browserstack.com/). - Requires React 16+ - 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 @@ -517,4 +534,4 @@ When you trigger a complex FLIP animation with `react-flip-toolkit`, `React` cou } ``` -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. +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. diff --git a/packages/react-flip-toolkit/package.json b/packages/react-flip-toolkit/package.json index 7568c7d..ee5b963 100644 --- a/packages/react-flip-toolkit/package.json +++ b/packages/react-flip-toolkit/package.json @@ -1,6 +1,6 @@ { "name": "react-flip-toolkit", - "version": "7.1.0", + "version": "7.2.0", "description": "Configurable FLIP animation helpers for React", "license": "MIT", "source": "src/index.ts", @@ -48,7 +48,7 @@ "prepublish": "npm run build" }, "dependencies": { - "flip-toolkit": "7.1.0", + "flip-toolkit": "7.2.0", "prop-types": "^15.8.1" }, "peerDependencies": {