@globalhive/vuejs-tour/dist/components/VTour.vue.d.ts

VueJS Tour is a lightweight, simple and customizable tour plugin. It provides a quick and easy way to guide your users through your application.

import { VTourProps, VTourData } from '../Types';
type LocalVTourProps = VTourProps & {
    restartOnPropChange?: boolean;
};
declare function __VLS_template(): {
    attrs: Partial<{}>;
    slots: {
        content?(_: {
            currentStepIndex: number;
            currentStepData: import('../Types').ITourStep;
        }): any;
        actions?(_: {
            lastStep: () => Promise<void>;
            nextStep: () => Promise<void>;
            endTour: () => void;
            getNextLabel: string;
            props: Readonly<{
                readonly steps: readonly import('../Types').ITourStep[];
                readonly buttonLabels: Partial<import('../Types').ButtonLabels>;
                readonly jumpOptions: Partial<import('../Types').JumpOptions>;
            }> & {
                readonly name: string;
                readonly backdrop: boolean;
                readonly autoStart: boolean;
                readonly startDelay: number;
                readonly highlight: boolean;
                readonly margin: number;
                readonly defaultPlacement: import('nanopop').NanoPopPosition;
                readonly saveToLocalStorage: import('../Types').SaveToLocalStorage;
                readonly hideSkip: boolean;
                readonly hideArrow: boolean;
                readonly noScroll: boolean;
                readonly resizeTimeout: number;
                readonly enableA11y: boolean;
                readonly keyboardNav: boolean;
                readonly ariaLabel: string;
                readonly teleportDelay: number;
                readonly restartOnPropChange: boolean;
            } & {
                readonly backdrop: boolean;
                readonly autoStart: boolean;
                readonly highlight: boolean;
                readonly hideSkip: boolean;
                readonly hideArrow: boolean;
                readonly noScroll: boolean;
                readonly enableA11y: boolean;
                readonly keyboardNav: boolean;
                readonly restartOnPropChange: boolean;
            };
            _CurrentStep: VTourData;
        }): any;
    };
    refs: {
        _Tooltip: HTMLDivElement;
    };
    rootEl: any;
};
type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
declare const __VLS_component: import('vue').DefineComponent<LocalVTourProps, {
    startTour: () => Promise<void>;
    nextStep: () => Promise<void>;
    lastStep: () => Promise<void>;
    endTour: () => void;
    stopTour: () => void;
    goToStep: (stepIndex: number) => Promise<void>;
    resetTour: (shouldRestart?: boolean) => void;
    updatePosition: () => Promise<void>;
    updateHighlight: () => void;
    updateBackdrop: () => void;
}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
    onTourStart: () => any;
    onTourEnd: () => any;
    onTourStep: (step: number) => any;
}, string, import('vue').PublicProps, Readonly<LocalVTourProps> & Readonly<{
    onOnTourStart?: (() => any) | undefined;
    onOnTourEnd?: (() => any) | undefined;
    onOnTourStep?: ((step: number) => any) | undefined;
}>, {
    readonly name: string;
    readonly backdrop: boolean;
    readonly autoStart: boolean;
    readonly startDelay: number;
    readonly highlight: boolean;
    readonly margin: number;
    readonly saveToLocalStorage: import('../Types').SaveToLocalStorage;
    readonly hideSkip: boolean;
    readonly hideArrow: boolean;
    readonly noScroll: boolean;
    readonly resizeTimeout: number;
    readonly defaultPlacement: import('nanopop').NanoPopPosition;
    readonly enableA11y: boolean;
    readonly keyboardNav: boolean;
    readonly ariaLabel: string;
    readonly teleportDelay: number;
    restartOnPropChange: boolean;
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
    _Tooltip: HTMLDivElement;
}, any>;
declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
export default _default;
type __VLS_WithTemplateSlots<T, S> = T & {
    new (): {
        $slots: S;
    };
};