Interface AnimationControls

interface AnimationControls {
    mount(): (() => void);
    set(definition): void;
    start(definition, transitionOverride?): Promise<any>;
    stop(): void;
}

Methods

mount set start stop

Methods

mount

  • mount(): (() => void)

  • Returns (() => void)

      • (): void

      • Returns void

set

  • set(definition): void

  • Instantly set to a set of properties or a variant.

    // With properties
    controls.set({ opacity: 0 })

    // With variants
    controls.set("hidden")

    Parameters

    Returns void

start

  • start(definition, transitionOverride?): Promise<any>

  • Starts an animation on all linked components.

    Parameters

    • definition: AnimationDefinition

      Properties or variant label to animate to

    • Optional transitionOverride: Transition

    Returns Promise<any>

    • A Promise that resolves when all animations have completed.

    Remarks

    controls.start("variantLabel")
    controls.start({
      x: 0,
      transition: { duration: 1 }
    })

stop

  • stop(): void

  • Stops animations on all linked components.

    controls.stop()

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc