@yesstudio/nuxt-composables
    Preparing search index...

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

    interface ComponentOptionsBase<
        Props,
        RawBindings,
        D,
        C extends ComputedOptions,
        M extends MethodOptions,
        Mixin extends ComponentOptionsMixin,
        Extends extends ComponentOptionsMixin,
        E extends EmitsOptions,
        EE extends string = string,
        Defaults = {},
        I extends ComponentInjectOptions = {},
        II extends string = string,
        S extends SlotsType = {},
        LC extends Record<string, Component> = {},
        Directives extends Record<string, Directive> = {},
        Exposed extends string = string,
        Provide extends ComponentProvideOptions = ComponentProvideOptions,
    > {
        __defaults?: Defaults;
        __differentiator?: keyof D | keyof C | keyof M;
        __file?: string;
        __isBuiltIn?: boolean;
        __isFragment?: undefined;
        __isSuspense?: undefined;
        __isTeleport?: undefined;
        __name?: string;
        beforeRouteEnter?: NavigationGuardWithThis<undefined>;
        beforeRouteLeave?: NavigationGuard;
        beforeRouteUpdate?: NavigationGuard;
        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,
            >,
            vm: CreateComponentPublicInstanceWithMixins<
                Props,
                {},
                {},
                {},
                MethodOptions,
                Mixin,
                Extends,
            >,
        ) => D;
        delimiters?: [string, string];
        directives?: Directives & Record<string, Directive<any, any, string, any>>;
        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 & Prettify<
                    UnwrapMixinsType<
                        IntersectionMixin<Mixin> & IntersectionMixin<Extends>,
                        "P",
                    >,
                >,
            >,
            ctx: SetupContext<E, S>,
        ) => void | RawBindings | RenderFunction | Promise<RawBindings>;
        slots?: S;
        template?: string | object;
        watch?: ComponentWatchOptions;
        activated?(): any;
        beforeCreate?(): any;
        beforeDestroy?(): any;
        beforeMount?(): any;
        beforeUnmount?(): any;
        beforeUpdate?(): any;
        created?(): any;
        deactivated?(): any;
        destroyed?(): any;
        head?(nuxtApp: NuxtApp): UseHeadInput;
        mounted?(): any;
        serverPrefetch?(): void | Promise<any>;
        unmounted?(): any;
        updated?(): any;
        [key: string]: any;
    }

    Type Parameters

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    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? head? 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

    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.

    RouteLocationRaw we are navigating to

    RouteLocationRaw we are navigating from

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

    beforeRouteLeave?: NavigationGuard

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

    RouteLocationRaw we are navigating to

    RouteLocationRaw we are navigating from

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

    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.

    RouteLocationRaw we are navigating to

    RouteLocationRaw we are navigating from

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

    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,
        >,
        vm: CreateComponentPublicInstanceWithMixins<
            Props,
            {},
            {},
            {},
            MethodOptions,
            Mixin,
            Extends,
        >,
    ) => D
    delimiters?: [string, string]

    runtime compile only

    use compilerOptions.delimiters instead.

    directives?: Directives & Record<string, Directive<any, any, string, any>>
    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 & Prettify<
                UnwrapMixinsType<
                    IntersectionMixin<Mixin> & IntersectionMixin<Extends>,
                    "P",
                >,
            >,
        >,
        ctx: SetupContext<E, S>,
    ) => void | RawBindings | RenderFunction | Promise<RawBindings>
    slots?: S
    template?: string | object
    watch?: ComponentWatchOptions

    Methods

    • Returns any

    • Returns any

    • Returns any

      use beforeUnmount instead

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

      use unmounted instead

    • Available exclusively for defineNuxtComponent. It will not be executed when using defineComponent.

      Parameters

      • nuxtApp: NuxtApp

      Returns UseHeadInput

    • Returns any

    • Returns void | Promise<any>

    • Returns any

    • Returns any

    Settings

    Member Visibility

    On This Page

    Properties
    Methods