animare/lib/typescript/utils/helpers.d.ts

Advanced animation library for modern JavaScript.

import Animation from '../animation.js';
import { Direction, Timing } from '../types.js';
import type { AnimationOptions, AnimationOptionsWithoutFn, AnimationPreparedOptions, TimelineGlobalOptions } from '../types.js';
export declare const defaultValues: {
    from: number;
    duration: number;
    delay: number;
    offset: number;
    delayCount: number;
    playCount: number;
    direction: Direction;
    timing: Timing;
    ease: (t: number) => number;
};
/**
 * Returns `true` if the animation is an alternate or alternate-reverse direction
 */
export declare function isAlternateDirection(direction: Direction): direction is Direction.Alternate | Direction.AlternateReverse;
/**
 * Returns `true` if the animation is an reverse or alternate-reverse direction
 */
export declare function isReverseDirection(direction: Direction): direction is Direction.Reverse | Direction.AlternateReverse;
export declare function validateAnimationValues(animation: AnimationOptions): void;
/**
 * - Set the default values for a single animation.
 * - If a value is optional and not passed, the default value from the global values will be used, else a default value will be used.
 */
export declare function setDefaultValues(animation: AnimationOptions, globalValues: TimelineGlobalOptions, index: number): AnimationPreparedOptions;
export declare function prepareAnimationsPartialOptions<Name extends string>(newValues: Partial<AnimationOptions>, index: number): Partial<AnimationOptionsWithoutFn<Name>>;
export declare function prepareAnimationsValues(animations: AnimationOptions[], globalValues: TimelineGlobalOptions): AnimationPreparedOptions[];
export declare function prepareTimelineValues(options: TimelineGlobalOptions): {
    timelinePlayCount: number;
    autoPlay: boolean;
    timelineSpeed: number;
};
/**
 * Create `Animation` classes and return them in an array
 */
export declare function calculateTimeline(animations: AnimationPreparedOptions[]): Animation[];
/** Returns the overall duration of the timeline */
export declare function calculateTimelineDuration(timelines: Animation[]): number;
//# sourceMappingURL=helpers.d.ts.map