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

Interface for declaring custom options.

Example

declare module 'vue' {
  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, LC, Directives, Exposed, Provide> {
    __defaults?: Defaults;
    __differentiator?: keyof D | keyof C | keyof M;
    __file?: string;
    __isBuiltIn?: boolean;
    __isFragment?: undefined;
    __isSuspense?: undefined;
    __isTeleport?: undefined;
    __name?: string;
    call?: ((this: unknown, ...args: unknown[]) => never);
    compatConfig?: CompatConfig;
    compilerOptions?: RuntimeCompilerOptions;
    components?: LC & Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>>;
    computed?: C;
    data?: ((this: CreateComponentPublicInstanceWithMixins<Props, {}, {}, {}, MethodOptions, Mixin, Extends, {}, Props, {}, false, {}, {}, {}, {}, string, {}, any, ComponentProvideOptions, 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"> & {}>, vm: CreateComponentPublicInstanceWithMixins<Props, {}, {}, {}, MethodOptions, Mixin, Extends, {}, Props, {}, false, {}, {}, {}, {}, string, {}, any, ComponentProvideOptions, 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);
    delimiters?: [string, string];
    directives?: Directives & Record<string, vue.Directive<any, any, string, string>>;
    emits?: (E | EE[]) & ThisType<void>;
    errorCaptured?: ErrorCapturedHook<unknown>;
    expose?: Exposed[];
    extends?: Extends;
    filters?: Record<string, Function>;
    inheritAttrs?: boolean;
    inject?: I | II[];
    methods?: M;
    mixins?: Mixin[];
    name?: string;
    provide?: Provide;
    render?: Function;
    renderTracked?: DebuggerHook;
    renderTriggered?: DebuggerHook;
    setup?: ((this: void, props: LooseRequired<Props & {
        [K in string | number | symbol]: UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "P">[K]
    }>, ctx: SetupContext<E, S>) =>
        | 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? 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?: undefined

Optional__isSuspense

__isSuspense?: undefined

Optional__isTeleport

__isTeleport?: undefined

Optional__name

__name?: string

name inferred from filename

Optionalcall

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

OptionalcompatConfig

compatConfig?: CompatConfig

OptionalcompilerOptions

compilerOptions?: RuntimeCompilerOptions

Optionalcomponents

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

Optionalcomputed

computed?: C

Optionaldata

data?: ((this: CreateComponentPublicInstanceWithMixins<Props, {}, {}, {}, MethodOptions, Mixin, Extends, {}, Props, {}, false, {}, {}, {}, {}, string, {}, any, ComponentProvideOptions, 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"> & {}>, vm: CreateComponentPublicInstanceWithMixins<Props, {}, {}, {}, MethodOptions, Mixin, Extends, {}, Props, {}, false, {}, {}, {}, {}, string, {}, any, ComponentProvideOptions, 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)

Optionaldelimiters

delimiters?: [string, string]

runtime compile only

Deprecated

use compilerOptions.delimiters instead.

Optionaldirectives

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

Optionalemits

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

OptionalerrorCaptured

errorCaptured?: ErrorCapturedHook<unknown>

Optionalexpose

expose?: Exposed[]

Optionalextends

extends?: Extends

Optionalfilters

filters?: Record<string, Function>

OptionalinheritAttrs

inheritAttrs?: boolean

Optionalinject

inject?: I | II[]

Optionalmethods

methods?: M

Optionalmixins

mixins?: Mixin[]

Optionalname

name?: string

Optionalprovide

provide?: Provide

Optionalrender

render?: Function

OptionalrenderTracked

renderTracked?: DebuggerHook

OptionalrenderTriggered

renderTriggered?: DebuggerHook

Optionalsetup

setup?: ((this: void, props: LooseRequired<Props & {
    [K in string | number | symbol]: UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "P">[K]
}>, ctx: SetupContext<E, S>) =>
    | void
    | RawBindings
    | RenderFunction
    | Promise<RawBindings>)

Optionalslots

slots?: S

Optionaltemplate

template?: string | object

Optionalwatch

watch?: ComponentWatchOptions

Methods

Optionalactivated

  • activated(): void

  • Returns void

OptionalbeforeCreate

  • beforeCreate(): void

  • Returns void

OptionalbeforeDestroy

  • beforeDestroy(): void

  • Returns void

    Deprecated

    use beforeUnmount instead

OptionalbeforeMount

  • beforeMount(): void

  • Returns void

OptionalbeforeUnmount

  • beforeUnmount(): void

  • Returns void

OptionalbeforeUpdate

  • beforeUpdate(): void

  • Returns void

Optionalcreated

  • created(): void

  • Returns void

Optionaldeactivated

  • deactivated(): void

  • Returns void

Optionaldestroyed

  • destroyed(): void

  • Returns void

    Deprecated

    use unmounted instead

Optionalmounted

  • mounted(): void

  • Returns void

OptionalserverPrefetch

  • serverPrefetch(): void | Promise<any>

  • Returns void | Promise<any>

Optionalunmounted

  • unmounted(): void

  • Returns void

Optionalupdated

  • updated(): void

  • Returns void

Settings

Member Visibility

On This Page

Properties
Methods