react-native-reanimated
Version:
More powerful alternative to Animated library for React Native.
88 lines • 3.01 kB
TypeScript
import type { ReduceMotion } from '../../commonTypes';
export declare const Reanimated3DefaultSpringConfig: {
readonly damping: 10;
readonly mass: 1;
readonly stiffness: 100;
};
export declare const Reanimated3DefaultSpringConfigWithDuration: {
readonly duration: 1333;
readonly dampingRatio: 0.5;
};
export declare const WigglySpringConfig: {
readonly damping: 90;
readonly mass: 4;
readonly stiffness: 900;
};
export declare const WigglySpringConfigWithDuration: {
readonly duration: 550;
readonly dampingRatio: 0.75;
};
export declare const GentleSpringConfig: {
readonly damping: 120;
readonly mass: 4;
readonly stiffness: 900;
};
export declare const GentleSpringConfigWithDuration: {
readonly duration: 550;
readonly dampingRatio: 1;
};
export declare const SnappySpringConfig: {
readonly damping: 110;
readonly mass: 4;
readonly stiffness: 900;
readonly overshootClamping: true;
};
export declare const SnappySpringConfigWithDuration: {
readonly duration: 550;
readonly dampingRatio: 0.92;
readonly overshootClamping: true;
};
/**
* Spring animation configuration.
*
* @param mass - The weight of the spring. Reducing this value makes the
* animation faster. Defaults to 4.
* @param damping - How quickly a spring slows down. Higher damping means the
* spring will come to rest faster. Defaults to 120.
* @param stiffness - How bouncy the spring is. Defaults to 900.
* @param duration - Perceptual duration of the animation in milliseconds.
* Actual duration is 1.5 times higher. Defaults to 550ms if `dampingRatio` is
* provided.
* @param dampingRatio - How damped the spring is. Value `1` means the spring is
* critically damped, value `<1` means the spring is underdamped and value
* `>1` means the spring is overdamped. Defaults to 1 if `duration` is
* provided.
* @param velocity - Initial velocity applied to the spring equation. Defaults
* to 0.
* @param overshootClamping - Whether a spring can bounce over the `toValue`.
* Defaults to false.
* @param energyThreshold - Relative energy threshold below which the spring
* will snap to `toValue` without further oscillations. Defaults to 6e-9.
* @param reduceMotion - Determines how the animation responds to the device's
* reduced motion accessibility setting. Default to `ReduceMotion.System` -
* {@link ReduceMotion}.
* @see https://docs.swmansion.com/react-native-reanimated/docs/animations/withSpring/#config-
*/
export type SpringConfig = {
stiffness?: number;
overshootClamping?: boolean;
energyThreshold?: number;
velocity?: number;
reduceMotion?: ReduceMotion;
} & ({
mass?: number;
damping?: number;
duration?: never;
dampingRatio?: never;
clamp?: never;
} | {
mass?: never;
damping?: never;
duration?: number;
dampingRatio?: number;
clamp?: {
min?: number;
max?: number;
};
});
//# sourceMappingURL=springConfigs.d.ts.map