animejs 4.2.2 → 4.3.0-beta.1

package/dist/modules/layout/layout.d.ts

@@ -0,0 +1,211 @@
+export class AutoLayout {
+    /**
+     * @param {DOMTargetSelector} root
+     * @param {AutoLayoutParams} [params]
+     */
+    constructor(root: DOMTargetSelector, params?: AutoLayoutParams);
+    /** @type {AutoLayoutParams} */
+    params: AutoLayoutParams;
+    /** @type {DOMTarget} */
+    root: DOMTarget;
+    /** @type {Number} */
+    id: number;
+    /** @type {LayoutChildrenParam} */
+    children: LayoutChildrenParam;
+    /** @type {Boolean} */
+    absoluteCoords: boolean;
+    /** @type {Number|FunctionValue} */
+    duration: number | FunctionValue;
+    /** @type {Number|FunctionValue} */
+    delay: number | FunctionValue;
+    /** @type {EasingParam} */
+    ease: EasingParam;
+    /** @type {Callback<this>} */
+    onComplete: Callback<this>;
+    /** @type {LayoutStateParams} */
+    frozenParams: LayoutStateParams;
+    /** @type {LayoutStateParams} */
+    addedParams: LayoutStateParams;
+    /** @type {LayoutStateParams} */
+    removedParams: LayoutStateParams;
+    /** @type {Set<String>} */
+    properties: Set<string>;
+    /** @type {Set<String>} */
+    recordedProperties: Set<string>;
+    /** @type {WeakSet<DOMTarget>} */
+    pendingRemoved: WeakSet<DOMTarget>;
+    /** @type {Map<DOMTarget, String|null>} */
+    transitionMuteStore: Map<DOMTarget, string | null>;
+    /** @type {LayoutSnapshot} */
+    oldState: LayoutSnapshot;
+    /** @type {LayoutSnapshot} */
+    newState: LayoutSnapshot;
+    /** @type {Timeline|null} */
+    timeline: Timeline | null;
+    /** @type {WAAPIAnimation|null} */
+    transformAnimation: WAAPIAnimation | null;
+    /** @type {Array<DOMTarget>} */
+    frozen: Array<DOMTarget>;
+    /** @type {Array<DOMTarget>} */
+    removed: Array<DOMTarget>;
+    /** @type {Array<DOMTarget>} */
+    added: Array<DOMTarget>;
+    /**
+     * @return {this}
+     */
+    revert(): this;
+    /**
+     * @return {this}
+     */
+    record(): this;
+    /**
+     * @param {LayoutAnimationParams} [params]
+     * @return {Timeline}
+     */
+    animate(params?: LayoutAnimationParams): Timeline;
+    /**
+     * @param {(layout: this) => void} callback
+     * @param {LayoutAnimationParams} [params]
+     * @return {this}
+     */
+    update(callback: (layout: this) => void, params?: LayoutAnimationParams): this;
+}
+export function createLayout(root: DOMTargetSelector, params?: AutoLayoutParams): AutoLayout;
+export type LayoutChildrenParam = DOMTargetSelector | Array<DOMTargetSelector>;
+export type LayoutStateParams = Record<string, number | string>;
+export type LayoutAnimationParams = {
+    delay?: number | FunctionValue;
+    duration?: number | FunctionValue;
+    ease?: EasingParam;
+    frozen?: LayoutStateParams;
+    added?: LayoutStateParams;
+    removed?: LayoutStateParams;
+    onComplete?: Callback<AutoLayout>;
+};
+export type AutoLayoutParams = LayoutAnimationParams & {
+    children?: LayoutChildrenParam;
+    properties?: Array<string>;
+};
+export type LayoutNodeProperties = Record<string, number | string> & {
+    transform: string;
+    x: number;
+    y: number;
+    left: number;
+    top: number;
+    clientLeft: number;
+    clientTop: number;
+    width: number;
+    height: number;
+};
+export type LayoutNode = {
+    id: string;
+    $el: DOMTarget;
+    index: number;
+    total: number;
+    delay: number;
+    duration: number;
+    $measure: DOMTarget;
+    state: LayoutSnapshot;
+    layout: AutoLayout;
+    parentNode: LayoutNode | null;
+    isTarget: boolean;
+    hasTransform: boolean;
+    isAnimated: boolean;
+    inlineStyles: Array<string>;
+    inlineTransforms: string | null;
+    inlineTransition: string | null;
+    branchAdded: boolean;
+    branchRemoved: boolean;
+    branchNotRendered: boolean;
+    sizeChanged: boolean;
+    isInlined: boolean;
+    hasVisibilitySwap: boolean;
+    hasDisplayNone: boolean;
+    hasVisibilityHidden: boolean;
+    measuredInlineTransform: string | null;
+    measuredInlineTransition: string | null;
+    measuredDisplay: string | null;
+    measuredVisibility: string | null;
+    measuredPosition: string | null;
+    measuredHasDisplayNone: boolean;
+    measuredHasVisibilityHidden: boolean;
+    measuredIsVisible: boolean;
+    measuredIsRemoved: boolean;
+    measuredIsInsideRoot: boolean;
+    properties: LayoutNodeProperties;
+    _head: LayoutNode | null;
+    _tail: LayoutNode | null;
+    _prev: LayoutNode | null;
+    _next: LayoutNode | null;
+};
+export type LayoutNodeIterator = (node: LayoutNode, index: number) => void;
+import type { DOMTarget } from '../types/index.js';
+import type { FunctionValue } from '../types/index.js';
+import type { EasingParam } from '../types/index.js';
+import type { Callback } from '../types/index.js';
+declare class LayoutSnapshot {
+    /**
+     * @param {AutoLayout} layout
+     */
+    constructor(layout: AutoLayout);
+    /** @type {AutoLayout} */
+    layout: AutoLayout;
+    /** @type {LayoutNode|null} */
+    rootNode: LayoutNode | null;
+    /** @type {Set<LayoutNode>} */
+    rootNodes: Set<LayoutNode>;
+    /** @type {Map<String, LayoutNode>} */
+    nodes: Map<string, LayoutNode>;
+    /** @type {Number} */
+    scrollX: number;
+    /** @type {Number} */
+    scrollY: number;
+    /**
+     * @return {this}
+     */
+    revert(): this;
+    /**
+     * @param {DOMTarget} $el
+     * @return {LayoutNodeProperties|undefined}
+     */
+    get($el: DOMTarget): LayoutNodeProperties | undefined;
+    /**
+     * @param {DOMTarget} $el
+     * @param {String} prop
+     * @return {Number|String|undefined}
+     */
+    getValue($el: DOMTarget, prop: string): number | string | undefined;
+    /**
+     * @param {LayoutNode|null} rootNode
+     * @param {LayoutNodeIterator} cb
+     */
+    forEach(rootNode: LayoutNode | null, cb: LayoutNodeIterator): void;
+    /**
+     * @param {LayoutNodeIterator} cb
+     */
+    forEachRootNode(cb: LayoutNodeIterator): void;
+    /**
+     * @param {LayoutNodeIterator} cb
+     */
+    forEachNode(cb: LayoutNodeIterator): void;
+    /**
+     * @param {DOMTarget} $el
+     * @param {LayoutNode|null} parentNode
+     * @return {LayoutNode|null}
+     */
+    registerElement($el: DOMTarget, parentNode: LayoutNode | null): LayoutNode | null;
+    /**
+     * @param {DOMTarget} $el
+     * @param {Set<DOMTarget>} candidates
+     * @return {LayoutNode|null}
+     */
+    ensureDetachedNode($el: DOMTarget, candidates: Set<DOMTarget>): LayoutNode | null;
+    /**
+     * @return {this}
+     */
+    record(): this;
+}
+import type { Timeline } from '../timeline/timeline.js';
+import type { WAAPIAnimation } from '../waapi/waapi.js';
+import type { DOMTargetSelector } from '../types/index.js';
+export {};