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

Interface for declaring custom options.

Example

declare module '@vue/runtime-core' {
  interface ComponentCustomOptions {
    beforeRouteUpdate?(
      to: Route,
      from: Route,
      next: () => void
    ): void
  }
}
interface ComponentOptionsBase<Props, RawBindings, D, C, M, Mixin, Extends, E, EE, Defaults, I, II, S> {
    __defaults?: Defaults;
    __differentiator?: keyof D | keyof C | keyof M;
    __file?: string;
    __isBuiltIn?: boolean;
    __isFragment?: never;
    __isSuspense?: never;
    __isTeleport?: never;
    __name?: string;
    beforeRouteEnter?: NavigationGuardWithThis<undefined>;
    beforeRouteLeave?: NavigationGuard;
    beforeRouteUpdate?: NavigationGuard;
    call?: ((this, ...args) => never);
    compatConfig?: CompatConfig;
    compilerOptions?: RuntimeCompilerOptions;
    components?: Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>>;
    computed?: C;
    data?: ((this, vm) => D);
    delimiters?: [string, string];
    directives?: Record<string, Directive<any, any>>;
    emits?: (E | EE[]) & ThisType<void>;
    errorCaptured?: ErrorCapturedHook<unknown>;
    expose?: string[];
    extends?: Extends;
    filters?: Record<string, Function>;
    inheritAttrs?: boolean;
    inject?: I | II[];
    methods?: M;
    mixins?: Mixin[];
    name?: string;
    provide?: ComponentProvideOptions;
    render?: Function;
    renderTracked?: DebuggerHook;
    renderTriggered?: DebuggerHook;
    setup?: ((this, props, ctx) => void | RawBindings | RenderFunction | Promise<RawBindings>);
    slots?: S;
    template?: string | object;
    watch?: ComponentWatchOptions;
    activated?(): void;
    beforeCreate?(): void;
    beforeDestroy?(): void;
    beforeMount?(): void;
    beforeUnmount?(): void;
    beforeUpdate?(): void;
    created?(): void;
    deactivated?(): void;
    destroyed?(): void;
    mounted?(): void;
    serverPrefetch?(): void | Promise<any>;
    unmounted?(): void;
    updated?(): void;
}

Type Parameters

Hierarchy (view full)

Properties

__defaults? __differentiator? __file? __isBuiltIn? __isFragment? __isSuspense? __isTeleport? __name? beforeRouteEnter? beforeRouteLeave? beforeRouteUpdate? call? compatConfig? compilerOptions? components? computed? data? delimiters? directives? emits? errorCaptured? expose? extends? filters? inheritAttrs? inject? methods? mixins? name? provide? render? renderTracked? renderTriggered? setup? slots? template? watch?

Methods

activated? beforeCreate? beforeDestroy? beforeMount? beforeUnmount? beforeUpdate? created? deactivated? destroyed? mounted? serverPrefetch? unmounted? updated?

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 __differentiator, typescript won't be able to combine different mixins, because the __differentiator 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?: never

Optional __isSuspense

__isSuspense?: never

Optional __isTeleport

__isTeleport?: never

Optional __name

__name?: string

name inferred from filename

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 call

call?: ((this, ...args) => never)

Type declaration

    • (this, ...args): never

    • Parameters

      • this: unknown
      • Rest ...args: unknown[]

      Returns never

Optional compatConfig

compatConfig?: CompatConfig

Optional compilerOptions

compilerOptions?: RuntimeCompilerOptions

Optional components

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

Optional computed

computed?: C

Optional data

data?: ((this, vm) => D)

Type declaration

Optional delimiters

delimiters?: [string, string]

runtime compile only

Deprecated

use compilerOptions.delimiters instead.

Optional directives

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

Optional emits

emits?: (E | 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?: I | II[]

Optional methods

methods?: M

Optional mixins

mixins?: Mixin[]

Optional name

name?: string

Optional provide

provide?: ComponentProvideOptions

Optional render

render?: Function

Optional renderTracked

renderTracked?: DebuggerHook

Optional renderTriggered

renderTriggered?: DebuggerHook

Optional setup

setup?: ((this, props, ctx) => void | RawBindings | RenderFunction | Promise<RawBindings>)

Type declaration

Optional slots

slots?: S

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

  • Returns void

    Deprecated

    use beforeUnmount instead

Optional beforeMount

  • beforeMount(): void

  • Returns void

Optional beforeUnmount

  • beforeUnmount(): void

  • Returns void

Optional beforeUpdate

  • beforeUpdate(): void

  • Returns void

Optional created

  • created(): void

  • Returns void

Optional deactivated

  • deactivated(): void

  • Returns void

Optional destroyed

  • destroyed(): void

  • Returns void

    Deprecated

    use unmounted instead

Optional mounted

  • mounted(): void

  • Returns void

Optional serverPrefetch

  • serverPrefetch(): void | Promise<any>

  • Returns void | Promise<any>

Optional unmounted

  • unmounted(): void

  • Returns void

Optional updated

  • updated(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc