Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAbstractRegistrableComponent

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<this>

$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<void>
property

allComponentsReady

description

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.

allComponentsReadyResolveMethod

allComponentsReadyResolveMethod: function
property

allComponentsReadyResolveMethod

description

All components ready resolve method

Type declaration

    • (): void
    • Returns void

componentId

componentId: string
property

componentId

description

The unique id of the rendered component, this is used for fetching the reference if the same components appears multiple times

componentType

componentType: ComponentType
property

componentType

description

The type of the component

components

property

components

description

All components inside this component

registeredComponents

registeredComponents: Array<string>
property

registeredComponents

description

Array of registered components

Methods

Private $_checkComponentsReady

  • $_checkComponentsReady(): void

$_componentReady

Private $_updateRegistrableComponents

  • $_updateRegistrableComponents(): void

$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

getChild

handleAllComponentsReady

  • handleAllComponentsReady(): void

hasChild

  • hasChild(componentId: string, componentType?: ComponentType): boolean
  • method

    hasChild

    description

    Check to see if a component with a certain Id exists

    Parameters

    • componentId: string

      The id of the desired child component

    • Optional componentType: ComponentType

      The type of the desired component

    Returns boolean

    a boolean to check if a child exists

isReady

  • isReady(): void
  • method

    isReady

    description

    The isReady method should be called when the component is fully ready, this is usually when it's children are ready but it could require more async data

    Returns void

updateRegistrableComponents

Generated using TypeDoc