@kcirtaptrick/framer-motion
Version:
A simple and powerful React animation library
55 lines (52 loc) • 2.19 kB
JavaScript
import { useTransform } from './use-transform.mjs';
import { invariant, warning } from 'hey-listen';
import { useMotionValue } from './use-motion-value.mjs';
import { useVisualElementContext } from '../context/MotionContext/index.mjs';
// Keep things reasonable and avoid scale: Infinity. In practise we might need
// to add another value, opacity, that could interpolate scaleX/Y [0,0.01] => [0,1]
// to simply hide content at unreasonable scales.
var maxScale = 100000;
var invertScale = function (scale) {
return scale > 0.001 ? 1 / scale : maxScale;
};
var hasWarned = false;
/**
* Returns a `MotionValue` each for `scaleX` and `scaleY` that update with the inverse
* of their respective parent scales.
*
* This is useful for undoing the distortion of content when scaling a parent component.
*
* By default, `useInvertedScale` will automatically fetch `scaleX` and `scaleY` from the nearest parent.
* By passing other `MotionValue`s in as `useInvertedScale({ scaleX, scaleY })`, it will invert the output
* of those instead.
*
* ```jsx
* const MyComponent = () => {
* const { scaleX, scaleY } = useInvertedScale()
* return <motion.div style={{ scaleX, scaleY }} />
* }
* ```
*
* @deprecated
* @internal
*/
function useInvertedScale(scale) {
var parentScaleX = useMotionValue(1);
var parentScaleY = useMotionValue(1);
var visualElement = useVisualElementContext();
invariant(!!(scale || visualElement), "If no scale values are provided, useInvertedScale must be used within a child of another motion component.");
warning(hasWarned, "useInvertedScale is deprecated and will be removed in 3.0. Use the layout prop instead.");
hasWarned = true;
if (scale) {
parentScaleX = scale.scaleX || parentScaleX;
parentScaleY = scale.scaleY || parentScaleY;
}
else if (visualElement) {
parentScaleX = visualElement.getValue("scaleX", 1);
parentScaleY = visualElement.getValue("scaleY", 1);
}
var scaleX = useTransform(parentScaleX, invertScale);
var scaleY = useTransform(parentScaleY, invertScale);
return { scaleX: scaleX, scaleY: scaleY };
}
export { invertScale, useInvertedScale };