Interface BgaAttachWithAnimationSettings

Hierarchy

Properties

afterAttach? animation animationClass? animationEnd? animationStart? attachElement duration? element finalTransform? game? rotationDelta? scale? transitionTimingFunction? zIndex?

Properties

Optional afterAttach

afterAttach?: ((element, attachElement) => void)

Type declaration

    • (element, attachElement): void

    • A function called after attaching the element.

      Parameters

      • element: HTMLElement
      • attachElement: HTMLElement

      Returns void

animation

animation: BgaAnimation<BgaAnimationWithOriginSettings>

Optional animationClass

animationClass?: string

The class to add to the animated element.

Optional animationEnd

animationEnd?: ((animation) => any)

Type declaration

Optional animationStart

animationStart?: ((animation) => any)

Type declaration

    • (animation): any

    • A function called when animation starts (for example to add a zoom effect on a card during a reveal animation).

      Parameters

      Returns any

attachElement

attachElement: HTMLElement

The target to attach the element to.

Optional duration

duration?: number

The animation duration, in ms (default: 500).

element

element: HTMLElement

The element to animate.

Optional finalTransform

finalTransform?: string

The transform property to set after the animation.

Optional game

game?: Game

The game class. Used to know if the game is in instantaneous mode (replay) becausewe don't want animations in this case.

Optional rotationDelta

rotationDelta?: number

If the card is rotated at the start of animation.

Optional scale

scale?: number

The cumulated scale of the element to animate (default: 1).

Optional transitionTimingFunction

transitionTimingFunction?: string

The animation CSS timing function, 'linear', 'ease-in-out' (default: linear).

Optional zIndex

zIndex?: number

The zIndex to apply during animation (default: 10).

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc