xdesign-vue-next/lib/guide/index.d.ts

XDesign Component for vue-next

import { TdGuideProps, GuideStep } from './type';
import './style';
export declare type TdGuideStepProps = GuideStep;
export * from './type';
export declare type GuideProps = TdGuideProps;
export declare const Guide: {
    new (...args: any[]): {
        $: import("vue").ComponentInternalInstance;
        $data: {};
        $props: {
            zIndex?: number;
            mode?: "dialog" | "popup";
            modelValue?: number;
            current?: number;
            showOverlay?: boolean;
            highlightPadding?: number;
            hideCounter?: boolean;
            hidePrev?: boolean;
            hideSkip?: boolean;
            key?: string | number | symbol;
            style?: unknown;
            readonly onChange?: (current: number, context?: {
                e: MouseEvent;
                total: number;
            }) => void;
            class?: unknown;
            ref?: import("vue").VNodeRef;
            ref_for?: boolean;
            ref_key?: string;
            readonly steps?: GuideStep[];
            onVnodeBeforeMount?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>) => void)[];
            onVnodeMounted?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>) => void)[];
            onVnodeBeforeUpdate?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>, oldVNode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>, oldVNode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>) => void)[];
            onVnodeUpdated?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>, oldVNode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>, oldVNode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>) => void)[];
            onVnodeBeforeUnmount?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>) => void)[];
            onVnodeUnmounted?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                [key: string]: any;
            }>) => void)[];
            readonly defaultCurrent?: number;
            readonly counter?: (h: typeof import("vue").h, props: {
                current: number;
                total: number;
            }) => import("..").SlotReturnValue;
            readonly finishButtonProps?: unknown;
            readonly nextButtonProps?: unknown;
            readonly prevButtonProps?: unknown;
            readonly skipButtonProps?: unknown;
            readonly onFinish?: (context: {
                e: MouseEvent;
                current: number;
                total: number;
            }) => void;
            readonly onNextStepClick?: (context: {
                e: MouseEvent;
                next: number;
                current: number;
                total: number;
            }) => void;
            readonly onPrevStepClick?: (context: {
                e: MouseEvent;
                prev: number;
                current: number;
                total: number;
            }) => void;
            readonly onSkip?: (context: {
                e: MouseEvent;
                current: number;
                total: number;
            }) => void;
        };
        $attrs: {
            [x: string]: unknown;
        };
        $refs: {
            [x: string]: unknown;
        };
        $slots: Readonly<{
            [name: string]: import("vue").Slot<any>;
        }>;
        $root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        $parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        $emit: (event: string, ...args: any[]) => void;
        $el: any;
        $options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
            counter: {
                type: import("vue").PropType<(h: typeof import("vue").h, props: {
                    current: number;
                    total: number;
                }) => import("..").SlotReturnValue>;
            };
            current: {
                type: NumberConstructor;
                default: any;
            };
            modelValue: {
                type: NumberConstructor;
                default: any;
            };
            defaultCurrent: {
                type: NumberConstructor;
            };
            finishButtonProps: {
                type: import("vue").PropType<import("..").TdButtonProps>;
            };
            hideCounter: BooleanConstructor;
            hidePrev: BooleanConstructor;
            hideSkip: BooleanConstructor;
            highlightPadding: {
                type: NumberConstructor;
                default: number;
            };
            mode: {
                type: import("vue").PropType<"dialog" | "popup">;
                default: "dialog" | "popup";
                validator(val: "dialog" | "popup"): boolean;
            };
            nextButtonProps: {
                type: import("vue").PropType<import("..").TdButtonProps>;
            };
            prevButtonProps: {
                type: import("vue").PropType<import("..").TdButtonProps>;
            };
            showOverlay: {
                type: BooleanConstructor;
                default: boolean;
            };
            skipButtonProps: {
                type: import("vue").PropType<import("..").TdButtonProps>;
            };
            steps: {
                type: import("vue").PropType<GuideStep[]>;
            };
            zIndex: {
                type: NumberConstructor;
                default: number;
            };
            onChange: import("vue").PropType<(current: number, context?: {
                e: MouseEvent;
                total: number;
            }) => void>;
            onFinish: import("vue").PropType<(context: {
                e: MouseEvent;
                current: number;
                total: number;
            }) => void>;
            onNextStepClick: import("vue").PropType<(context: {
                e: MouseEvent;
                next: number;
                current: number;
                total: number;
            }) => void>;
            onPrevStepClick: import("vue").PropType<(context: {
                e: MouseEvent;
                prev: number;
                current: number;
                total: number;
            }) => void>;
            onSkip: import("vue").PropType<(context: {
                e: MouseEvent;
                current: number;
                total: number;
            }) => void>;
        }>>, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
            zIndex: number;
            mode: "dialog" | "popup";
            modelValue: number;
            current: number;
            showOverlay: boolean;
            highlightPadding: number;
            hideCounter: boolean;
            hidePrev: boolean;
            hideSkip: boolean;
        }, {}, string, {}> & {
            beforeCreate?: (() => void) | (() => void)[];
            created?: (() => void) | (() => void)[];
            beforeMount?: (() => void) | (() => void)[];
            mounted?: (() => void) | (() => void)[];
            beforeUpdate?: (() => void) | (() => void)[];
            updated?: (() => void) | (() => void)[];
            activated?: (() => void) | (() => void)[];
            deactivated?: (() => void) | (() => void)[];
            beforeDestroy?: (() => void) | (() => void)[];
            beforeUnmount?: (() => void) | (() => void)[];
            destroyed?: (() => void) | (() => void)[];
            unmounted?: (() => void) | (() => void)[];
            renderTracked?: ((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[];
            renderTriggered?: ((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[];
            errorCaptured?: ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>, info: string) => boolean | void)[];
        };
        $forceUpdate: () => void;
        $nextTick: typeof import("vue").nextTick;
        $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (args_0: R, args_1: R) => any : (...args: any) => any, options?: import("vue").WatchOptions<boolean>): import("vue").WatchStopHandle;
    } & Readonly<import("vue").ExtractPropTypes<{
        counter: {
            type: import("vue").PropType<(h: typeof import("vue").h, props: {
                current: number;
                total: number;
            }) => import("..").SlotReturnValue>;
        };
        current: {
            type: NumberConstructor;
            default: any;
        };
        modelValue: {
            type: NumberConstructor;
            default: any;
        };
        defaultCurrent: {
            type: NumberConstructor;
        };
        finishButtonProps: {
            type: import("vue").PropType<import("..").TdButtonProps>;
        };
        hideCounter: BooleanConstructor;
        hidePrev: BooleanConstructor;
        hideSkip: BooleanConstructor;
        highlightPadding: {
            type: NumberConstructor;
            default: number;
        };
        mode: {
            type: import("vue").PropType<"dialog" | "popup">;
            default: "dialog" | "popup";
            validator(val: "dialog" | "popup"): boolean;
        };
        nextButtonProps: {
            type: import("vue").PropType<import("..").TdButtonProps>;
        };
        prevButtonProps: {
            type: import("vue").PropType<import("..").TdButtonProps>;
        };
        showOverlay: {
            type: BooleanConstructor;
            default: boolean;
        };
        skipButtonProps: {
            type: import("vue").PropType<import("..").TdButtonProps>;
        };
        steps: {
            type: import("vue").PropType<GuideStep[]>;
        };
        zIndex: {
            type: NumberConstructor;
            default: number;
        };
        onChange: import("vue").PropType<(current: number, context?: {
            e: MouseEvent;
            total: number;
        }) => void>;
        onFinish: import("vue").PropType<(context: {
            e: MouseEvent;
            current: number;
            total: number;
        }) => void>;
        onNextStepClick: import("vue").PropType<(context: {
            e: MouseEvent;
            next: number;
            current: number;
            total: number;
        }) => void>;
        onPrevStepClick: import("vue").PropType<(context: {
            e: MouseEvent;
            prev: number;
            current: number;
            total: number;
        }) => void>;
        onSkip: import("vue").PropType<(context: {
            e: MouseEvent;
            current: number;
            total: number;
        }) => void>;
    }>> & import("vue").ShallowUnwrapRef<() => JSX.Element> & {} & import("vue").ComponentCustomProperties & {};
    __isFragment?: never;
    __isTeleport?: never;
    __isSuspense?: never;
} & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
    counter: {
        type: import("vue").PropType<(h: typeof import("vue").h, props: {
            current: number;
            total: number;
        }) => import("..").SlotReturnValue>;
    };
    current: {
        type: NumberConstructor;
        default: any;
    };
    modelValue: {
        type: NumberConstructor;
        default: any;
    };
    defaultCurrent: {
        type: NumberConstructor;
    };
    finishButtonProps: {
        type: import("vue").PropType<import("..").TdButtonProps>;
    };
    hideCounter: BooleanConstructor;
    hidePrev: BooleanConstructor;
    hideSkip: BooleanConstructor;
    highlightPadding: {
        type: NumberConstructor;
        default: number;
    };
    mode: {
        type: import("vue").PropType<"dialog" | "popup">;
        default: "dialog" | "popup";
        validator(val: "dialog" | "popup"): boolean;
    };
    nextButtonProps: {
        type: import("vue").PropType<import("..").TdButtonProps>;
    };
    prevButtonProps: {
        type: import("vue").PropType<import("..").TdButtonProps>;
    };
    showOverlay: {
        type: BooleanConstructor;
        default: boolean;
    };
    skipButtonProps: {
        type: import("vue").PropType<import("..").TdButtonProps>;
    };
    steps: {
        type: import("vue").PropType<GuideStep[]>;
    };
    zIndex: {
        type: NumberConstructor;
        default: number;
    };
    onChange: import("vue").PropType<(current: number, context?: {
        e: MouseEvent;
        total: number;
    }) => void>;
    onFinish: import("vue").PropType<(context: {
        e: MouseEvent;
        current: number;
        total: number;
    }) => void>;
    onNextStepClick: import("vue").PropType<(context: {
        e: MouseEvent;
        next: number;
        current: number;
        total: number;
    }) => void>;
    onPrevStepClick: import("vue").PropType<(context: {
        e: MouseEvent;
        prev: number;
        current: number;
        total: number;
    }) => void>;
    onSkip: import("vue").PropType<(context: {
        e: MouseEvent;
        current: number;
        total: number;
    }) => void>;
}>>, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
    zIndex: number;
    mode: "dialog" | "popup";
    modelValue: number;
    current: number;
    showOverlay: boolean;
    highlightPadding: number;
    hideCounter: boolean;
    hidePrev: boolean;
    hideSkip: boolean;
}, {}, string, {}> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & import("vue").Plugin<any[]>;
export default Guide;