Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAbstractRegistrableComponent

The AbstractRegistrableComponent is the core component of the vue-transition-component. It's used for registering components and making sure all the children are done before we start creating timelines. Nested registrable components will let their parent know that they are ready.

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

Vue

Vue: VueConstructor

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

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
  • When all the transition components within this component are loaded this method will be triggered. This is usually the point where the transition controller is setup.

    Returns void

isReady

  • isReady(): void

setRegistrableComponents

  • setRegistrableComponents(): void

updateRegistrableComponents

  • Method that watches for async component changes, this means it will create a new promise that will be resolved when the "new" children are ready

    Parameters

    • callback: function

      The method that will be called so you can release the update method

        • (resolve: function): void
        • Parameters

          • resolve: function
              • (): void
              • Returns void

          Returns void

    Returns Promise<Array<IAbstractRegistrableComponent>>

    An array containing the newly registered components

Generated using TypeDoc