JavaScript animation engine
Cleanup types
Julian Garnier3b6584eee49f
diff --git a/lib/anime.esm.js b/lib/anime.esm.jsindex 4a19e36a..fd6b7e02 100644--- a/lib/anime.esm.js+++ b/lib/anime.esm.js@@ -36,10 +36,62 @@/** @typedef {JSAnimation|Timeline} Renderable *//** @typedef {Timer|Renderable} Tickable *//** @typedef {Timer&JSAnimation&Timeline} CallbackArgument */-/** @typedef {DraggableParams} DraggableParams */-/** @typedef {DrawableSVGGeometry} DrawableSVGGeometry *//** @typedef {Animatable|Tickable|Draggable|ScrollObserver|Scope} Revertible */+/**+ * @typedef {Object} DraggableAxisParam+ * @property {String} [mapTo]+ * @property {TweenModifier} [modifier]+ * @property {TweenComposition} [composition]+ * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [snap]+ */++/**+ * @typedef {Object} DraggableCursorParams+ * @property {String} [onHover]+ * @property {String} [onGrab]+ */++/**+ * @typedef {Object} DraggableParams+ * @property {DOMTargetSelector} [trigger]+ * @property {DOMTargetSelector|Array<Number>|((draggable: Draggable) => DOMTargetSelector|Array<Number>)} [container]+ * @property {Boolean|DraggableAxisParam} [x]+ * @property {Boolean|DraggableAxisParam} [y]+ * @property {TweenModifier} [modifier]+ * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [snap]+ * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [containerPadding]+ * @property {Number|((draggable: Draggable) => Number)} [containerFriction]+ * @property {Number|((draggable: Draggable) => Number)} [releaseContainerFriction]+ * @property {Number|((draggable: Draggable) => Number)} [dragSpeed]+ * @property {Number|((draggable: Draggable) => Number)} [scrollSpeed]+ * @property {Number|((draggable: Draggable) => Number)} [scrollThreshold]+ * @property {Number|((draggable: Draggable) => Number)} [minVelocity]+ * @property {Number|((draggable: Draggable) => Number)} [maxVelocity]+ * @property {Number|((draggable: Draggable) => Number)} [velocityMultiplier]+ * @property {Number} [releaseMass]+ * @property {Number} [releaseStiffness]+ * @property {Number} [releaseDamping]+ * @property {Boolean} [releaseDamping]+ * @property {EasingParam} [releaseEase]+ * @property {Boolean|DraggableCursorParams|((draggable: Draggable) => Boolean|DraggableCursorParams)} [cursor]+ * @property {Callback<Draggable>} [onGrab]+ * @property {Callback<Draggable>} [onDrag]+ * @property {Callback<Draggable>} [onRelease]+ * @property {Callback<Draggable>} [onUpdate]+ * @property {Callback<Draggable>} [onSettle]+ * @property {Callback<Draggable>} [onSnap]+ * @property {Callback<Draggable>} [onResize]+ * @property {Callback<Draggable>} [onAfterResize]+ */++/**+ * @typedef {SVGGeometryElement & {+ * setAttribute(name: 'draw', value: `${number} ${number}`): void;+ * draw: `${number} ${number}`;+ * }} DrawableSVGGeometry+ */+/*** @callback EasingFunction* @param {Number} time@@ -1521,13 +1573,6 @@ const getScaleFactor = $el => {return scaleFactor;};-/**- * @typedef {SVGGeometryElement & {- * setAttribute(name: 'draw', value: `${number} ${number}`): void;- * draw: `${number} ${number}`;- * }} DrawableSVGGeometry- */-/*** Creates a proxy that wraps an SVGGeometryElement and adds drawing functionality.* @param {SVGGeometryElement} $el - The SVG element to transform into a drawable@@ -5319,12 +5364,6 @@ class Transforms {}}-/**- * @typedef {Object} DraggableCursorParams- * @property {String} [onHover]- * @property {String} [onGrab]- */-/*** @template {Array<Number>|DOMTargetSelector|String|Number|Boolean|Function|DraggableCursorParams} T* @param {T | ((draggable: Draggable) => T)} value@@ -5335,47 +5374,6 @@ const parseDraggableFunctionParameter = (value, draggable) => value && isFnc(vallet zIndex = 0;-/**- * @typedef {Object} DraggableAxisParam- * @property {String} [mapTo]- * @property {TweenModifier} [modifier]- * @property {TweenComposition} [composition]- * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [snap]- */--/**- * @typedef {Object} DraggableParams- * @property {DOMTargetSelector} [trigger]- * @property {DOMTargetSelector|Array<Number>|((draggable: Draggable) => DOMTargetSelector|Array<Number>)} [container]- * @property {Boolean|DraggableAxisParam} [x]- * @property {Boolean|DraggableAxisParam} [y]- * @property {TweenModifier} [modifier]- * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [snap]- * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [containerPadding]- * @property {Number|((draggable: Draggable) => Number)} [containerFriction]- * @property {Number|((draggable: Draggable) => Number)} [releaseContainerFriction]- * @property {Number|((draggable: Draggable) => Number)} [dragSpeed]- * @property {Number|((draggable: Draggable) => Number)} [scrollSpeed]- * @property {Number|((draggable: Draggable) => Number)} [scrollThreshold]- * @property {Number|((draggable: Draggable) => Number)} [minVelocity]- * @property {Number|((draggable: Draggable) => Number)} [maxVelocity]- * @property {Number|((draggable: Draggable) => Number)} [velocityMultiplier]- * @property {Number} [releaseMass]- * @property {Number} [releaseStiffness]- * @property {Number} [releaseDamping]- * @property {Boolean} [releaseDamping]- * @property {EasingParam} [releaseEase]- * @property {Boolean|DraggableCursorParams|((draggable: Draggable) => Boolean|DraggableCursorParams)} [cursor]- * @property {Callback<Draggable>} [onGrab]- * @property {Callback<Draggable>} [onDrag]- * @property {Callback<Draggable>} [onRelease]- * @property {Callback<Draggable>} [onUpdate]- * @property {Callback<Draggable>} [onSettle]- * @property {Callback<Draggable>} [onSnap]- * @property {Callback<Draggable>} [onResize]- * @property {Callback<Draggable>} [onAfterResize]- */-class Draggable {/*** @param {TargetsParam} targetdiff --git a/src/draggable.js b/src/draggable.jsindex 91f22c09..872d26cb 100644--- a/src/draggable.js+++ b/src/draggable.js@@ -177,12 +177,6 @@ class Transforms {}}-/**- * @typedef {Object} DraggableCursorParams- * @property {String} [onHover]- * @property {String} [onGrab]- */-/*** @template {Array<Number>|DOMTargetSelector|String|Number|Boolean|Function|DraggableCursorParams} T* @param {T | ((draggable: Draggable) => T)} value@@ -193,47 +187,6 @@ const parseDraggableFunctionParameter = (value, draggable) => value && isFnc(vallet zIndex = 0;-/**- * @typedef {Object} DraggableAxisParam- * @property {String} [mapTo]- * @property {TweenModifier} [modifier]- * @property {TweenComposition} [composition]- * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [snap]- */--/**- * @typedef {Object} DraggableParams- * @property {DOMTargetSelector} [trigger]- * @property {DOMTargetSelector|Array<Number>|((draggable: Draggable) => DOMTargetSelector|Array<Number>)} [container]- * @property {Boolean|DraggableAxisParam} [x]- * @property {Boolean|DraggableAxisParam} [y]- * @property {TweenModifier} [modifier]- * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [snap]- * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [containerPadding]- * @property {Number|((draggable: Draggable) => Number)} [containerFriction]- * @property {Number|((draggable: Draggable) => Number)} [releaseContainerFriction]- * @property {Number|((draggable: Draggable) => Number)} [dragSpeed]- * @property {Number|((draggable: Draggable) => Number)} [scrollSpeed]- * @property {Number|((draggable: Draggable) => Number)} [scrollThreshold]- * @property {Number|((draggable: Draggable) => Number)} [minVelocity]- * @property {Number|((draggable: Draggable) => Number)} [maxVelocity]- * @property {Number|((draggable: Draggable) => Number)} [velocityMultiplier]- * @property {Number} [releaseMass]- * @property {Number} [releaseStiffness]- * @property {Number} [releaseDamping]- * @property {Boolean} [releaseDamping]- * @property {EasingParam} [releaseEase]- * @property {Boolean|DraggableCursorParams|((draggable: Draggable) => Boolean|DraggableCursorParams)} [cursor]- * @property {Callback<Draggable>} [onGrab]- * @property {Callback<Draggable>} [onDrag]- * @property {Callback<Draggable>} [onRelease]- * @property {Callback<Draggable>} [onUpdate]- * @property {Callback<Draggable>} [onSettle]- * @property {Callback<Draggable>} [onSnap]- * @property {Callback<Draggable>} [onResize]- * @property {Callback<Draggable>} [onAfterResize]- */-export class Draggable {/*** @param {TargetsParam} targetdiff --git a/src/svg.js b/src/svg.jsindex 8fe1628f..273d9e1f 100644--- a/src/svg.js+++ b/src/svg.js@@ -85,13 +85,6 @@ const getScaleFactor = $el => {return scaleFactor;}-/**- * @typedef {SVGGeometryElement & {- * setAttribute(name: 'draw', value: `${number} ${number}`): void;- * draw: `${number} ${number}`;- * }} DrawableSVGGeometry- */-/*** Creates a proxy that wraps an SVGGeometryElement and adds drawing functionality.* @param {SVGGeometryElement} $el - The SVG element to transform into a drawablediff --git a/src/types.js b/src/types.jsindex 8fb82ee1..b5f2e441 100644--- a/src/types.js+++ b/src/types.js@@ -15,18 +15,18 @@/*** @typedef {Object} DefaultsParams- * @property {number|string} [id]+ * @property {Number|String} [id]* @property {PercentageKeyframes|DurationKeyframes} [keyframes]* @property {EasingParam} [playbackEase]- * @property {number} [playbackRate]- * @property {number} [frameRate]- * @property {number|boolean} [loop]- * @property {boolean} [reversed]- * @property {boolean} [alternate]- * @property {boolean|ScrollObserver} [autoplay]- * @property {number|FunctionValue} [duration]- * @property {number|FunctionValue} [delay]- * @property {number} [loopDelay]+ * @property {Number} [playbackRate]+ * @property {Number} [frameRate]+ * @property {Number|Boolean} [loop]+ * @property {Boolean} [reversed]+ * @property {Boolean} [alternate]+ * @property {Boolean|ScrollObserver} [autoplay]+ * @property {Number|FunctionValue} [duration]+ * @property {Number|FunctionValue} [delay]+ * @property {Number} [loopDelay]* @property {EasingParam} [ease]* @property {'none'|'replace'|'blend'|import('./consts.js').compositionTypes} [composition]* @property {(v: any) => any} [modifier]@@ -42,10 +42,62 @@/** @typedef {JSAnimation|Timeline} Renderable *//** @typedef {Timer|Renderable} Tickable *//** @typedef {Timer&JSAnimation&Timeline} CallbackArgument */-/** @typedef {import('./draggable.js').DraggableParams} DraggableParams */-/** @typedef {import('./svg.js').DrawableSVGGeometry} DrawableSVGGeometry *//** @typedef {import('./animatable.js').Animatable|Tickable|Draggable|ScrollObserver|Scope} Revertible */+/**+ * @typedef {Object} DraggableAxisParam+ * @property {String} [mapTo]+ * @property {TweenModifier} [modifier]+ * @property {TweenComposition} [composition]+ * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [snap]+ */++/**+ * @typedef {Object} DraggableCursorParams+ * @property {String} [onHover]+ * @property {String} [onGrab]+ */++/**+ * @typedef {Object} DraggableParams+ * @property {DOMTargetSelector} [trigger]+ * @property {DOMTargetSelector|Array<Number>|((draggable: Draggable) => DOMTargetSelector|Array<Number>)} [container]+ * @property {Boolean|DraggableAxisParam} [x]+ * @property {Boolean|DraggableAxisParam} [y]+ * @property {TweenModifier} [modifier]+ * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [snap]+ * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [containerPadding]+ * @property {Number|((draggable: Draggable) => Number)} [containerFriction]+ * @property {Number|((draggable: Draggable) => Number)} [releaseContainerFriction]+ * @property {Number|((draggable: Draggable) => Number)} [dragSpeed]+ * @property {Number|((draggable: Draggable) => Number)} [scrollSpeed]+ * @property {Number|((draggable: Draggable) => Number)} [scrollThreshold]+ * @property {Number|((draggable: Draggable) => Number)} [minVelocity]+ * @property {Number|((draggable: Draggable) => Number)} [maxVelocity]+ * @property {Number|((draggable: Draggable) => Number)} [velocityMultiplier]+ * @property {Number} [releaseMass]+ * @property {Number} [releaseStiffness]+ * @property {Number} [releaseDamping]+ * @property {Boolean} [releaseDamping]+ * @property {EasingParam} [releaseEase]+ * @property {Boolean|DraggableCursorParams|((draggable: Draggable) => Boolean|DraggableCursorParams)} [cursor]+ * @property {Callback<Draggable>} [onGrab]+ * @property {Callback<Draggable>} [onDrag]+ * @property {Callback<Draggable>} [onRelease]+ * @property {Callback<Draggable>} [onUpdate]+ * @property {Callback<Draggable>} [onSettle]+ * @property {Callback<Draggable>} [onSnap]+ * @property {Callback<Draggable>} [onResize]+ * @property {Callback<Draggable>} [onAfterResize]+ */++/**+ * @typedef {SVGGeometryElement & {+ * setAttribute(name: 'draw', value: `${number} ${number}`): void;+ * draw: `${number} ${number}`;+ * }} DrawableSVGGeometry+ */+/*** @callback EasingFunction* @param {Number} timediff --git a/types/index.d.ts b/types/index.d.tsindex 397cb529..fc0fad24 100644--- a/types/index.d.ts+++ b/types/index.d.ts@@ -206,10 +206,6 @@ declare namespace svg {export { createMotionPath };export { createDrawable };}-type DrawableSVGGeometry = SVGGeometryElement & {- setAttribute(name: "draw", value: `${number} ${number}`): void;- draw: `${number} ${number}`;-};declare function morphTo(path2: TargetsParam, precision?: number): FunctionValue;declare function createMotionPath(path: TargetsParam): {translateX: FunctionValue;@@ -334,6 +330,224 @@ type DefaultsParams = {type Renderable = JSAnimation | Timeline;type Tickable = Timer | Renderable;type CallbackArgument = Timer & JSAnimation & Timeline;+declare class Animatable {+ constructor(targets: TargetsParam, parameters: AnimatableParams);+ targets: (HTMLElement | SVGElement | JSTarget)[];+ animations: {};+ revert(): this;+}+declare function createAnimatable(targets: TargetsParam, parameters: AnimatableParams): AnimatableObject;+type Revertible = Animatable | Tickable | Draggable | ScrollObserver | Scope;+type DraggableAxisParam = {+ mapTo?: string;+ modifier?: TweenModifier;+ composition?: TweenComposition;+ snap?: number | number[] | ((draggable: Draggable) => number | Array<number>);+};+type DraggableCursorParams = {+ onHover?: string;+ onGrab?: string;+};+type DraggableParams = {+ trigger?: DOMTargetSelector;+ container?: number[] | DOMTargetSelector | ((draggable: Draggable) => DOMTargetSelector | Array<number>);+ x?: boolean | DraggableAxisParam;+ y?: boolean | DraggableAxisParam;+ modifier?: TweenModifier;+ snap?: number | number[] | ((draggable: Draggable) => number | Array<number>);+ containerPadding?: number | number[] | ((draggable: Draggable) => number | Array<number>);+ containerFriction?: number | ((draggable: Draggable) => number);+ releaseContainerFriction?: number | ((draggable: Draggable) => number);+ dragSpeed?: number | ((draggable: Draggable) => number);+ scrollSpeed?: number | ((draggable: Draggable) => number);+ scrollThreshold?: number | ((draggable: Draggable) => number);+ minVelocity?: number | ((draggable: Draggable) => number);+ maxVelocity?: number | ((draggable: Draggable) => number);+ velocityMultiplier?: number | ((draggable: Draggable) => number);+ releaseMass?: number;+ releaseStiffness?: number;+ releaseDamping?: number;+ releaseEase?: EasingParam;+ cursor?: boolean | DraggableCursorParams | ((draggable: Draggable) => boolean | DraggableCursorParams);+ onGrab?: Callback<Draggable>;+ onDrag?: Callback<Draggable>;+ onRelease?: Callback<Draggable>;+ onUpdate?: Callback<Draggable>;+ onSettle?: Callback<Draggable>;+ onSnap?: Callback<Draggable>;+ onResize?: Callback<Draggable>;+ onAfterResize?: Callback<Draggable>;+};+type DrawableSVGGeometry = SVGGeometryElement & {+ setAttribute(name: 'draw', value: `${number} ${number}`): void;+ draw: `${number} ${number}`;+};+type EasingFunction = (time: number) => number;+type EaseStringParamNames = ('linear' | 'linear(x1, x2 25%, x3)' | 'in' | 'out' | 'inOut' | 'inQuad' | 'outQuad' | 'inOutQuad' | 'inCubic' | 'outCubic' | 'inOutCubic' | 'inQuart' | 'outQuart' | 'inOutQuart' | 'inQuint' | 'outQuint' | 'inOutQuint' | 'inSine' | 'outSine' | 'inOutSine' | 'inCirc' | 'outCirc' | 'inOutCirc' | 'inExpo' | 'outExpo' | 'inOutExpo' | 'inBounce' | 'outBounce' | 'inOutBounce' | 'inBack' | 'outBack' | 'inOutBack' | 'inElastic' | 'outElastic' | 'inOutElastic' | 'irregular' | 'cubicBezier' | 'steps' | 'in(p = 1.675)' | 'out(p = 1.675)' | 'inOut(p = 1.675)' | 'inBack(overshoot = 1.70158)' | 'outBack(overshoot = 1.70158)' | 'inOutBack(overshoot = 1.70158)' | 'inElastic(amplitude = 1, period = .3)' | 'outElastic(amplitude = 1, period = .3)' | 'inOutElastic(amplitude = 1, period = .3)' | 'irregular(length = 10, randomness = 1)' | 'cubicBezier(x1, y1, x2, y2)' | 'steps(steps = 10)');+type EasingParam = (string & {}) | EaseStringParamNames | EasingFunction | Spring;+type DOMTarget = HTMLElement | SVGElement;+type JSTarget = Record<string, any>;+type Target = DOMTarget | JSTarget;+type TargetSelector = Target | NodeList | string;+type DOMTargetSelector = DOMTarget | NodeList | string;+type DOMTargetsParam = Array<DOMTargetSelector> | DOMTargetSelector;+type DOMTargetsArray = Array<DOMTarget>;+type JSTargetsParam = Array<JSTarget> | JSTarget;+type JSTargetsArray = Array<JSTarget>;+type TargetsParam = Array<TargetSelector> | TargetSelector;+type TargetsArray = Array<Target>;+type FunctionValue = (target: Target, index: number, length: number) => number | string | TweenObjectValue | Array<number | string | TweenObjectValue>;+type TweenModifier = (value: number) => number | string;+type ColorArray = [number, number, number, number];+type Callback<T> = (self: T, e?: PointerEvent) => any;+type TickableCallbacks<T extends unknown> = {+ onBegin?: Callback<T>;+ onBeforeUpdate?: Callback<T>;+ onUpdate?: Callback<T>;+ onLoop?: Callback<T>;+ onPause?: Callback<T>;+ onComplete?: Callback<T>;+};+type RenderableCallbacks<T extends unknown> = {+ onRender?: Callback<T>;+};+type Tween = {+ id: number;+ parent: JSAnimation;+ property: string;+ target: Target;+ _value: string | number;+ _func: Function | null;+ _ease: EasingFunction;+ _fromNumbers: Array<number>;+ _toNumbers: Array<number>;+ _strings: Array<string>;+ _fromNumber: number;+ _toNumber: number;+ _numbers: Array<number>;+ _number: number;+ _unit: string;+ _modifier: TweenModifier;+ _currentTime: number;+ _delay: number;+ _updateDuration: number;+ _startTime: number;+ _changeDuration: number;+ _absoluteStartTime: number;+ _tweenType: tweenTypes;+ _valueType: valueTypes;+ _composition: number;+ _isOverlapped: number;+ _isOverridden: number;+ _renderTransforms: number;+ _prevRep: Tween;+ _nextRep: Tween;+ _prevAdd: Tween;+ _nextAdd: Tween;+ _prev: Tween;+ _next: Tween;+};+type TweenDecomposedValue = {+ /**+ * - Type+ */+ t: number;+ /**+ * - Single number value+ */+ n: number;+ /**+ * - Value unit+ */+ u: string;+ /**+ * - Value operator+ */+ o: string;+ /**+ * - Array of Numbers (in case of complex value type)+ */+ d: Array<number>;+ /**+ * - Strings (in case of complex value type)+ */+ s: Array<string>;+};+type TweenPropertySiblings = {+ _head: null | Tween;+ _tail: null | Tween;+};+type TweenLookups = Record<string, TweenPropertySiblings>;+type TweenReplaceLookups = WeakMap<Target, TweenLookups>;+type TweenAdditiveLookups = Map<Target, TweenLookups>;+type TimerOptions = {+ id?: number | string;+ duration?: TweenParamValue;+ delay?: TweenParamValue;+ loopDelay?: number;+ reversed?: boolean;+ alternate?: boolean;+ loop?: boolean | number;+ autoplay?: boolean | ScrollObserver;+ frameRate?: number;+ playbackRate?: number;+};+/**+ *+ * /**+ */+type TimerParams = TimerOptions & TickableCallbacks<Timer>;+type TweenParamValue = number | string | FunctionValue;+type TweenPropValue = TweenParamValue | [TweenParamValue, TweenParamValue];+type TweenComposition = (string & {}) | 'none' | 'replace' | 'blend' | compositionTypes;+type TweenParamsOptions = {+ duration?: TweenParamValue;+ delay?: TweenParamValue;+ ease?: EasingParam;+ modifier?: TweenModifier;+ composition?: TweenComposition;+};+type TweenValues = {+ from?: TweenParamValue;+ to?: TweenPropValue;+ fromTo?: TweenPropValue;+};+type TweenKeyValue = TweenParamsOptions & TweenValues;+type ArraySyntaxValue = Array<TweenKeyValue | TweenPropValue>;+type TweenOptions = TweenParamValue | (TweenPropValue | TweenKeyValue)[] | TweenKeyValue;+type TweenObjectValue = Partial<{+ to: TweenParamValue | Array<TweenParamValue>;+ from: TweenParamValue | Array<TweenParamValue>;+ fromTo: TweenParamValue | Array<TweenParamValue>;+}>;+type PercentageKeyframeOptions = {+ ease?: EasingParam;+};+type PercentageKeyframeParams = Record<string, TweenParamValue>;+type PercentageKeyframes = Record<string, PercentageKeyframeParams & PercentageKeyframeOptions>;+type DurationKeyframes = Array<Record<string, TweenOptions | TweenModifier | boolean> & TweenParamsOptions>;+type AnimationOptions = {+ keyframes?: PercentageKeyframes | DurationKeyframes;+ playbackEase?: EasingParam;+};+type AnimationParams = Record<string, TweenOptions | Callback<JSAnimation> | TweenModifier | boolean | PercentageKeyframes | (Record<string, boolean | TweenModifier | TweenOptions> & TweenParamsOptions)[] | ScrollObserver> & TimerOptions & AnimationOptions & TweenParamsOptions & TickableCallbacks<JSAnimation> & RenderableCallbacks<JSAnimation>;+type TimelineOptions = {+ defaults?: DefaultsParams;+ playbackEase?: EasingParam;+};+type TimelineParams = TimerOptions & TimelineOptions & TickableCallbacks<Timeline> & RenderableCallbacks<Timeline>;+type AnimatablePropertySetter = (to: number | Array<number>, duration?: number, ease?: EasingParam) => AnimatableObject;+type AnimatablePropertyGetter = () => number | Array<number>;+type AnimatableProperty = AnimatablePropertySetter & AnimatablePropertyGetter;+type AnimatableObject = Animatable & Record<string, AnimatableProperty>;+type AnimatablePropertyParamsOptions = {+ unit?: string;+ duration?: TweenParamValue;+ ease?: EasingParam;+ modifier?: TweenModifier;+ composition?: TweenComposition;+};+type AnimatableParams = Record<string, TweenParamValue | EasingParam | TweenModifier | TweenComposition | AnimatablePropertyParamsOptions> & AnimatablePropertyParamsOptions;declare class Draggable {constructor(target: TargetsParam, parameters?: DraggableParams);containerArray: number[];@@ -505,46 +719,6 @@ declare class Draggable {handleEvent(e: Event): void;}declare function createDraggable(target: TargetsParam, parameters?: DraggableParams): Draggable;-type DraggableCursorParams = {- onHover?: string;- onGrab?: string;-};-type DraggableAxisParam = {- mapTo?: string;- modifier?: TweenModifier;- composition?: TweenComposition;- snap?: number | number[] | ((draggable: Draggable) => number | Array<number>);-};-type DraggableParams = {- trigger?: DOMTargetSelector;- container?: number[] | DOMTargetSelector | ((draggable: Draggable) => DOMTargetSelector | Array<number>);- x?: boolean | DraggableAxisParam;- y?: boolean | DraggableAxisParam;- modifier?: TweenModifier;- snap?: number | number[] | ((draggable: Draggable) => number | Array<number>);- containerPadding?: number | number[] | ((draggable: Draggable) => number | Array<number>);- containerFriction?: number | ((draggable: Draggable) => number);- releaseContainerFriction?: number | ((draggable: Draggable) => number);- dragSpeed?: number | ((draggable: Draggable) => number);- scrollSpeed?: number | ((draggable: Draggable) => number);- scrollThreshold?: number | ((draggable: Draggable) => number);- minVelocity?: number | ((draggable: Draggable) => number);- maxVelocity?: number | ((draggable: Draggable) => number);- velocityMultiplier?: number | ((draggable: Draggable) => number);- releaseMass?: number;- releaseStiffness?: number;- releaseDamping?: number;- releaseEase?: EasingParam;- cursor?: boolean | DraggableCursorParams | ((draggable: Draggable) => boolean | DraggableCursorParams);- onGrab?: Callback<Draggable>;- onDrag?: Callback<Draggable>;- onRelease?: Callback<Draggable>;- onUpdate?: Callback<Draggable>;- onSettle?: Callback<Draggable>;- onSnap?: Callback<Draggable>;- onResize?: Callback<Draggable>;- onAfterResize?: Callback<Draggable>;-};declare class Transforms {constructor($el: DOMTarget | DOMProxy);$el: DOMTarget | DOMProxy;@@ -581,182 +755,6 @@ declare class DOMProxy {left: any;};}-type DraggableParams = DraggableParams;-type DrawableSVGGeometry = DrawableSVGGeometry;-declare class Animatable {- constructor(targets: TargetsParam, parameters: AnimatableParams);- targets: (HTMLElement | SVGElement | JSTarget)[];- animations: {};- revert(): this;-}-declare function createAnimatable(targets: TargetsParam, parameters: AnimatableParams): AnimatableObject;-type Revertible = Animatable | Tickable | Draggable | ScrollObserver | Scope;-type EasingFunction = (time: number) => number;-type EaseStringParamNames = ('linear' | 'linear(x1, x2 25%, x3)' | 'in' | 'out' | 'inOut' | 'inQuad' | 'outQuad' | 'inOutQuad' | 'inCubic' | 'outCubic' | 'inOutCubic' | 'inQuart' | 'outQuart' | 'inOutQuart' | 'inQuint' | 'outQuint' | 'inOutQuint' | 'inSine' | 'outSine' | 'inOutSine' | 'inCirc' | 'outCirc' | 'inOutCirc' | 'inExpo' | 'outExpo' | 'inOutExpo' | 'inBounce' | 'outBounce' | 'inOutBounce' | 'inBack' | 'outBack' | 'inOutBack' | 'inElastic' | 'outElastic' | 'inOutElastic' | 'irregular' | 'cubicBezier' | 'steps' | 'in(p = 1.675)' | 'out(p = 1.675)' | 'inOut(p = 1.675)' | 'inBack(overshoot = 1.70158)' | 'outBack(overshoot = 1.70158)' | 'inOutBack(overshoot = 1.70158)' | 'inElastic(amplitude = 1, period = .3)' | 'outElastic(amplitude = 1, period = .3)' | 'inOutElastic(amplitude = 1, period = .3)' | 'irregular(length = 10, randomness = 1)' | 'cubicBezier(x1, y1, x2, y2)' | 'steps(steps = 10)');-type EasingParam = (string & {}) | EaseStringParamNames | EasingFunction | Spring;-type DOMTarget = HTMLElement | SVGElement;-type JSTarget = Record<string, any>;-type Target = DOMTarget | JSTarget;-type TargetSelector = Target | NodeList | string;-type DOMTargetSelector = DOMTarget | NodeList | string;-type DOMTargetsParam = Array<DOMTargetSelector> | DOMTargetSelector;-type DOMTargetsArray = Array<DOMTarget>;-type JSTargetsParam = Array<JSTarget> | JSTarget;-type JSTargetsArray = Array<JSTarget>;-type TargetsParam = Array<TargetSelector> | TargetSelector;-type TargetsArray = Array<Target>;-type FunctionValue = (target: Target, index: number, length: number) => number | string | TweenObjectValue | Array<number | string | TweenObjectValue>;-type TweenModifier = (value: number) => number | string;-type ColorArray = [number, number, number, number];-type Callback<T> = (self: T, e?: PointerEvent) => any;-type TickableCallbacks<T extends unknown> = {- onBegin?: Callback<T>;- onBeforeUpdate?: Callback<T>;- onUpdate?: Callback<T>;- onLoop?: Callback<T>;- onPause?: Callback<T>;- onComplete?: Callback<T>;-};-type RenderableCallbacks<T extends unknown> = {- onRender?: Callback<T>;-};-type Tween = {- id: number;- parent: JSAnimation;- property: string;- target: Target;- _value: string | number;- _func: Function | null;- _ease: EasingFunction;- _fromNumbers: Array<number>;- _toNumbers: Array<number>;- _strings: Array<string>;- _fromNumber: number;- _toNumber: number;- _numbers: Array<number>;- _number: number;- _unit: string;- _modifier: TweenModifier;- _currentTime: number;- _delay: number;- _updateDuration: number;- _startTime: number;- _changeDuration: number;- _absoluteStartTime: number;- _tweenType: tweenTypes;- _valueType: valueTypes;- _composition: number;- _isOverlapped: number;- _isOverridden: number;- _renderTransforms: number;- _prevRep: Tween;- _nextRep: Tween;- _prevAdd: Tween;- _nextAdd: Tween;- _prev: Tween;- _next: Tween;-};-type TweenDecomposedValue = {- /**- * - Type- */- t: number;- /**- * - Single number value- */- n: number;- /**- * - Value unit- */- u: string;- /**- * - Value operator- */- o: string;- /**- * - Array of Numbers (in case of complex value type)- */- d: Array<number>;- /**- * - Strings (in case of complex value type)- */- s: Array<string>;-};-type TweenPropertySiblings = {- _head: null | Tween;- _tail: null | Tween;-};-type TweenLookups = Record<string, TweenPropertySiblings>;-type TweenReplaceLookups = WeakMap<Target, TweenLookups>;-type TweenAdditiveLookups = Map<Target, TweenLookups>;-type TimerOptions = {- id?: number | string;- duration?: TweenParamValue;- delay?: TweenParamValue;- loopDelay?: number;- reversed?: boolean;- alternate?: boolean;- loop?: boolean | number;- autoplay?: boolean | ScrollObserver;- frameRate?: number;- playbackRate?: number;-};-/**- *- * /**- */-type TimerParams = TimerOptions & TickableCallbacks<Timer>;-type TweenParamValue = number | string | FunctionValue;-type TweenPropValue = TweenParamValue | [TweenParamValue, TweenParamValue];-type TweenComposition = (string & {}) | 'none' | 'replace' | 'blend' | compositionTypes;-type TweenParamsOptions = {- duration?: TweenParamValue;- delay?: TweenParamValue;- ease?: EasingParam;- modifier?: TweenModifier;- composition?: TweenComposition;-};-type TweenValues = {- from?: TweenParamValue;- to?: TweenPropValue;- fromTo?: TweenPropValue;-};-type TweenKeyValue = TweenParamsOptions & TweenValues;-type ArraySyntaxValue = Array<TweenKeyValue | TweenPropValue>;-type TweenOptions = TweenParamValue | (TweenPropValue | TweenKeyValue)[] | TweenKeyValue;-type TweenObjectValue = Partial<{- to: TweenParamValue | Array<TweenParamValue>;- from: TweenParamValue | Array<TweenParamValue>;- fromTo: TweenParamValue | Array<TweenParamValue>;-}>;-type PercentageKeyframeOptions = {- ease?: EasingParam;-};-type PercentageKeyframeParams = Record<string, TweenParamValue>;-type PercentageKeyframes = Record<string, PercentageKeyframeParams & PercentageKeyframeOptions>;-type DurationKeyframes = Array<Record<string, TweenOptions | TweenModifier | boolean> & TweenParamsOptions>;-type AnimationOptions = {- keyframes?: PercentageKeyframes | DurationKeyframes;- playbackEase?: EasingParam;-};-type AnimationParams = Record<string, TweenOptions | Callback<JSAnimation> | TweenModifier | boolean | PercentageKeyframes | (Record<string, boolean | TweenModifier | TweenOptions> & TweenParamsOptions)[] | ScrollObserver> & TimerOptions & AnimationOptions & TweenParamsOptions & TickableCallbacks<JSAnimation> & RenderableCallbacks<JSAnimation>;-type TimelineOptions = {- defaults?: DefaultsParams;- playbackEase?: EasingParam;-};-type TimelineParams = TimerOptions & TimelineOptions & TickableCallbacks<Timeline> & RenderableCallbacks<Timeline>;-type AnimatablePropertySetter = (to: number | Array<number>, duration?: number, ease?: EasingParam) => AnimatableObject;-type AnimatablePropertyGetter = () => number | Array<number>;-type AnimatableProperty = AnimatablePropertySetter & AnimatablePropertyGetter;-type AnimatableObject = Animatable & Record<string, AnimatableProperty>;-type AnimatablePropertyParamsOptions = {- unit?: string;- duration?: TweenParamValue;- ease?: EasingParam;- modifier?: TweenModifier;- composition?: TweenComposition;-};-type AnimatableParams = Record<string, TweenParamValue | EasingParam | TweenModifier | TweenComposition | AnimatablePropertyParamsOptions> & AnimatablePropertyParamsOptions;declare class Scope {constructor(parameters?: ScopeParams);defaults: DefaultsParams;@@ -1022,4 +1020,4 @@ type WAAPIAnimationOptions = {};type WAAPIAnimationParams = Record<string, WAAPIKeyframeValue | WAAPIAnimationOptions | boolean | ScrollObserver | WAAPICallback | EasingParam | WAAPITweenOptions> & WAAPIAnimationOptions;declare function easingToLinear(fn: EasingFunction, samples?: number): string;-export { engine, utils, svg, stagger, eases, DefaultsParams, Renderable, Tickable, CallbackArgument, DraggableParams, DrawableSVGGeometry, Revertible, EasingFunction, EaseStringParamNames, EasingParam, DOMTarget, JSTarget, Target, TargetSelector, DOMTargetSelector, DOMTargetsParam, DOMTargetsArray, JSTargetsParam, JSTargetsArray, TargetsParam, TargetsArray, FunctionValue, TweenModifier, ColorArray, Callback, TickableCallbacks, RenderableCallbacks, Tween, TweenDecomposedValue, TweenPropertySiblings, TweenLookups, TweenReplaceLookups, TweenAdditiveLookups, TimerOptions, TimerParams, TweenParamValue, TweenPropValue, TweenComposition, TweenParamsOptions, TweenValues, TweenKeyValue, ArraySyntaxValue, TweenOptions, TweenObjectValue, PercentageKeyframeOptions, PercentageKeyframeParams, PercentageKeyframes, DurationKeyframes, AnimationOptions, AnimationParams, TimelineOptions, TimelineParams, AnimatablePropertySetter, AnimatablePropertyGetter, AnimatableProperty, AnimatableObject, AnimatablePropertyParamsOptions, AnimatableParams, createTimer, Timer, animate, JSAnimation, createTimeline, Timeline, createAnimatable, Animatable, createDraggable, Draggable, createScope, Scope, onScroll, ScrollObserver, scrollContainers, createSpring, Spring, waapi, WAAPIAnimation };+export { engine, utils, svg, stagger, eases, DefaultsParams, Renderable, Tickable, CallbackArgument, Revertible, DraggableAxisParam, DraggableCursorParams, DraggableParams, DrawableSVGGeometry, EasingFunction, EaseStringParamNames, EasingParam, DOMTarget, JSTarget, Target, TargetSelector, DOMTargetSelector, DOMTargetsParam, DOMTargetsArray, JSTargetsParam, JSTargetsArray, TargetsParam, TargetsArray, FunctionValue, TweenModifier, ColorArray, Callback, TickableCallbacks, RenderableCallbacks, Tween, TweenDecomposedValue, TweenPropertySiblings, TweenLookups, TweenReplaceLookups, TweenAdditiveLookups, TimerOptions, TimerParams, TweenParamValue, TweenPropValue, TweenComposition, TweenParamsOptions, TweenValues, TweenKeyValue, ArraySyntaxValue, TweenOptions, TweenObjectValue, PercentageKeyframeOptions, PercentageKeyframeParams, PercentageKeyframes, DurationKeyframes, AnimationOptions, AnimationParams, TimelineOptions, TimelineParams, AnimatablePropertySetter, AnimatablePropertyGetter, AnimatableProperty, AnimatableObject, AnimatablePropertyParamsOptions, AnimatableParams, createTimer, Timer, animate, JSAnimation, createTimeline, Timeline, createAnimatable, Animatable, createDraggable, Draggable, createScope, Scope, onScroll, ScrollObserver, scrollContainers, createSpring, Spring, waapi, WAAPIAnimation };diff --git a/types/index.js b/types/index.jsindex c49efeef..64d8d92d 100644--- a/types/index.js+++ b/types/index.js@@ -1127,12 +1127,6 @@ const getScaleFactor = $el => {}return scaleFactor;};-/**- * @typedef {SVGGeometryElement & {- * setAttribute(name: 'draw', value: `${number} ${number}`): void;- * draw: `${number} ${number}`;- * }} DrawableSVGGeometry- *//*** Creates a proxy that wraps an SVGGeometryElement and adds drawing functionality.* @param {SVGGeometryElement} $el - The SVG element to transform into a drawable@@ -4655,11 +4649,6 @@ class Transforms {});}}-/**- * @typedef {Object} DraggableCursorParams- * @property {String} [onHover]- * @property {String} [onGrab]- *//*** @template {Array<Number>|DOMTargetSelector|String|Number|Boolean|Function|DraggableCursorParams} T* @param {T | ((draggable: Draggable) => T)} value@@ -4668,45 +4657,6 @@ class Transforms {*/const parseDraggableFunctionParameter = (value, draggable) => value && isFnc(value) ? /** @type {Function} */ (value)(draggable) : value;let zIndex = 0;-/**- * @typedef {Object} DraggableAxisParam- * @property {String} [mapTo]- * @property {TweenModifier} [modifier]- * @property {TweenComposition} [composition]- * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [snap]- */-/**- * @typedef {Object} DraggableParams- * @property {DOMTargetSelector} [trigger]- * @property {DOMTargetSelector|Array<Number>|((draggable: Draggable) => DOMTargetSelector|Array<Number>)} [container]- * @property {Boolean|DraggableAxisParam} [x]- * @property {Boolean|DraggableAxisParam} [y]- * @property {TweenModifier} [modifier]- * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [snap]- * @property {Number|Array<Number>|((draggable: Draggable) => Number|Array<Number>)} [containerPadding]- * @property {Number|((draggable: Draggable) => Number)} [containerFriction]- * @property {Number|((draggable: Draggable) => Number)} [releaseContainerFriction]- * @property {Number|((draggable: Draggable) => Number)} [dragSpeed]- * @property {Number|((draggable: Draggable) => Number)} [scrollSpeed]- * @property {Number|((draggable: Draggable) => Number)} [scrollThreshold]- * @property {Number|((draggable: Draggable) => Number)} [minVelocity]- * @property {Number|((draggable: Draggable) => Number)} [maxVelocity]- * @property {Number|((draggable: Draggable) => Number)} [velocityMultiplier]- * @property {Number} [releaseMass]- * @property {Number} [releaseStiffness]- * @property {Number} [releaseDamping]- * @property {Boolean} [releaseDamping]- * @property {EasingParam} [releaseEase]- * @property {Boolean|DraggableCursorParams|((draggable: Draggable) => Boolean|DraggableCursorParams)} [cursor]- * @property {Callback<Draggable>} [onGrab]- * @property {Callback<Draggable>} [onDrag]- * @property {Callback<Draggable>} [onRelease]- * @property {Callback<Draggable>} [onUpdate]- * @property {Callback<Draggable>} [onSettle]- * @property {Callback<Draggable>} [onSnap]- * @property {Callback<Draggable>} [onResize]- * @property {Callback<Draggable>} [onAfterResize]- */class Draggable {/*** @param {TargetsParam} target