Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAbstractTransitionComponent

The AbstractTransitionComponent is the base of all transitioning Vue.js components. It contains the transition controller and will add the required transition methods to your component.

Hierarchy

Index

Properties

$attrs

$attrs: Record<string, string>

$children

$children: Vue[]

$createElement

$createElement: CreateElement

$data

$data: Record<string, any>

$delete

$delete: delete

$el

$el: HTMLElement

$isServer

$isServer: boolean

$listeners

$listeners: Record<string, Function | Function[]>

$options

$options: ComponentOptions<Vue>

$parent

$parent: Vue

$props

$props: Record<string, any>

$refs

$refs: object

Type declaration

  • [key: string]: Vue | Element | Vue[] | Element[]

$root

$root: Vue

$scopedSlots

$scopedSlots: object

Type declaration

  • [key: string]: ScopedSlot

$set

$set: set

$slots

$slots: object

Type declaration

  • [key: string]: VNode[]

$ssrContext

$ssrContext: any

$vnode

$vnode: VNode

allComponentsReady

allComponentsReady: Promise<Array<IAbstractRegistrableComponent>>

The promise that is used to figure out if all components are ready

componentId

componentId: string

The internal id of the component is automatically generated or linked to the ref that is set in the parent component.

isRegistrable

isRegistrable: boolean

Flag used to determine if a component is registrable

newRegisteredComponents

newRegisteredComponents: Array<IAbstractRegistrableComponent>

Array of new components that are registered

registeredComponents

registeredComponents: Array<IAbstractRegistrableComponent>

Array containing all the registered components

registrableComponents

registrableComponents: Array<IAbstractRegistrableComponent>

Array of all components that are registrable

transitionController

transitionController: AbstractVueTransitionController

This is the instance of the transition controller that contains your timelines.

Methods

$destroy

  • $destroy(): void
  • Returns void

$emit

  • $emit(event: string, ...args: any[]): this
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns this

$forceUpdate

  • $forceUpdate(): void
  • Returns void

$mount

  • $mount(elementOrSelector?: Element | string, hydrating?: boolean): this
  • Parameters

    • Optional elementOrSelector: Element | string
    • Optional hydrating: boolean

    Returns this

$nextTick

  • $nextTick(callback: function): void
  • $nextTick(): Promise<void>
  • Parameters

    • callback: function
        • (this: this): void
        • Parameters

          • this: this

          Returns void

    Returns void

  • Returns Promise<void>

$off

  • $off(event?: string | string[], callback?: Function): this
  • Parameters

    • Optional event: string | string[]
    • Optional callback: Function

    Returns this

$on

  • $on(event: string | string[], callback: Function): this
  • Parameters

    • event: string | string[]
    • callback: Function

    Returns this

$once

  • $once(event: string, callback: Function): this
  • Parameters

    • event: string
    • callback: Function

    Returns this

$watch

  • $watch(expOrFn: string, callback: function, options?: WatchOptions): function
  • $watch<T>(expOrFn: function, callback: function, options?: WatchOptions): function
  • Parameters

    • expOrFn: string
    • callback: function
        • (this: this, n: any, o: any): void
        • Parameters

          • this: this
          • n: any
          • o: any

          Returns void

    • Optional options: WatchOptions

    Returns function

      • (): void
      • Returns void

  • Type parameters

    • T

    Parameters

    • expOrFn: function
        • (this: this): T
        • Parameters

          • this: this

          Returns T

    • callback: function
        • (this: this, n: T, o: T): void
        • Parameters

          • this: this
          • n: T
          • o: T

          Returns void

    • Optional options: WatchOptions

    Returns function

      • (): void
      • Returns void

checkComponentsReady

  • checkComponentsReady(): void

componentReady

handleAllComponentsReady

  • handleAllComponentsReady(): void

isReady

  • isReady(): void

setRegistrableComponents

  • setRegistrableComponents(): void

startLoopingAnimation

  • startLoopingAnimation(id?: string, reset?: boolean): void
  • Start the looping animations on the current component

    Parameters

    • Optional id: string

      This is the id of the transition out timeline that you want to play

    • Optional reset: boolean

      If the reset flag is set to true it will re-initialize the current timeline

    Returns void

stopLoopingAnimation

  • stopLoopingAnimation(): void

transitionIn

  • transitionIn(forceTransition?: boolean): Promise<void>
  • Calling transition in will trigger transitionIn on your transition controller and start the desired timeline.

    Parameters

    • Optional forceTransition: boolean

      Add this flag if you want to overwrite any active transitions

    Returns Promise<void>

    A promise that will be resolved when the transition in is completed

transitionOut

  • transitionOut(forceTransition?: boolean, id?: string, reset?: boolean): Promise<void>
  • Calling transition out will trigger transitionOut on your transition controller and start the desired timeline.

    method

    transitionOut

    Parameters

    • Optional forceTransition: boolean

      Add this flag if you want to overwrite any active transitions

    • Optional id: string

      This is the id of the transition out timeline that you want to play

    • Optional reset: boolean

      If the reset flag is set to true it will re-initialize the current timeline

    Returns Promise<void>

    A promise that will be resolved when the transition out is completed

updateRegistrableComponents

Generated using TypeDoc