Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ComponentOptionsBase<Props, RawBindings, D, C, M, Mixin, Extends, E, EE, Defaults>

Type parameters

Hierarchy

  • LegacyOptions<Props, D, C, M, Mixin, Extends>
  • ComponentInternalOptions
  • ComponentCustomOptions
    • ComponentOptionsBase

Index

Properties

Methods

Properties

Optional __defaults

__defaults?: Defaults

Optional __differentiator

__differentiator?: keyof D | keyof C | keyof M

#3468

type-only, used to assist Mixin's type inference, typescript will try to simplify the inferred Mixin type, with the __differenciator, typescript won't be able to combine different mixins, because the __differenciator will be different

Optional __file

__file?: string

This one should be exposed so that devtools can make use of it

Optional __isBuiltIn

__isBuiltIn?: boolean

Compat build only, for bailing out of certain compatibility behavior

Optional __isFragment

__isFragment?: undefined

Optional __isSuspense

__isSuspense?: undefined

Optional __isTeleport

__isTeleport?: undefined

Optional beforeRouteEnter

beforeRouteEnter?: NavigationGuardWithThis<undefined>

Guard called when the router is navigating to the route that is rendering this component from a different route. Differently from beforeRouteUpdate and beforeRouteLeave, beforeRouteEnter does not have access to the component instance through this because it triggers before the component is even mounted.

param to

RouteLocationRaw we are navigating to

param from

RouteLocationRaw we are navigating from

param next

function to validate, cancel or modify (by redirecting) the navigation

Optional beforeRouteLeave

beforeRouteLeave?: NavigationGuard

Guard called when the router is navigating away from the current route that is rendering this component.

param to

RouteLocationRaw we are navigating to

param from

RouteLocationRaw we are navigating from

param next

function to validate, cancel or modify (by redirecting) the navigation

Optional beforeRouteUpdate

beforeRouteUpdate?: NavigationGuard

Guard called whenever the route that renders this component has changed but it is reused for the new route. This allows you to guard for changes in params, the query or the hash.

param to

RouteLocationRaw we are navigating to

param from

RouteLocationRaw we are navigating from

param next

function to validate, cancel or modify (by redirecting) the navigation

Optional compatConfig

compatConfig?: CompatConfig

Optional compilerOptions

compilerOptions?: RuntimeCompilerOptions

Optional components

components?: Record<string, Component<any, any, any, ComputedOptions, MethodOptions>>

Optional computed

computed?: C

Optional delimiters

delimiters?: [string, string]

runtime compile only

deprecated

use compilerOptions.delimiters instead.

Optional directives

directives?: Record<string, vue.Directive<any, any>>

Optional emits

emits?: (E & ThisType<void>) & (EE[] & ThisType<void>)

Optional errorCaptured

errorCaptured?: ErrorCapturedHook<unknown>

Optional expose

expose?: string[]

Optional extends

extends?: Extends

Optional filters

filters?: Record<string, Function>

Optional inheritAttrs

inheritAttrs?: boolean

Optional inject

inject?: ComponentInjectOptions

Optional methods

methods?: M

Optional mixins

mixins?: Mixin[]

Optional name

name?: string

Optional provide

provide?: Function | Data

Optional render

render?: Function

Optional renderTracked

renderTracked?: DebuggerHook

Optional renderTriggered

renderTriggered?: DebuggerHook

Optional template

template?: string | object

Optional watch

watch?: ComponentWatchOptions

Methods

Optional activated

  • activated(): void

  • Returns void

Optional beforeCreate

  • beforeCreate(): void

  • Returns void

Optional beforeDestroy

  • beforeDestroy(): void
  • deprecated

    use beforeUnmount instead

    Returns void

Optional beforeMount

  • beforeMount(): void

  • Returns void

Optional beforeUnmount

  • beforeUnmount(): void

  • Returns void

Optional beforeUpdate

  • beforeUpdate(): void

  • Returns void

Optional call

  • call(...args: unknown[]): never

  • Parameters

    • Rest ...args: unknown[]

    Returns never

Optional created

  • created(): void

  • Returns void

Optional data

  • data(vm: CreateComponentPublicInstance<Props, {}, {}, {}, MethodOptions, Mixin, Extends, {}, Props, {}, false, IntersectionMixin<Mixin> & IntersectionMixin<Extends>, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "P"> & EnsureNonVoid<Props>, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "B"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "D"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "C"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "M"> & MethodOptions, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "Defaults"> & {}>): D

  • Parameters

    • vm: CreateComponentPublicInstance<Props, {}, {}, {}, MethodOptions, Mixin, Extends, {}, Props, {}, false, IntersectionMixin<Mixin> & IntersectionMixin<Extends>, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "P"> & EnsureNonVoid<Props>, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "B"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "D"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "C"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "M"> & MethodOptions, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "Defaults"> & {}>

    Returns D

Optional deactivated

  • deactivated(): void

  • Returns void

Optional destroyed

  • destroyed(): void
  • deprecated

    use unmounted instead

    Returns void

Optional mounted

  • mounted(): void

  • Returns void

Optional serverPrefetch

  • serverPrefetch(): Promise<any>

  • Returns Promise<any>

Optional setup

  • setup(props: Readonly<LooseRequired<Props & UnionToIntersection<ExtractOptionProp<Mixin>> & UnionToIntersection<ExtractOptionProp<Extends>>>>, ctx: SetupContext<E>): void | RawBindings | RenderFunction | Promise<RawBindings>

  • Parameters

    • props: Readonly<LooseRequired<Props & UnionToIntersection<ExtractOptionProp<Mixin>> & UnionToIntersection<ExtractOptionProp<Extends>>>>
    • ctx: SetupContext<E>

    Returns void | RawBindings | RenderFunction | Promise<RawBindings>

Optional unmounted

  • unmounted(): void

  • Returns void

Optional updated

  • updated(): void

  • Returns void

Generated using TypeDoc