react-native-zoom-toolkit/lib/typescript/src/commons/types.d.ts

Smoothly zoom any image, video or component you want!

import type { GestureStateChangeEvent, PinchGestureHandlerEventPayload, TapGestureHandlerEventPayload, PanGestureHandlerEventPayload } from 'react-native-gesture-handler';
import type { EasingFunction, EasingFunctionFactory, ReduceMotion } from 'react-native-reanimated';
import type { HitSlop } from 'react-native-gesture-handler/lib/typescript/handlers/gestureHandlerCommon';
export type TimingConfig = Partial<{
    duration: number;
    easing: EasingFunction | EasingFunctionFactory;
    reduceMotion: ReduceMotion;
}>;
export type Vector<T> = {
    x: T;
    y: T;
};
export type SizeVector<T> = {
    width: T;
    height: T;
};
export type BoundsFuction = (scale: number) => Vector<number>;
export declare enum SwipeDirection {
    UP = 0,
    DOWN = 1,
    LEFT = 2,
    RIGHT = 3
}
/**
 * @description Determine how your component must behave when it reaches the specified boundaries
 * by its enclosing container.
 */
export declare enum PanMode {
    /** @description Prevents the user from dragging the component out of the specified boundaries. */
    CLAMP = 0,
    /**
     * @description Lets the user drag the component around freely, when the pan gesture ends
     * the component will return to a position within the specified boundaries.
     */
    FREE = 1,
    /**
     * @description Lets the user drag the component around freely applying friction to the pan gesture
     * up to a point where it's stopped completely, when the pan gesture ends the component will return
     * to a position within the specified boundaries.
     */
    FRICTION = 2
}
/**
 * @description Determine how your component must behave when the pinch gesture's scale value
 * exceeds the specified boundaries by minScale and maxScale properties.
 */
export declare enum ScaleMode {
    /**
     * @description Prevents the user from exceeding the scale boundaries.
     */
    CLAMP = 0,
    /**
     * @description Lets the user scale above and below the scale boundary values, when the pinch
     * gesture ends the scale value returns to minScale or maxScale respectively.
     */
    BOUNCE = 1
}
export declare enum PinchCenteringMode {
    CLAMP = 0,
    INTERACTION = 1
}
export type CommonZoomProps = Partial<{
    hitSlop: HitSlop;
    timingConfig: TimingConfig;
    onGestureEnd: () => void;
}>;
export type CommonResumableProps = Partial<{
    minScale: number;
    maxScale: number;
    panMode: PanMode;
    scaleMode: ScaleMode;
    allowPinchPanning: boolean;
}>;
export type TapGestureEvent = GestureStateChangeEvent<TapGestureHandlerEventPayload>;
export type PinchGestureEvent = GestureStateChangeEvent<PinchGestureHandlerEventPayload>;
export type PanGestureEvent = GestureStateChangeEvent<PanGestureHandlerEventPayload>;
export type PanGestureEventCallback = (e: PanGestureEvent) => void;
export type TapGestureEventCallback = (e: TapGestureEvent) => void;
export type PinchGestureEventCallback = (e: PinchGestureEvent) => void;
export type PanGestureCallbacks = Partial<{
    onPanStart: PanGestureEventCallback;
    onPanEnd: PanGestureEventCallback;
}>;
export type PinchGestureCallbacks = Partial<{
    onPinchStart: PinchGestureEventCallback;
    onPinchEnd: PinchGestureEventCallback;
}>;
export type TapGestureCallbacks = Partial<{
    onTap: TapGestureEventCallback;
    onDoubleTap: TapGestureEventCallback;
}>;
export type ZoomEventCallbacks = Partial<{
    onZoomBegin: (index: number) => void;
    onZoomEnd: (index: number) => void;
}>;
//# sourceMappingURL=types.d.ts.map