@omicrxn/mercury/dist/mercury/animation-interface.d.ts

Mercury is a Svelte animation library using AnimeJS under the hood. It simplifies complex animations with Svelte actions, provides layout and exit animations, and integrates seamlessly with Svelte features.

export interface AnimationEngine {
    animate(target: HTMLElement | any, params: AnimationParams): AnimationInstance;
}
export type EasingFunction = readonly [number, number, number, number] | 'linear' | 'easeIn' | 'easeOut' | 'easeInOut' | 'circIn' | 'circOut' | 'circInOut' | 'backIn' | 'backOut' | 'backInOut' | 'anticipate' | string;
export interface AnimationTransition {
    duration?: number;
    autoplay?: boolean;
    delay?: number;
    ease?: EasingFunction | EasingFunction[];
    repeat?: number;
    repeatType?: 'loop' | 'reverse' | 'mirror';
    repeatDelay?: number;
    type?: 'decay' | 'spring' | 'keyframes' | 'tween' | 'inertia';
    stiffness?: number;
    damping?: number;
    velocity?: number;
    mass?: number;
}
export interface AnimationCallbacks {
    onBegin?: () => void;
    onComplete?: () => void;
    onUpdate?: (value: any) => void;
    onRender?: () => void;
    onLoop?: () => void;
}
export interface AnimationAttributes {
    [key: string]: any;
}
export interface InteractionAnimation extends AnimationAttributes {
    transition?: AnimationTransition;
}
export interface PresenceAnimation extends AnimationAttributes {
    transition?: AnimationTransition;
    popLayout?: boolean;
}
export interface ScrollInteractionAnimation extends InteractionAnimation {
    root?: HTMLElement;
    margin?: string;
    amount?: number | 'all' | 'some' | undefined;
    enter?: AnimationAttributes;
    exit?: AnimationAttributes;
}
export interface DraggableParams {
    axis?: 'x' | 'y' | 'lock' | undefined;
    bounds?: {
        left?: number;
        right?: number;
        top?: number;
        bottom?: number;
    } | HTMLElement | {
        current: HTMLElement | null;
    };
    rubberband: boolean | number;
}
export interface AnimationParams {
    instance?: (instance: AnimationInstance) => void;
    animate?: AnimationAttributes;
    transition?: AnimationTransition;
    onHoverStart?: (event: PointerEvent) => void;
    onHoverEnd?: (event: PointerEvent) => void;
    whileHover?: InteractionAnimation;
    onTapStart?: (event: PointerEvent) => void;
    onTapEnd?: (event: PointerEvent) => void;
    whileTap?: InteractionAnimation;
    drag?: boolean;
    whileDrag?: DraggableParams;
    onDragStart?: (event: PointerEvent | MouseEvent | TouchEvent | KeyboardEvent) => void;
    onDragEnd?: (event: PointerEvent | MouseEvent | TouchEvent | KeyboardEvent) => void;
    scroll?: ScrollInteractionAnimation;
    engine?: AnimationEngine;
    callbacks?: AnimationCallbacks;
}
export interface AnimationInstance {
    play: () => any | void;
    pause: () => any | void;
    cancel: () => any | void;
    onComplete: (onResolve: VoidFunction, onReject?: VoidFunction) => Promise<any>;
    completed: boolean;
}