123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410 |
- import { camelize } from '@vue/shared';
- import { capitalize } from '@vue/shared';
- import { ComputedGetter } from '@vue/reactivity';
- import { ComputedRef } from '@vue/reactivity';
- import { customRef } from '@vue/reactivity';
- import { DebuggerEvent } from '@vue/reactivity';
- import { DeepReadonly } from '@vue/reactivity';
- import { isProxy } from '@vue/reactivity';
- import { isReactive } from '@vue/reactivity';
- import { isReadonly } from '@vue/reactivity';
- import { isRef } from '@vue/reactivity';
- import { markRaw } from '@vue/reactivity';
- import { proxyRefs } from '@vue/reactivity';
- import { reactive } from '@vue/reactivity';
- import { ReactiveEffect } from '@vue/reactivity';
- import { ReactiveEffectOptions } from '@vue/reactivity';
- import { ReactiveFlags } from '@vue/reactivity';
- import { readonly } from '@vue/reactivity';
- import { Ref } from '@vue/reactivity';
- import { ref } from '@vue/reactivity';
- import { shallowReactive } from '@vue/reactivity';
- import { shallowReadonly } from '@vue/reactivity';
- import { shallowRef } from '@vue/reactivity';
- import { ShallowUnwrapRef } from '@vue/reactivity';
- import { SlotFlags } from '@vue/shared';
- import { toDisplayString } from '@vue/shared';
- import { toHandlerKey } from '@vue/shared';
- import { toRaw } from '@vue/reactivity';
- import { toRef } from '@vue/reactivity';
- import { ToRefs } from '@vue/reactivity';
- import { toRefs } from '@vue/reactivity';
- import { TrackOpTypes } from '@vue/reactivity';
- import { TriggerOpTypes } from '@vue/reactivity';
- import { triggerRef } from '@vue/reactivity';
- import { unref } from '@vue/reactivity';
- import { UnwrapRef } from '@vue/reactivity';
- import { WritableComputedOptions } from '@vue/reactivity';
- import { WritableComputedRef } from '@vue/reactivity';
- /**
- * Default allowed non-declared props on component in TSX
- */
- export declare interface AllowedComponentProps {
- class?: unknown;
- style?: unknown;
- }
- export declare interface App<HostElement = any> {
- version: string;
- config: AppConfig;
- use(plugin: Plugin_2, ...options: any[]): this;
- mixin(mixin: ComponentOptions): this;
- component(name: string): Component | undefined;
- component(name: string, component: Component): this;
- directive(name: string): Directive | undefined;
- directive(name: string, directive: Directive): this;
- mount(rootContainer: HostElement | string, isHydrate?: boolean): ComponentPublicInstance;
- unmount(): void;
- provide<T>(key: InjectionKey<T> | string, value: T): this;
- _uid: number;
- _component: ConcreteComponent;
- _props: Data | null;
- _container: HostElement | null;
- _context: AppContext;
- }
- export declare interface AppConfig {
- readonly isNativeTag?: (tag: string) => boolean;
- performance: boolean;
- optionMergeStrategies: Record<string, OptionMergeFunction>;
- globalProperties: Record<string, any>;
- isCustomElement: (tag: string) => boolean;
- errorHandler?: (err: unknown, instance: ComponentPublicInstance | null, info: string) => void;
- warnHandler?: (msg: string, instance: ComponentPublicInstance | null, trace: string) => void;
- }
- export declare interface AppContext {
- app: App;
- config: AppConfig;
- mixins: ComponentOptions[];
- components: Record<string, Component>;
- directives: Record<string, Directive>;
- provides: Record<string | symbol, any>;
- /* Excluded from this release type: deopt */
- /* Excluded from this release type: reload */
- }
- declare interface AppRecord {
- id: number;
- app: App;
- version: string;
- types: Record<string, string | Symbol>;
- }
- export declare type AsyncComponentLoader<T = any> = () => Promise<AsyncComponentResolveResult<T>>;
- export declare interface AsyncComponentOptions<T = any> {
- loader: AsyncComponentLoader<T>;
- loadingComponent?: Component;
- errorComponent?: Component;
- delay?: number;
- timeout?: number;
- suspensible?: boolean;
- onError?: (error: Error, retry: () => void, fail: () => void, attempts: number) => any;
- }
- declare type AsyncComponentResolveResult<T = Component> = T | {
- default: T;
- };
- export declare const BaseTransition: new () => {
- $props: BaseTransitionProps<any>;
- };
- export declare interface BaseTransitionProps<HostElement = RendererElement> {
- mode?: 'in-out' | 'out-in' | 'default';
- appear?: boolean;
- persisted?: boolean;
- onBeforeEnter?: (el: HostElement) => void;
- onEnter?: (el: HostElement, done: () => void) => void;
- onAfterEnter?: (el: HostElement) => void;
- onEnterCancelled?: (el: HostElement) => void;
- onBeforeLeave?: (el: HostElement) => void;
- onLeave?: (el: HostElement, done: () => void) => void;
- onAfterLeave?: (el: HostElement) => void;
- onLeaveCancelled?: (el: HostElement) => void;
- onBeforeAppear?: (el: HostElement) => void;
- onAppear?: (el: HostElement, done: () => void) => void;
- onAfterAppear?: (el: HostElement) => void;
- onAppearCancelled?: (el: HostElement) => void;
- }
- declare const enum BooleanFlags {
- shouldCast = 0,
- shouldCastTrue = 1
- }
- export declare function callWithAsyncErrorHandling(fn: Function | Function[], instance: ComponentInternalInstance | null, type: ErrorTypes, args?: unknown[]): any[];
- export declare function callWithErrorHandling(fn: Function, instance: ComponentInternalInstance | null, type: ErrorTypes, args?: unknown[]): any;
- export { camelize }
- export { capitalize }
- declare interface ClassComponent {
- new (...args: any[]): ComponentPublicInstance<any, any, any, any, any>;
- __vccOpts: ComponentOptions;
- }
- export declare function cloneVNode<T, U>(vnode: VNode<T, U>, extraProps?: Data & VNodeProps | null, mergeRef?: boolean): VNode<T, U>;
- declare const Comment_2: unique symbol;
- export { Comment_2 as Comment }
- declare interface CompiledSlotDescriptor {
- name: string;
- fn: Slot;
- }
- /**
- * A type used in public APIs where a component type is expected.
- * The constructor type is an artificial type returned by defineComponent().
- */
- export declare type Component<Props = any, RawBindings = any, D = any, C extends ComputedOptions = ComputedOptions, M extends MethodOptions = MethodOptions> = ConcreteComponent<Props, RawBindings, D, C, M> | ComponentPublicInstanceConstructor<Props>;
- /**
- * Interface for declaring custom options.
- *
- * @example
- * ```ts
- * declare module '@vue/runtime-core' {
- * interface ComponentCustomOptions {
- * beforeRouteUpdate?(
- * to: Route,
- * from: Route,
- * next: () => void
- * ): void
- * }
- * }
- * ```
- */
- export declare interface ComponentCustomOptions {
- }
- /**
- * Custom properties added to component instances in any way and can be accessed through `this`
- *
- * @example
- * Here is an example of adding a property `$router` to every component instance:
- * ```ts
- * import { createApp } from 'vue'
- * import { Router, createRouter } from 'vue-router'
- *
- * declare module '@vue/runtime-core' {
- * interface ComponentCustomProperties {
- * $router: Router
- * }
- * }
- *
- * // effectively adding the router to every component instance
- * const app = createApp({})
- * const router = createRouter()
- * app.config.globalProperties.$router = router
- *
- * const vm = app.mount('#app')
- * // we can access the router from the instance
- * vm.$router.push('/')
- * ```
- */
- export declare interface ComponentCustomProperties {
- }
- /**
- * For extending allowed non-declared props on components in TSX
- */
- export declare interface ComponentCustomProps {
- }
- declare type ComponentInjectOptions = string[] | Record<string | symbol, string | symbol | {
- from?: string | symbol;
- default?: unknown;
- }>;
- /**
- * We expose a subset of properties on the internal instance as they are
- * useful for advanced external libraries and tools.
- */
- export declare interface ComponentInternalInstance {
- uid: number;
- type: ConcreteComponent;
- parent: ComponentInternalInstance | null;
- root: ComponentInternalInstance;
- appContext: AppContext;
- /**
- * Vnode representing this component in its parent's vdom tree
- */
- vnode: VNode;
- /* Excluded from this release type: next */
- /**
- * Root vnode of this component's own vdom tree
- */
- subTree: VNode;
- /**
- * The reactive effect for rendering and patching the component. Callable.
- */
- update: ReactiveEffect;
- /* Excluded from this release type: render */
- /* Excluded from this release type: ssrRender */
- /* Excluded from this release type: provides */
- /* Excluded from this release type: effects */
- /* Excluded from this release type: accessCache */
- /* Excluded from this release type: renderCache */
- /* Excluded from this release type: components */
- /* Excluded from this release type: directives */
- /* Excluded from this release type: propsOptions */
- /* Excluded from this release type: emitsOptions */
- proxy: ComponentPublicInstance | null;
- exposed: Record<string, any> | null;
- /* Excluded from this release type: withProxy */
- /* Excluded from this release type: ctx */
- data: Data;
- props: Data;
- attrs: Data;
- slots: InternalSlots;
- refs: Data;
- emit: EmitFn;
- /* Excluded from this release type: emitted */
- /* Excluded from this release type: setupState */
- /* Excluded from this release type: devtoolsRawSetupState */
- /* Excluded from this release type: setupContext */
- /* Excluded from this release type: suspense */
- /* Excluded from this release type: suspenseId */
- /* Excluded from this release type: asyncDep */
- /* Excluded from this release type: asyncResolved */
- isMounted: boolean;
- isUnmounted: boolean;
- isDeactivated: boolean;
- /* Excluded from this release type: bc */
- /* Excluded from this release type: c */
- /* Excluded from this release type: bm */
- /* Excluded from this release type: m */
- /* Excluded from this release type: bu */
- /* Excluded from this release type: u */
- /* Excluded from this release type: bum */
- /* Excluded from this release type: um */
- /* Excluded from this release type: rtc */
- /* Excluded from this release type: rtg */
- /* Excluded from this release type: a */
- /* Excluded from this release type: da */
- /* Excluded from this release type: ec */
- }
- declare interface ComponentInternalOptions {
- /* Excluded from this release type: __props */
- /* Excluded from this release type: __emits */
- /* Excluded from this release type: __scopeId */
- /* Excluded from this release type: __cssModules */
- /* Excluded from this release type: __hmrId */
- /**
- * This one should be exposed so that devtools can make use of it
- */
- __file?: string;
- }
- export declare type ComponentObjectPropsOptions<P = Data> = {
- [K in keyof P]: Prop<P[K]> | null;
- };
- export declare type ComponentOptions<Props = {}, RawBindings = any, D = any, C extends ComputedOptions = any, M extends MethodOptions = any, Mixin extends ComponentOptionsMixin = any, Extends extends ComponentOptionsMixin = any, E extends EmitsOptions = any> = ComponentOptionsBase<Props, RawBindings, D, C, M, Mixin, Extends, E> & ThisType<CreateComponentPublicInstance<{}, RawBindings, D, C, M, Mixin, Extends, E, Readonly<Props>>>;
- export declare 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 = {}> extends LegacyOptions<Props, D, C, M, Mixin, Extends>, ComponentInternalOptions, ComponentCustomOptions {
- setup?: (this: void, props: Props & UnionToIntersection<ExtractOptionProp<Mixin>> & UnionToIntersection<ExtractOptionProp<Extends>>, ctx: SetupContext<E>) => Promise<RawBindings> | RawBindings | RenderFunction | void;
- name?: string;
- template?: string | object;
- render?: Function;
- components?: Record<string, Component>;
- directives?: Record<string, Directive>;
- inheritAttrs?: boolean;
- emits?: (E | EE[]) & ThisType<void>;
- expose?: string[];
- serverPrefetch?(): Promise<any>;
- /* Excluded from this release type: ssrRender */
- /* Excluded from this release type: __ssrInlineRender */
- /* Excluded from this release type: __asyncLoader */
- /* Excluded from this release type: __merged */
- call?: (this: unknown, ...args: unknown[]) => never;
- __isFragment?: never;
- __isTeleport?: never;
- __isSuspense?: never;
- __defaults?: Defaults;
- }
- export declare type ComponentOptionsMixin = ComponentOptionsBase<any, any, any, any, any, any, any, any, any, any>;
- export declare type ComponentOptionsWithArrayProps<PropNames extends string = string, RawBindings = {}, D = {}, C extends ComputedOptions = {}, M extends MethodOptions = {}, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, E extends EmitsOptions = EmitsOptions, EE extends string = string, Props = Readonly<{
- [key in PropNames]?: any;
- }>> = ComponentOptionsBase<Props, RawBindings, D, C, M, Mixin, Extends, E, EE, {}> & {
- props: PropNames[];
- } & ThisType<CreateComponentPublicInstance<Props, RawBindings, D, C, M, Mixin, Extends, E>>;
- export declare type ComponentOptionsWithObjectProps<PropsOptions = ComponentObjectPropsOptions, RawBindings = {}, D = {}, C extends ComputedOptions = {}, M extends MethodOptions = {}, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, E extends EmitsOptions = EmitsOptions, EE extends string = string, Props = Readonly<ExtractPropTypes<PropsOptions>>, Defaults = ExtractDefaultPropTypes<PropsOptions>> = ComponentOptionsBase<Props, RawBindings, D, C, M, Mixin, Extends, E, EE, Defaults> & {
- props: PropsOptions & ThisType<void>;
- } & ThisType<CreateComponentPublicInstance<Props, RawBindings, D, C, M, Mixin, Extends, E, Props, Defaults, false>>;
- export declare type ComponentOptionsWithoutProps<Props = {}, RawBindings = {}, D = {}, C extends ComputedOptions = {}, M extends MethodOptions = {}, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, E extends EmitsOptions = EmitsOptions, EE extends string = string> = ComponentOptionsBase<Props, RawBindings, D, C, M, Mixin, Extends, E, EE, {}> & {
- props?: undefined;
- } & ThisType<CreateComponentPublicInstance<{}, RawBindings, D, C, M, Mixin, Extends, E>>;
- export declare type ComponentPropsOptions<P = Data> = ComponentObjectPropsOptions<P> | string[];
- export declare type ComponentPublicInstance<P = {}, // props type extracted from props option
- B = {}, // raw bindings returned from setup()
- D = {}, // return from data()
- C extends ComputedOptions = {}, M extends MethodOptions = {}, E extends EmitsOptions = {}, PublicProps = P, Defaults = {}, MakeDefaultsOptional extends boolean = false, Options = ComponentOptionsBase<any, any, any, any, any, any, any, any, any>> = {
- $: ComponentInternalInstance;
- $data: D;
- $props: MakeDefaultsOptional extends true ? Partial<Defaults> & Omit<P & PublicProps, keyof Defaults> : P & PublicProps;
- $attrs: Data;
- $refs: Data;
- $slots: Slots;
- $root: ComponentPublicInstance | null;
- $parent: ComponentPublicInstance | null;
- $emit: EmitFn<E>;
- $el: any;
- $options: Options;
- $forceUpdate: ReactiveEffect;
- $nextTick: typeof nextTick;
- $watch(source: string | Function, cb: Function, options?: WatchOptions): WatchStopHandle;
- } & P & ShallowUnwrapRef<B> & D & ExtractComputedReturns<C> & M & ComponentCustomProperties;
- declare type ComponentPublicInstanceConstructor<T extends ComponentPublicInstance<Props, RawBindings, D, C, M> = ComponentPublicInstance<any>, Props = any, RawBindings = any, D = any, C extends ComputedOptions = ComputedOptions, M extends MethodOptions = MethodOptions> = {
- __isFragment?: never;
- __isTeleport?: never;
- __isSuspense?: never;
- new (...args: any[]): T;
- };
- declare type ComponentWatchOptionItem = WatchOptionItem | WatchOptionItem[];
- declare type ComponentWatchOptions = Record<string, ComponentWatchOptionItem>;
- export declare function computed<T>(getter: ComputedGetter<T>): ComputedRef<T>;
- export declare function computed<T>(options: WritableComputedOptions<T>): WritableComputedRef<T>;
- export declare type ComputedOptions = Record<string, ComputedGetter<any> | WritableComputedOptions<any>>;
- export { ComputedRef }
- /**
- * Concrete component type matches its actual value: it's either an options
- * object, or a function. Use this where the code expects to work with actual
- * values, e.g. checking if its a function or not. This is mostly for internal
- * implementation code.
- */
- export declare type ConcreteComponent<Props = {}, RawBindings = any, D = any, C extends ComputedOptions = ComputedOptions, M extends MethodOptions = MethodOptions> = ComponentOptions<Props, RawBindings, D, C, M> | FunctionalComponent<Props, any>;
- declare interface Constructor<P = any> {
- __isFragment?: never;
- __isTeleport?: never;
- __isSuspense?: never;
- new (...args: any[]): {
- $props: P;
- };
- }
- export declare type CreateAppFunction<HostElement> = (rootComponent: Component, rootProps?: Data | null) => App<HostElement>;
- /**
- * Create a block root vnode. Takes the same exact arguments as `createVNode`.
- * A block root keeps track of dynamic nodes within the block in the
- * `dynamicChildren` array.
- *
- * @private
- */
- export declare function createBlock(type: VNodeTypes | ClassComponent, props?: Record<string, any> | null, children?: any, patchFlag?: number, dynamicProps?: string[]): VNode;
- /**
- * @private
- */
- export declare function createCommentVNode(text?: string, asBlock?: boolean): VNode;
- declare function createComponentInstance(vnode: VNode, parent: ComponentInternalInstance | null, suspense: SuspenseBoundary | null): ComponentInternalInstance;
- declare type CreateComponentPublicInstance<P = {}, B = {}, D = {}, C extends ComputedOptions = {}, M extends MethodOptions = {}, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, E extends EmitsOptions = {}, PublicProps = P, Defaults = {}, MakeDefaultsOptional extends boolean = false, PublicMixin = IntersectionMixin<Mixin> & IntersectionMixin<Extends>, PublicP = UnwrapMixinsType<PublicMixin, 'P'> & EnsureNonVoid<P>, PublicB = UnwrapMixinsType<PublicMixin, 'B'> & EnsureNonVoid<B>, PublicD = UnwrapMixinsType<PublicMixin, 'D'> & EnsureNonVoid<D>, PublicC extends ComputedOptions = UnwrapMixinsType<PublicMixin, 'C'> & EnsureNonVoid<C>, PublicM extends MethodOptions = UnwrapMixinsType<PublicMixin, 'M'> & EnsureNonVoid<M>, PublicDefaults = UnwrapMixinsType<PublicMixin, 'Defaults'> & EnsureNonVoid<Defaults>> = ComponentPublicInstance<PublicP, PublicB, PublicD, PublicC, PublicM, E, PublicProps, PublicDefaults, MakeDefaultsOptional, ComponentOptionsBase<P, B, D, C, M, Mixin, Extends, E, string, Defaults>>;
- export declare function createHydrationRenderer(options: RendererOptions<Node, Element>): HydrationRenderer;
- declare function createRecord(id: string, component: ComponentOptions | ClassComponent): boolean;
- /**
- * The createRenderer function accepts two generic arguments:
- * HostNode and HostElement, corresponding to Node and Element types in the
- * host environment. For example, for runtime-dom, HostNode would be the DOM
- * `Node` interface and HostElement would be the DOM `Element` interface.
- *
- * Custom renderers can pass in the platform specific types like this:
- *
- * ``` js
- * const { render, createApp } = createRenderer<Node, Element>({
- * patchProp,
- * ...nodeOps
- * })
- * ```
- */
- export declare function createRenderer<HostNode = RendererNode, HostElement = RendererElement>(options: RendererOptions<HostNode, HostElement>): Renderer<HostElement>;
- /**
- * Compiler runtime helper for creating dynamic slots object
- * @private
- */
- export declare function createSlots(slots: Record<string, Slot>, dynamicSlots: (CompiledSlotDescriptor | CompiledSlotDescriptor[] | undefined)[]): Record<string, Slot>;
- /**
- * @private
- */
- export declare function createStaticVNode(content: string, numberOfNodes: number): VNode;
- declare function createSuspenseBoundary(vnode: VNode, parent: SuspenseBoundary | null, parentComponent: ComponentInternalInstance | null, container: RendererElement, hiddenContainer: RendererElement, anchor: RendererNode | null, isSVG: boolean, optimized: boolean, rendererInternals: RendererInternals, isHydrating?: boolean): SuspenseBoundary;
- /**
- * @private
- */
- export declare function createTextVNode(text?: string, flag?: number): VNode;
- export declare const createVNode: typeof _createVNode;
- declare function _createVNode(type: VNodeTypes | ClassComponent | typeof NULL_DYNAMIC_COMPONENT, props?: (Data & VNodeProps) | null, children?: unknown, patchFlag?: number, dynamicProps?: string[] | null, isBlockNode?: boolean): VNode;
- export { customRef }
- declare type Data = Record<string, unknown>;
- export { DebuggerEvent }
- declare type DebuggerHook = (e: DebuggerEvent) => void;
- export { DeepReadonly }
- declare type DefaultFactory<T> = (props: Data) => T | null | undefined;
- declare type DefaultKeys<T> = {
- [K in keyof T]: T[K] extends {
- default: any;
- } | BooleanConstructor | {
- type: BooleanConstructor;
- } ? T[K] extends {
- type: BooleanConstructor;
- required: true;
- } ? never : K : never;
- }[keyof T];
- export declare function defineAsyncComponent<T extends Component = {
- new (): ComponentPublicInstance;
- }>(source: AsyncComponentLoader<T> | AsyncComponentOptions<T>): T;
- export declare type DefineComponent<PropsOrPropOptions = {}, RawBindings = {}, D = {}, C extends ComputedOptions = ComputedOptions, M extends MethodOptions = MethodOptions, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, E extends EmitsOptions = Record<string, any>, EE extends string = string, PP = PublicProps, Props = Readonly<ExtractPropTypes<PropsOrPropOptions>>, Defaults = ExtractDefaultPropTypes<PropsOrPropOptions>> = ComponentPublicInstanceConstructor<CreateComponentPublicInstance<Props, RawBindings, D, C, M, Mixin, Extends, E, PP & Props, Defaults, true> & Props> & ComponentOptionsBase<Props, RawBindings, D, C, M, Mixin, Extends, E, EE, Defaults> & PP;
- export declare function defineComponent<Props, RawBindings = object>(setup: (props: Readonly<Props>, ctx: SetupContext) => RawBindings | RenderFunction): DefineComponent<Props, RawBindings>;
- export declare function defineComponent<Props = {}, RawBindings = {}, D = {}, C extends ComputedOptions = {}, M extends MethodOptions = {}, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, E extends EmitsOptions = EmitsOptions, EE extends string = string>(options: ComponentOptionsWithoutProps<Props, RawBindings, D, C, M, Mixin, Extends, E, EE>): DefineComponent<Props, RawBindings, D, C, M, Mixin, Extends, E, EE>;
- export declare function defineComponent<PropNames extends string, RawBindings, D, C extends ComputedOptions = {}, M extends MethodOptions = {}, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, E extends EmitsOptions = Record<string, any>, EE extends string = string>(options: ComponentOptionsWithArrayProps<PropNames, RawBindings, D, C, M, Mixin, Extends, E, EE>): DefineComponent<Readonly<{
- [key in PropNames]?: any;
- }>, RawBindings, D, C, M, Mixin, Extends, E, EE>;
- export declare function defineComponent<PropsOptions extends Readonly<ComponentPropsOptions>, RawBindings, D, C extends ComputedOptions = {}, M extends MethodOptions = {}, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, E extends EmitsOptions = Record<string, any>, EE extends string = string>(options: ComponentOptionsWithObjectProps<PropsOptions, RawBindings, D, C, M, Mixin, Extends, E, EE>): DefineComponent<PropsOptions, RawBindings, D, C, M, Mixin, Extends, E, EE>;
- export declare function defineEmit<TypeEmit = undefined, E extends EmitsOptions = EmitsOptions, EE extends string = string, InferredEmit = EmitFn<E>>(emitOptions?: E | EE[]): TypeEmit extends undefined ? InferredEmit : TypeEmit;
- /**
- * Compile-time-only helper used for declaring props inside `<script setup>`.
- * This is stripped away in the compiled code and should never be actually
- * called at runtime.
- */
- export declare function defineProps<TypeProps = undefined, PropNames extends string = string, InferredProps = {
- [key in PropNames]?: any;
- }>(props?: PropNames[]): Readonly<TypeProps extends undefined ? InferredProps : TypeProps>;
- export declare function defineProps<TypeProps = undefined, PP extends ComponentObjectPropsOptions = ComponentObjectPropsOptions, InferredProps = ExtractPropTypes<PP>>(props?: PP): Readonly<TypeProps extends undefined ? InferredProps : TypeProps>;
- export declare let devtools: DevtoolsHook;
- declare interface DevtoolsHook {
- emit: (event: string, ...payload: any[]) => void;
- on: (event: string, handler: Function) => void;
- once: (event: string, handler: Function) => void;
- off: (event: string, handler: Function) => void;
- appRecords: AppRecord[];
- }
- export declare type Directive<T = any, V = any> = ObjectDirective<T, V> | FunctionDirective<T, V>;
- export declare type DirectiveArguments = Array<[Directive] | [Directive, any] | [Directive, any, string] | [Directive, any, string, DirectiveModifiers]>;
- export declare interface DirectiveBinding<V = any> {
- instance: ComponentPublicInstance | null;
- value: V;
- oldValue: V | null;
- arg?: string;
- modifiers: DirectiveModifiers;
- dir: ObjectDirective<any, V>;
- }
- export declare type DirectiveHook<T = any, Prev = VNode<any, T> | null, V = any> = (el: T, binding: DirectiveBinding<V>, vnode: VNode<any, T>, prevVNode: Prev) => void;
- declare type DirectiveModifiers = Record<string, boolean>;
- declare type EmitFn<Options = ObjectEmitsOptions, Event extends keyof Options = keyof Options> = Options extends Array<infer V> ? (event: V, ...args: any[]) => void : {} extends Options ? (event: string, ...args: any[]) => void : UnionToIntersection<{
- [key in Event]: Options[key] extends ((...args: infer Args) => any) ? (event: key, ...args: Args) => void : (event: key, ...args: any[]) => void;
- }[Event]>;
- export declare type EmitsOptions = ObjectEmitsOptions | string[];
- declare type EnsureNonVoid<T> = T extends void ? {} : T;
- declare type ErrorCapturedHook = (err: unknown, instance: ComponentPublicInstance | null, info: string) => boolean | void;
- export declare const enum ErrorCodes {
- SETUP_FUNCTION = 0,
- RENDER_FUNCTION = 1,
- WATCH_GETTER = 2,
- WATCH_CALLBACK = 3,
- WATCH_CLEANUP = 4,
- NATIVE_EVENT_HANDLER = 5,
- COMPONENT_EVENT_HANDLER = 6,
- VNODE_HOOK = 7,
- DIRECTIVE_HOOK = 8,
- TRANSITION_HOOK = 9,
- APP_ERROR_HANDLER = 10,
- APP_WARN_HANDLER = 11,
- FUNCTION_REF = 12,
- ASYNC_COMPONENT_LOADER = 13,
- SCHEDULER = 14
- }
- declare type ErrorTypes = LifecycleHooks | ErrorCodes;
- declare type ExtractComputedReturns<T extends any> = {
- [key in keyof T]: T[key] extends {
- get: (...args: any[]) => infer TReturn;
- } ? TReturn : T[key] extends (...args: any[]) => infer TReturn ? TReturn : never;
- };
- export declare type ExtractDefaultPropTypes<O> = O extends object ? {
- [K in DefaultKeys<O>]: InferPropType<O[K]>;
- } : {};
- declare type ExtractMixin<T> = {
- Mixin: MixinToOptionTypes<T>;
- }[T extends ComponentOptionsMixin ? 'Mixin' : never];
- declare type ExtractOptionProp<T> = T extends ComponentOptionsBase<infer P, any, any, any, any, any, any, any> ? unknown extends P ? {} : P : {};
- export declare type ExtractPropTypes<O> = O extends object ? {
- [K in RequiredKeys<O>]: InferPropType<O[K]>;
- } & {
- [K in OptionalKeys<O>]?: InferPropType<O[K]>;
- } : {
- [K in string]: any;
- };
- export declare const Fragment: {
- new (): {
- $props: VNodeProps;
- };
- __isFragment: true;
- };
- export declare interface FunctionalComponent<P = {}, E extends EmitsOptions = {}> extends ComponentInternalOptions {
- (props: P, ctx: Omit<SetupContext<E>, 'expose'>): any;
- props?: ComponentPropsOptions<P>;
- emits?: E | (keyof E)[];
- inheritAttrs?: boolean;
- displayName?: string;
- }
- export declare type FunctionDirective<T = any, V = any> = DirectiveHook<T, any, V>;
- export declare const getCurrentInstance: () => ComponentInternalInstance | null;
- export declare function getTransitionRawChildren(children: VNode[], keepComment?: boolean): VNode[];
- export declare function h(type: string, children?: RawChildren): VNode;
- export declare function h(type: string, props?: RawProps | null, children?: RawChildren | RawSlots): VNode;
- export declare function h(type: typeof Fragment, children?: VNodeArrayChildren): VNode;
- export declare function h(type: typeof Fragment, props?: RawProps | null, children?: VNodeArrayChildren): VNode;
- export declare function h(type: typeof Teleport, props: RawProps & TeleportProps, children: RawChildren): VNode;
- export declare function h(type: typeof Suspense, children?: RawChildren): VNode;
- export declare function h(type: typeof Suspense, props?: (RawProps & SuspenseProps) | null, children?: RawChildren | RawSlots): VNode;
- export declare function h<P, E extends EmitsOptions = {}>(type: FunctionalComponent<P, E>, props?: (RawProps & P) | ({} extends P ? null : never), children?: RawChildren | RawSlots): VNode;
- export declare function h(type: Component, children?: RawChildren): VNode;
- export declare function h<P>(type: ConcreteComponent | string, children?: RawChildren): VNode;
- export declare function h<P>(type: ConcreteComponent<P> | string, props?: (RawProps & P) | ({} extends P ? null : never), children?: RawChildren): VNode;
- export declare function h(type: Component, props: null, children?: RawChildren | RawSlots): VNode;
- export declare function h<P>(type: ComponentOptions<P>, props?: (RawProps & P) | ({} extends P ? null : never), children?: RawChildren | RawSlots): VNode;
- export declare function h(type: Constructor, children?: RawChildren): VNode;
- export declare function h<P>(type: Constructor<P>, props?: (RawProps & P) | ({} extends P ? null : never), children?: RawChildren | RawSlots): VNode;
- export declare function h(type: DefineComponent, children?: RawChildren): VNode;
- export declare function h<P>(type: DefineComponent<P>, props?: (RawProps & P) | ({} extends P ? null : never), children?: RawChildren | RawSlots): VNode;
- export declare function handleError(err: unknown, instance: ComponentInternalInstance | null, type: ErrorTypes, throwInDev?: boolean): void;
- export declare interface HMRRuntime {
- createRecord: typeof createRecord;
- rerender: typeof rerender;
- reload: typeof reload;
- }
- declare function hydrateSuspense(node: Node, vnode: VNode, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, isSVG: boolean, optimized: boolean, rendererInternals: RendererInternals, hydrateNode: (node: Node, vnode: VNode, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, optimized: boolean) => Node | null): Node | null;
- declare function hydrateTeleport(node: Node, vnode: TeleportVNode, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, optimized: boolean, { o: { nextSibling, parentNode, querySelector } }: RendererInternals<Node, Element>, hydrateChildren: (node: Node | null, vnode: VNode, container: Element, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, optimized: boolean) => Node | null): Node | null;
- export declare interface HydrationRenderer extends Renderer<Element> {
- hydrate: RootHydrateFunction;
- }
- declare type InferPropType<T> = T extends null ? any : T extends {
- type: null | true;
- } ? any : T extends ObjectConstructor | {
- type: ObjectConstructor;
- } ? Record<string, any> : T extends BooleanConstructor | {
- type: BooleanConstructor;
- } ? boolean : T extends DateConstructor | {
- type: DateConstructor;
- } ? Date : T extends Prop<infer V, infer D> ? (unknown extends V ? D : V) : T;
- export declare function initCustomFormatter(): void;
- export declare function inject<T>(key: InjectionKey<T> | string): T | undefined;
- export declare function inject<T>(key: InjectionKey<T> | string, defaultValue: T, treatDefaultAsFactory?: false): T;
- export declare function inject<T>(key: InjectionKey<T> | string, defaultValue: T | (() => T), treatDefaultAsFactory: true): T;
- export declare interface InjectionKey<T> extends Symbol {
- }
- /* Excluded from this release type: InternalRenderFunction */
- declare type InternalSlots = {
- [name: string]: Slot | undefined;
- };
- declare type IntersectionMixin<T> = IsDefaultMixinComponent<T> extends true ? OptionTypesType<{}, {}, {}, {}, {}> : UnionToIntersection<ExtractMixin<T>>;
- declare type InvalidateCbRegistrator = (cb: () => void) => void;
- declare type IsDefaultMixinComponent<T> = T extends ComponentOptionsMixin ? ComponentOptionsMixin extends T ? true : false : false;
- export { isProxy }
- export { isReactive }
- export { isReadonly }
- export { isRef }
- export declare function isVNode(value: any): value is VNode;
- export declare const KeepAlive: {
- new (): {
- $props: VNodeProps & KeepAliveProps;
- };
- __isKeepAlive: true;
- };
- export declare interface KeepAliveProps {
- include?: MatchPattern;
- exclude?: MatchPattern;
- max?: number | string;
- }
- declare interface LegacyOptions<Props, D, C extends ComputedOptions, M extends MethodOptions, Mixin extends ComponentOptionsMixin, Extends extends ComponentOptionsMixin> {
- [key: string]: any;
- data?: (this: CreateComponentPublicInstance<Props, {}, {}, {}, MethodOptions, Mixin, Extends>, vm: CreateComponentPublicInstance<Props, {}, {}, {}, MethodOptions, Mixin, Extends>) => D;
- computed?: C;
- methods?: M;
- watch?: ComponentWatchOptions;
- provide?: Data | Function;
- inject?: ComponentInjectOptions;
- mixins?: Mixin[];
- extends?: Extends;
- beforeCreate?(): void;
- created?(): void;
- beforeMount?(): void;
- mounted?(): void;
- beforeUpdate?(): void;
- updated?(): void;
- activated?(): void;
- deactivated?(): void;
- /** @deprecated use `beforeUnmount` instead */
- beforeDestroy?(): void;
- beforeUnmount?(): void;
- /** @deprecated use `unmounted` instead */
- destroyed?(): void;
- unmounted?(): void;
- renderTracked?: DebuggerHook;
- renderTriggered?: DebuggerHook;
- errorCaptured?: ErrorCapturedHook;
- delimiters?: [string, string];
- }
- declare type LifecycleHook = Function[] | null;
- declare const enum LifecycleHooks {
- BEFORE_CREATE = "bc",
- CREATED = "c",
- BEFORE_MOUNT = "bm",
- MOUNTED = "m",
- BEFORE_UPDATE = "bu",
- UPDATED = "u",
- BEFORE_UNMOUNT = "bum",
- UNMOUNTED = "um",
- DEACTIVATED = "da",
- ACTIVATED = "a",
- RENDER_TRIGGERED = "rtg",
- RENDER_TRACKED = "rtc",
- ERROR_CAPTURED = "ec"
- }
- declare type MapSources<T, Immediate> = {
- [K in keyof T]: T[K] extends WatchSource<infer V> ? Immediate extends true ? (V | undefined) : V : T[K] extends object ? Immediate extends true ? (T[K] | undefined) : T[K] : never;
- };
- export { markRaw }
- declare type MatchPattern = string | RegExp | string[] | RegExp[];
- export declare function mergeProps(...args: (Data & VNodeProps)[]): Record<string, unknown> & VNodeProps;
- export declare interface MethodOptions {
- [key: string]: Function;
- }
- declare type MixinToOptionTypes<T> = T extends ComponentOptionsBase<infer P, infer B, infer D, infer C, infer M, infer Mixin, infer Extends, any, any, infer Defaults> ? OptionTypesType<P & {}, B & {}, D & {}, C & {}, M & {}, Defaults & {}> & IntersectionMixin<Mixin> & IntersectionMixin<Extends> : never;
- declare type MountChildrenFn = (children: VNodeArrayChildren, container: RendererElement, anchor: RendererNode | null, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, isSVG: boolean, optimized: boolean, start?: number) => void;
- declare type MountComponentFn = (initialVNode: VNode, container: RendererElement, anchor: RendererNode | null, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, isSVG: boolean, optimized: boolean) => void;
- declare type MoveFn = (vnode: VNode, container: RendererElement, anchor: RendererNode | null, type: MoveType, parentSuspense?: SuspenseBoundary | null) => void;
- declare function moveTeleport(vnode: VNode, container: RendererElement, parentAnchor: RendererNode | null, { o: { insert }, m: move }: RendererInternals, moveType?: TeleportMoveTypes): void;
- declare const enum MoveType {
- ENTER = 0,
- LEAVE = 1,
- REORDER = 2
- }
- declare type MultiWatchSources = (WatchSource<unknown> | object)[];
- declare type NextFn = (vnode: VNode) => RendererNode | null;
- export declare function nextTick(this: ComponentPublicInstance | void, fn?: () => void): Promise<void>;
- declare type NormalizedProp = null | (PropOptions & {
- [BooleanFlags.shouldCast]?: boolean;
- [BooleanFlags.shouldCastTrue]?: boolean;
- });
- declare type NormalizedProps = Record<string, NormalizedProp>;
- declare type NormalizedPropsOptions = [NormalizedProps, string[]] | [];
- declare function normalizeVNode(child: VNodeChild): VNode;
- declare const NULL_DYNAMIC_COMPONENT: unique symbol;
- export declare interface ObjectDirective<T = any, V = any> {
- created?: DirectiveHook<T, null, V>;
- beforeMount?: DirectiveHook<T, null, V>;
- mounted?: DirectiveHook<T, null, V>;
- beforeUpdate?: DirectiveHook<T, VNode<any, T>, V>;
- updated?: DirectiveHook<T, VNode<any, T>, V>;
- beforeUnmount?: DirectiveHook<T, null, V>;
- unmounted?: DirectiveHook<T, null, V>;
- getSSRProps?: SSRDirectiveHook;
- }
- export declare type ObjectEmitsOptions = Record<string, ((...args: any[]) => any) | null>;
- export declare function onActivated(hook: Function, target?: ComponentInternalInstance | null): void;
- export declare const onBeforeMount: (hook: () => any, target?: ComponentInternalInstance | null) => false | Function | undefined;
- export declare const onBeforeUnmount: (hook: () => any, target?: ComponentInternalInstance | null) => false | Function | undefined;
- export declare const onBeforeUpdate: (hook: () => any, target?: ComponentInternalInstance | null) => false | Function | undefined;
- export declare function onDeactivated(hook: Function, target?: ComponentInternalInstance | null): void;
- export declare const onErrorCaptured: (hook: ErrorCapturedHook, target?: ComponentInternalInstance | null) => void;
- export declare const onMounted: (hook: () => any, target?: ComponentInternalInstance | null) => false | Function | undefined;
- export declare const onRenderTracked: (hook: DebuggerHook, target?: ComponentInternalInstance | null) => false | Function | undefined;
- export declare const onRenderTriggered: (hook: DebuggerHook, target?: ComponentInternalInstance | null) => false | Function | undefined;
- export declare const onUnmounted: (hook: () => any, target?: ComponentInternalInstance | null) => false | Function | undefined;
- export declare const onUpdated: (hook: () => any, target?: ComponentInternalInstance | null) => false | Function | undefined;
- /**
- * Open a block.
- * This must be called before `createBlock`. It cannot be part of `createBlock`
- * because the children of the block are evaluated before `createBlock` itself
- * is called. The generated code typically looks like this:
- *
- * ```js
- * function render() {
- * return (openBlock(),createBlock('div', null, [...]))
- * }
- * ```
- * disableTracking is true when creating a v-for fragment block, since a v-for
- * fragment always diffs its children.
- *
- * @private
- */
- export declare function openBlock(disableTracking?: boolean): void;
- declare type OptionalKeys<T> = Exclude<keyof T, RequiredKeys<T>>;
- export declare type OptionMergeFunction = (to: unknown, from: unknown, instance: any, key: string) => any;
- declare type OptionTypesKeys = 'P' | 'B' | 'D' | 'C' | 'M' | 'Defaults';
- declare type OptionTypesType<P = {}, B = {}, D = {}, C extends ComputedOptions = {}, M extends MethodOptions = {}, Defaults = {}> = {
- P: P;
- B: B;
- D: D;
- C: C;
- M: M;
- Defaults: Defaults;
- };
- declare type PatchBlockChildrenFn = (oldChildren: VNode[], newChildren: VNode[], fallbackContainer: RendererElement, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, isSVG: boolean) => void;
- declare type PatchChildrenFn = (n1: VNode | null, n2: VNode, container: RendererElement, anchor: RendererNode | null, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, isSVG: boolean, optimized?: boolean) => void;
- declare type PatchFn = (n1: VNode | null, // null means this is a mount
- n2: VNode, container: RendererElement, anchor?: RendererNode | null, parentComponent?: ComponentInternalInstance | null, parentSuspense?: SuspenseBoundary | null, isSVG?: boolean, optimized?: boolean) => void;
- declare type Plugin_2 = PluginInstallFunction & {
- install?: PluginInstallFunction;
- } | {
- install: PluginInstallFunction;
- };
- export { Plugin_2 as Plugin }
- declare type PluginInstallFunction = (app: App, ...options: any[]) => any;
- /**
- * @private
- */
- export declare function popScopeId(): void;
- export declare type Prop<T, D = T> = PropOptions<T, D> | PropType<T>;
- declare type PropConstructor<T = any> = {
- new (...args: any[]): T & object;
- } | {
- (): T;
- } | PropMethod<T>;
- declare type PropMethod<T, TConstructor = any> = T extends (...args: any) => any ? {
- new (): TConstructor;
- (): T;
- readonly prototype: TConstructor;
- } : never;
- declare interface PropOptions<T = any, D = T> {
- type?: PropType<T> | true | null;
- required?: boolean;
- default?: D | DefaultFactory<D> | null | undefined | object;
- validator?(value: unknown): boolean;
- }
- export declare type PropType<T> = PropConstructor<T> | PropConstructor<T>[];
- export declare function provide<T>(key: InjectionKey<T> | string | number, value: T): void;
- export { proxyRefs }
- declare type PublicProps = VNodeProps & AllowedComponentProps & ComponentCustomProps;
- /**
- * @private
- */
- export declare function pushScopeId(id: string): void;
- export declare function queuePostFlushCb(cb: SchedulerCbs): void;
- declare type RawChildren = string | number | boolean | VNode | VNodeArrayChildren | (() => any);
- declare type RawProps = VNodeProps & {
- __v_isVNode?: never;
- [Symbol.iterator]?: never;
- } & Record<string, any>;
- declare type RawSlots = {
- [name: string]: unknown;
- $stable?: boolean;
- /* Excluded from this release type: _ctx */
- /* Excluded from this release type: _ */
- };
- export { reactive }
- export { ReactiveEffect }
- export { ReactiveEffectOptions }
- export { readonly }
- export { Ref }
- export { ref }
- /**
- * For runtime-dom to register the compiler.
- * Note the exported method uses any to avoid d.ts relying on the compiler types.
- */
- export declare function registerRuntimeCompiler(_compile: any): void;
- declare function reload(id: string, newComp: ComponentOptions | ClassComponent): void;
- declare type RemoveFn = (vnode: VNode) => void;
- declare function renderComponentRoot(instance: ComponentInternalInstance): VNode;
- export declare interface Renderer<HostElement = RendererElement> {
- render: RootRenderFunction<HostElement>;
- createApp: CreateAppFunction<HostElement>;
- }
- export declare interface RendererElement extends RendererNode {
- }
- declare interface RendererInternals<HostNode = RendererNode, HostElement = RendererElement> {
- p: PatchFn;
- um: UnmountFn;
- r: RemoveFn;
- m: MoveFn;
- mt: MountComponentFn;
- mc: MountChildrenFn;
- pc: PatchChildrenFn;
- pbc: PatchBlockChildrenFn;
- n: NextFn;
- o: RendererOptions<HostNode, HostElement>;
- }
- export declare interface RendererNode {
- [key: string]: any;
- }
- export declare interface RendererOptions<HostNode = RendererNode, HostElement = RendererElement> {
- patchProp(el: HostElement, key: string, prevValue: any, nextValue: any, isSVG?: boolean, prevChildren?: VNode<HostNode, HostElement>[], parentComponent?: ComponentInternalInstance | null, parentSuspense?: SuspenseBoundary | null, unmountChildren?: UnmountChildrenFn): void;
- forcePatchProp?(el: HostElement, key: string): boolean;
- insert(el: HostNode, parent: HostElement, anchor?: HostNode | null): void;
- remove(el: HostNode): void;
- createElement(type: string, isSVG?: boolean, isCustomizedBuiltIn?: string): HostElement;
- createText(text: string): HostNode;
- createComment(text: string): HostNode;
- setText(node: HostNode, text: string): void;
- setElementText(node: HostElement, text: string): void;
- parentNode(node: HostNode): HostElement | null;
- nextSibling(node: HostNode): HostNode | null;
- querySelector?(selector: string): HostElement | null;
- setScopeId?(el: HostElement, id: string): void;
- cloneNode?(node: HostNode): HostNode;
- insertStaticContent?(content: string, parent: HostElement, anchor: HostNode | null, isSVG: boolean): HostElement[];
- }
- export declare type RenderFunction = () => VNodeChild;
- /**
- * v-for string
- * @private
- */
- export declare function renderList(source: string, renderItem: (value: string, index: number) => VNodeChild): VNodeChild[];
- /**
- * v-for number
- */
- export declare function renderList(source: number, renderItem: (value: number, index: number) => VNodeChild): VNodeChild[];
- /**
- * v-for array
- */
- export declare function renderList<T>(source: T[], renderItem: (value: T, index: number) => VNodeChild): VNodeChild[];
- /**
- * v-for iterable
- */
- export declare function renderList<T>(source: Iterable<T>, renderItem: (value: T, index: number) => VNodeChild): VNodeChild[];
- /**
- * v-for object
- */
- export declare function renderList<T>(source: T, renderItem: <K extends keyof T>(value: T[K], key: K, index: number) => VNodeChild): VNodeChild[];
- /**
- * Compiler runtime helper for rendering `<slot/>`
- * @private
- */
- export declare function renderSlot(slots: Slots, name: string, props?: Data, fallback?: () => VNodeArrayChildren): VNode;
- declare type RequiredKeys<T> = {
- [K in keyof T]: T[K] extends {
- required: true;
- } | {
- default: any;
- } | BooleanConstructor | {
- type: BooleanConstructor;
- } ? K : never;
- }[keyof T];
- declare function rerender(id: string, newRender?: Function): void;
- /**
- * @private
- */
- export declare function resolveComponent(name: string): ConcreteComponent | string;
- /**
- * @private
- */
- export declare function resolveDirective(name: string): Directive | undefined;
- /**
- * @private
- */
- export declare function resolveDynamicComponent(component: unknown): VNodeTypes;
- export declare function resolveTransitionHooks(vnode: VNode, props: BaseTransitionProps<any>, state: TransitionState, instance: ComponentInternalInstance): TransitionHooks;
- export declare type RootHydrateFunction = (vnode: VNode<Node, Element>, container: Element) => void;
- export declare type RootRenderFunction<HostElement = RendererElement> = (vnode: VNode | null, container: HostElement) => void;
- declare type SchedulerCb = Function & {
- id?: number;
- };
- declare type SchedulerCbs = SchedulerCb | SchedulerCb[];
- /**
- * Block tracking sometimes needs to be disabled, for example during the
- * creation of a tree that needs to be cached by v-once. The compiler generates
- * code like this:
- *
- * ``` js
- * _cache[1] || (
- * setBlockTracking(-1),
- * _cache[1] = createVNode(...),
- * setBlockTracking(1),
- * _cache[1]
- * )
- * ```
- *
- * @private
- */
- export declare function setBlockTracking(value: number): void;
- declare function setCurrentRenderingInstance(instance: ComponentInternalInstance | null): void;
- export declare function setDevtoolsHook(hook: DevtoolsHook): void;
- export declare function setTransitionHooks(vnode: VNode, hooks: TransitionHooks): void;
- declare function setupComponent(instance: ComponentInternalInstance, isSSR?: boolean): Promise<void> | undefined;
- export declare interface SetupContext<E = EmitsOptions> {
- attrs: Data;
- slots: Slots;
- emit: EmitFn<E>;
- expose: (exposed: Record<string, any>) => void;
- }
- declare type SetupRenderEffectFn = (instance: ComponentInternalInstance, initialVNode: VNode, container: RendererElement, anchor: RendererNode | null, parentSuspense: SuspenseBoundary | null, isSVG: boolean, optimized: boolean) => void;
- export { shallowReactive }
- export { shallowReadonly }
- export { shallowRef }
- export { ShallowUnwrapRef }
- export declare type Slot = (...args: any[]) => VNode[];
- export declare type Slots = Readonly<InternalSlots>;
- export declare const ssrContextKey: unique symbol;
- declare type SSRDirectiveHook = (binding: DirectiveBinding, vnode: VNode) => Data | undefined;
- /* Excluded from this release type: ssrUtils */
- export declare const Static: unique symbol;
- export declare const Suspense: {
- new (): {
- $props: VNodeProps & SuspenseProps;
- };
- __isSuspense: true;
- };
- export declare interface SuspenseBoundary {
- vnode: VNode<RendererNode, RendererElement, SuspenseProps>;
- parent: SuspenseBoundary | null;
- parentComponent: ComponentInternalInstance | null;
- isSVG: boolean;
- container: RendererElement;
- hiddenContainer: RendererElement;
- anchor: RendererNode | null;
- activeBranch: VNode | null;
- pendingBranch: VNode | null;
- deps: number;
- pendingId: number;
- timeout: number;
- isInFallback: boolean;
- isHydrating: boolean;
- isUnmounted: boolean;
- effects: Function[];
- resolve(force?: boolean): void;
- fallback(fallbackVNode: VNode): void;
- move(container: RendererElement, anchor: RendererNode | null, type: MoveType): void;
- next(): RendererNode | null;
- registerDep(instance: ComponentInternalInstance, setupRenderEffect: SetupRenderEffectFn): void;
- unmount(parentSuspense: SuspenseBoundary | null, doRemove?: boolean): void;
- }
- declare const SuspenseImpl: {
- __isSuspense: boolean;
- process(n1: VNode | null, n2: VNode, container: RendererElement, anchor: RendererNode | null, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, isSVG: boolean, optimized: boolean, rendererInternals: RendererInternals): void;
- hydrate: typeof hydrateSuspense;
- create: typeof createSuspenseBoundary;
- };
- export declare interface SuspenseProps {
- onResolve?: () => void;
- onPending?: () => void;
- onFallback?: () => void;
- timeout?: string | number;
- }
- export declare const Teleport: {
- new (): {
- $props: VNodeProps & TeleportProps;
- };
- __isTeleport: true;
- };
- declare const TeleportImpl: {
- __isTeleport: boolean;
- process(n1: TeleportVNode | null, n2: TeleportVNode, container: RendererElement, anchor: RendererNode | null, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, isSVG: boolean, optimized: boolean, internals: RendererInternals): void;
- remove(vnode: VNode, { r: remove, o: { remove: hostRemove } }: RendererInternals): void;
- move: typeof moveTeleport;
- hydrate: typeof hydrateTeleport;
- };
- declare const enum TeleportMoveTypes {
- TARGET_CHANGE = 0,
- TOGGLE = 1,
- REORDER = 2
- }
- export declare interface TeleportProps {
- to: string | RendererElement | null | undefined;
- disabled?: boolean;
- }
- declare type TeleportVNode = VNode<RendererNode, RendererElement, TeleportProps>;
- declare const Text_2: unique symbol;
- export { Text_2 as Text }
- export { toDisplayString }
- export { toHandlerKey }
- /**
- * For prefixing keys in v-on="obj" with "on"
- * @private
- */
- export declare function toHandlers(obj: Record<string, any>): Record<string, any>;
- export { toRaw }
- export { toRef }
- export { ToRefs }
- export { toRefs }
- export { TrackOpTypes }
- /**
- * Internal API for registering an arguments transform for createVNode
- * used for creating stubs in the test-utils
- * It is *internal* but needs to be exposed for test-utils to pick up proper
- * typings
- */
- export declare function transformVNodeArgs(transformer?: typeof vnodeArgsTransformer): void;
- export declare interface TransitionHooks<HostElement extends RendererElement = RendererElement> {
- mode: BaseTransitionProps['mode'];
- persisted: boolean;
- beforeEnter(el: HostElement): void;
- enter(el: HostElement): void;
- leave(el: HostElement, remove: () => void): void;
- clone(vnode: VNode): TransitionHooks<HostElement>;
- afterLeave?(): void;
- delayLeave?(el: HostElement, earlyRemove: () => void, delayedLeave: () => void): void;
- delayedLeave?(): void;
- }
- export declare interface TransitionState {
- isMounted: boolean;
- isLeaving: boolean;
- isUnmounting: boolean;
- leavingVNodes: Map<any, Record<string, VNode>>;
- }
- export { TriggerOpTypes }
- export { triggerRef }
- declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
- declare type UnmountChildrenFn = (children: VNode[], parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, doRemove?: boolean, optimized?: boolean, start?: number) => void;
- declare type UnmountFn = (vnode: VNode, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, doRemove?: boolean, optimized?: boolean) => void;
- export { unref }
- declare type UnwrapMixinsType<T, Type extends OptionTypesKeys> = T extends OptionTypesType ? T[Type] : never;
- export { UnwrapRef }
- export declare function useContext(): SetupContext;
- export declare const useSSRContext: <T = Record<string, any>>() => T | undefined;
- export declare function useTransitionState(): TransitionState;
- export declare const version: string;
- export declare interface VNode<HostNode = RendererNode, HostElement = RendererElement, ExtraProps = {
- [key: string]: any;
- }> {
- /* Excluded from this release type: __v_isVNode */
- /* Excluded from this release type: __v_skip */
- type: VNodeTypes;
- props: (VNodeProps & ExtraProps) | null;
- key: string | number | null;
- ref: VNodeNormalizedRef | null;
- scopeId: string | null;
- children: VNodeNormalizedChildren;
- component: ComponentInternalInstance | null;
- dirs: DirectiveBinding[] | null;
- transition: TransitionHooks<HostElement> | null;
- el: HostNode | null;
- anchor: HostNode | null;
- target: HostElement | null;
- targetAnchor: HostNode | null;
- staticCount: number;
- suspense: SuspenseBoundary | null;
- ssContent: VNode | null;
- ssFallback: VNode | null;
- shapeFlag: number;
- patchFlag: number;
- dynamicProps: string[] | null;
- dynamicChildren: VNode[] | null;
- appContext: AppContext | null;
- }
- declare let vnodeArgsTransformer: ((args: Parameters<typeof _createVNode>, instance: ComponentInternalInstance | null) => Parameters<typeof _createVNode>) | undefined;
- export declare type VNodeArrayChildren = Array<VNodeArrayChildren | VNodeChildAtom>;
- export declare type VNodeChild = VNodeChildAtom | VNodeArrayChildren;
- declare type VNodeChildAtom = VNode | string | number | boolean | null | undefined | void;
- declare type VNodeMountHook = (vnode: VNode) => void;
- export declare type VNodeNormalizedChildren = string | VNodeArrayChildren | RawSlots | null;
- declare type VNodeNormalizedRef = VNodeNormalizedRefAtom | (VNodeNormalizedRefAtom)[];
- declare type VNodeNormalizedRefAtom = {
- i: ComponentInternalInstance;
- r: VNodeRef;
- };
- export declare type VNodeProps = {
- key?: string | number;
- ref?: VNodeRef;
- onVnodeBeforeMount?: VNodeMountHook | VNodeMountHook[];
- onVnodeMounted?: VNodeMountHook | VNodeMountHook[];
- onVnodeBeforeUpdate?: VNodeUpdateHook | VNodeUpdateHook[];
- onVnodeUpdated?: VNodeUpdateHook | VNodeUpdateHook[];
- onVnodeBeforeUnmount?: VNodeMountHook | VNodeMountHook[];
- onVnodeUnmounted?: VNodeMountHook | VNodeMountHook[];
- };
- declare type VNodeRef = string | Ref | ((ref: object | null, refs: Record<string, any>) => void);
- export declare type VNodeTypes = string | VNode | Component | typeof Text_2 | typeof Static | typeof Comment_2 | typeof Fragment | typeof TeleportImpl | typeof SuspenseImpl;
- declare type VNodeUpdateHook = (vnode: VNode, oldVNode: VNode) => void;
- export declare function warn(msg: string, ...args: any[]): void;
- export declare function watch<T extends MultiWatchSources, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T, false>, MapSources<T, Immediate>>, options?: WatchOptions<Immediate>): WatchStopHandle;
- export declare function watch<T extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<MapSources<T, false>, MapSources<T, Immediate>>, options?: WatchOptions<Immediate>): WatchStopHandle;
- export declare function watch<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? (T | undefined) : T>, options?: WatchOptions<Immediate>): WatchStopHandle;
- export declare function watch<T extends object, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<T, Immediate extends true ? (T | undefined) : T>, options?: WatchOptions<Immediate>): WatchStopHandle;
- export declare type WatchCallback<V = any, OV = any> = (value: V, oldValue: OV, onInvalidate: InvalidateCbRegistrator) => any;
- export declare type WatchEffect = (onInvalidate: InvalidateCbRegistrator) => void;
- export declare function watchEffect(effect: WatchEffect, options?: WatchOptionsBase): WatchStopHandle;
- declare type WatchOptionItem = string | WatchCallback | {
- handler: WatchCallback | string;
- } & WatchOptions;
- export declare interface WatchOptions<Immediate = boolean> extends WatchOptionsBase {
- immediate?: Immediate;
- deep?: boolean;
- }
- export declare interface WatchOptionsBase {
- flush?: 'pre' | 'post' | 'sync';
- onTrack?: ReactiveEffectOptions['onTrack'];
- onTrigger?: ReactiveEffectOptions['onTrigger'];
- }
- export declare type WatchSource<T = any> = Ref<T> | ComputedRef<T> | (() => T);
- export declare type WatchStopHandle = () => void;
- /**
- * Wrap a slot function to memoize current rendering instance
- * @private
- */
- export declare function withCtx(fn: Slot, ctx?: ComponentInternalInstance | null): Slot;
- /**
- * Adds directives to a VNode.
- */
- export declare function withDirectives<T extends VNode>(vnode: T, directives: DirectiveArguments): T;
- /**
- * @private
- */
- export declare function withScopeId(id: string): <T extends Function>(fn: T) => T;
- export { WritableComputedOptions }
- export { WritableComputedRef }
- export { }
- // Note: this file is auto concatenated to the end of the bundled d.ts during
- // build.
- declare module '@vue/reactivity' {
- export interface RefUnwrapBailTypes {
- runtimeCoreBailTypes:
- | VNode
- | {
- // directly bailing on ComponentPublicInstance results in recursion
- // so we use this as a bail hint
- $: ComponentInternalInstance
- }
- }
- }
|