hongluan-ui/lib/components/tour/index.d.ts

Hongluan Component Library for Vue 3

export declare const HlTour: import("hongluan-ui/es/utils").SFCWithInstall<import("vue").DefineComponent<{
    modelValue: BooleanConstructor;
    current: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
    showArrow: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
    showClose: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
    placement: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("@floating-ui/core").Placement>, "left" | "right" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end", unknown, string, boolean>;
    contentStyle: {
        readonly type: import("vue").PropType<unknown>;
        readonly required: false;
        readonly validator: (val: unknown) => boolean;
        __epPropKey: true;
    };
    mask: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("./src/types").TourMask>, unknown, unknown, boolean, boolean>;
    gap: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("./src/types").TourGap>, unknown, unknown, () => {
        offset: number;
        radius: number;
    }, boolean>;
    zIndex: {
        readonly type: import("vue").PropType<number>;
        readonly required: false;
        readonly validator: (val: unknown) => boolean;
        __epPropKey: true;
    };
    scrollIntoViewOptions: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<boolean | ScrollIntoViewOptions>, unknown, unknown, () => {
        block: string;
    }, boolean>;
    type: {
        readonly type: import("vue").PropType<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<"primary" | "default">, unknown, unknown>>;
        readonly required: false;
        readonly validator: (val: unknown) => boolean;
        __epPropKey: true;
    };
    appendTo: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<string | HTMLElement>, unknown, unknown, string, boolean>;
    closeOnPressEscape: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
    targetAreaClickable: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
}, {
    props: Readonly<import("@vue/shared").LooseRequired<Readonly<import("vue").ExtractPropTypes<{
        modelValue: BooleanConstructor;
        current: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
        showArrow: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
        showClose: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
        placement: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("@floating-ui/core").Placement>, "left" | "right" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end", unknown, string, boolean>;
        contentStyle: {
            readonly type: import("vue").PropType<unknown>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        mask: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("./src/types").TourMask>, unknown, unknown, boolean, boolean>;
        gap: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("./src/types").TourGap>, unknown, unknown, () => {
            offset: number;
            radius: number;
        }, boolean>;
        zIndex: {
            readonly type: import("vue").PropType<number>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        scrollIntoViewOptions: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<boolean | ScrollIntoViewOptions>, unknown, unknown, () => {
            block: string;
        }, boolean>;
        type: {
            readonly type: import("vue").PropType<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<"primary" | "default">, unknown, unknown>>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        appendTo: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<string | HTMLElement>, unknown, unknown, string, boolean>;
        closeOnPressEscape: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
        targetAreaClickable: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
    }>> & {
        onChange?: (current: number) => any;
        onClose?: (current: number) => any;
        "onUpdate:modelValue"?: (value: boolean) => any;
        onFinish?: () => any;
        "onUpdate:current"?: (current: number) => any;
    }>>;
    emit: ((event: "update:modelValue", value: boolean) => void) & ((event: "change", current: number) => void) & ((event: "close", current: number) => void) & ((event: "finish") => void) & ((event: "update:current", current: number) => void);
    namespace: import("vue").ComputedRef<string>;
    total: import("vue").Ref<number>;
    currentStep: import("vue").Ref<import("./src/step").TourStepProps>;
    current: import("vue").Ref<number> | import("vue").WritableComputedRef<number>;
    currentTarget: import("vue").ComputedRef<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<string | HTMLElement | (() => HTMLElement)>, unknown, unknown>>;
    kls: import("vue").ComputedRef<string[]>;
    mergedPlacement: import("vue").ComputedRef<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<import("@floating-ui/core").Placement>, "left" | "right" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end", unknown>>;
    mergedContentStyle: import("vue").ComputedRef<unknown>;
    mergedMask: import("vue").ComputedRef<unknown>;
    mergedShowMask: import("vue").ComputedRef<boolean>;
    mergedMaskStyle: import("vue").ComputedRef<unknown>;
    mergedShowArrow: import("vue").ComputedRef<import("hongluan-ui/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>>;
    mergedScrollIntoViewOptions: import("vue").ComputedRef<unknown>;
    mergedType: import("vue").ComputedRef<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<"primary" | "default">, unknown, unknown>>;
    nextZIndex: () => number;
    nowZIndex: number;
    mergedZIndex: import("vue").ComputedRef<number>;
    pos: import("vue").ComputedRef<import("./src/types").PosInfo>;
    triggerTarget: import("vue").ComputedRef<HTMLElement | {
        getBoundingClientRect(): DOMRect;
    }>;
    onEscClose: () => void;
    onUpdateTotal: (val: number) => void;
    slots: Readonly<{
        [name: string]: import("vue").Slot;
    }>;
    HlTourMask: import("vue").DefineComponent<{
        zIndex: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
        visible: BooleanConstructor;
        fill: import("hongluan-ui/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, string, boolean>;
        pos: {
            readonly type: import("vue").PropType<import("./src/types").PosInfo>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        targetAreaClickable: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
    }, {
        props: Readonly<import("@vue/shared").LooseRequired<Readonly<import("vue").ExtractPropTypes<{
            zIndex: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
            visible: BooleanConstructor;
            fill: import("hongluan-ui/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, string, boolean>;
            pos: {
                readonly type: import("vue").PropType<import("./src/types").PosInfo>;
                readonly required: false;
                readonly validator: (val: unknown) => boolean;
                __epPropKey: true;
            };
            targetAreaClickable: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
        }>> & {
            [x: string & `on${string}`]: ((...args: any[]) => any) | ((...args: unknown[]) => any);
        }>>;
        radius: import("vue").ComputedRef<number>;
        roundInfo: import("vue").ComputedRef<{
            topRight: string;
            bottomRight: string;
            bottomLeft: string;
            topLeft: string;
        }>;
        path: import("vue").ComputedRef<string>;
        pathStyle: import("vue").ComputedRef<import("vue").CSSProperties>;
    }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
        zIndex: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
        visible: BooleanConstructor;
        fill: import("hongluan-ui/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, string, boolean>;
        pos: {
            readonly type: import("vue").PropType<import("./src/types").PosInfo>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        targetAreaClickable: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
    }>>, {
        fill: string;
        zIndex: number;
        visible: boolean;
        targetAreaClickable: import("hongluan-ui/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
    }>;
    HlTourContent: import("vue").DefineComponent<{
        placement: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("@floating-ui/core").Placement>, "left" | "right" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end", unknown, string, boolean>;
        reference: {
            readonly type: import("vue").PropType<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<HTMLElement | import("@floating-ui/dom").VirtualElement>, unknown, unknown>>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        strategy: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("@floating-ui/core").Strategy>, "fixed" | "absolute", unknown, string, boolean>;
        offset: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
        showArrow: BooleanConstructor;
        zIndex: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
    }, {
        props: Readonly<import("@vue/shared").LooseRequired<Readonly<import("vue").ExtractPropTypes<{
            placement: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("@floating-ui/core").Placement>, "left" | "right" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end", unknown, string, boolean>;
            reference: {
                readonly type: import("vue").PropType<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<HTMLElement | import("@floating-ui/dom").VirtualElement>, unknown, unknown>>;
                readonly required: false;
                readonly validator: (val: unknown) => boolean;
                __epPropKey: true;
            };
            strategy: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("@floating-ui/core").Strategy>, "fixed" | "absolute", unknown, string, boolean>;
            offset: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
            showArrow: BooleanConstructor;
            zIndex: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
        }>> & {
            onClose?: () => any;
        }>>;
        emit: (event: "close") => void;
        placement: import("vue").Ref<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<import("@floating-ui/core").Placement>, "left" | "right" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end", unknown>>;
        strategy: import("vue").Ref<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<import("@floating-ui/core").Strategy>, "fixed" | "absolute", unknown>>;
        contentRef: import("vue").Ref<HTMLElement>;
        arrowRef: import("vue").Ref<HTMLElement>;
        contentStyle: import("vue").ComputedRef<import("vue").CSSProperties>;
        arrowStyle: import("vue").ComputedRef<import("vue").CSSProperties>;
        side: import("vue").ComputedRef<string>;
        onCloseRequested: () => void;
        onFocusoutPrevented: (event: CustomEvent<any>) => void;
        HlFocusTrap: import("vue").DefineComponent<{
            loop: BooleanConstructor;
            trapped: BooleanConstructor;
            focusTrapEl: import("vue").PropType<HTMLElement>;
            focusStartEl: {
                type: import("vue").PropType<HTMLElement | "first" | "container">;
                default: string;
            };
        }, {
            onKeydown: (e: KeyboardEvent) => void;
        }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("focusAfterTrapped" | "focusAfterReleased" | "focusin" | "focusout" | "focusout-prevented" | "release-requested")[], "focusAfterTrapped" | "focusAfterReleased" | "focusin" | "focusout" | "focusout-prevented" | "release-requested", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
            loop: BooleanConstructor;
            trapped: BooleanConstructor;
            focusTrapEl: import("vue").PropType<HTMLElement>;
            focusStartEl: {
                type: import("vue").PropType<HTMLElement | "first" | "container">;
                default: string;
            };
        }>> & {
            onFocusAfterReleased?: (...args: any[]) => any;
            onFocusAfterTrapped?: (...args: any[]) => any;
            onFocusin?: (...args: any[]) => any;
            onFocusout?: (...args: any[]) => any;
            "onFocusout-prevented"?: (...args: any[]) => any;
            "onRelease-requested"?: (...args: any[]) => any;
        }, {
            trapped: boolean;
            loop: boolean;
            focusStartEl: HTMLElement | "first" | "container";
        }>;
    }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
        close: () => boolean;
    }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
        placement: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("@floating-ui/core").Placement>, "left" | "right" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end", unknown, string, boolean>;
        reference: {
            readonly type: import("vue").PropType<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<HTMLElement | import("@floating-ui/dom").VirtualElement>, unknown, unknown>>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        strategy: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("@floating-ui/core").Strategy>, "fixed" | "absolute", unknown, string, boolean>;
        offset: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
        showArrow: BooleanConstructor;
        zIndex: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
    }>> & {
        onClose?: () => any;
    }, {
        zIndex: number;
        offset: number;
        placement: import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<import("@floating-ui/core").Placement>, "left" | "right" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end", unknown>;
        strategy: import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<import("@floating-ui/core").Strategy>, "fixed" | "absolute", unknown>;
        showArrow: boolean;
    }>;
    HlTourSteps: import("vue").DefineComponent<{
        current: {
            type: NumberConstructor;
            default: number;
        };
    }, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
        [key: string]: any;
    }>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update-total"[], "update-total", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
        current: {
            type: NumberConstructor;
            default: number;
        };
    }>> & {
        "onUpdate-total"?: (...args: any[]) => any;
    }, {
        current: number;
    }>;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
    "update:modelValue": (value: boolean) => boolean;
    "update:current": (current: number) => boolean;
    close: (current: number) => boolean;
    finish: () => boolean;
    change: (current: number) => boolean;
}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
    modelValue: BooleanConstructor;
    current: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
    showArrow: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
    showClose: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
    placement: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("@floating-ui/core").Placement>, "left" | "right" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end", unknown, string, boolean>;
    contentStyle: {
        readonly type: import("vue").PropType<unknown>;
        readonly required: false;
        readonly validator: (val: unknown) => boolean;
        __epPropKey: true;
    };
    mask: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("./src/types").TourMask>, unknown, unknown, boolean, boolean>;
    gap: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<import("./src/types").TourGap>, unknown, unknown, () => {
        offset: number;
        radius: number;
    }, boolean>;
    zIndex: {
        readonly type: import("vue").PropType<number>;
        readonly required: false;
        readonly validator: (val: unknown) => boolean;
        __epPropKey: true;
    };
    scrollIntoViewOptions: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<boolean | ScrollIntoViewOptions>, unknown, unknown, () => {
        block: string;
    }, boolean>;
    type: {
        readonly type: import("vue").PropType<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<"primary" | "default">, unknown, unknown>>;
        readonly required: false;
        readonly validator: (val: unknown) => boolean;
        __epPropKey: true;
    };
    appendTo: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<string | HTMLElement>, unknown, unknown, string, boolean>;
    closeOnPressEscape: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
    targetAreaClickable: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
}>> & {
    onChange?: (current: number) => any;
    onClose?: (current: number) => any;
    "onUpdate:modelValue"?: (value: boolean) => any;
    onFinish?: () => any;
    "onUpdate:current"?: (current: number) => any;
}, {
    gap: {
        offset: number;
        radius: number;
    };
    modelValue: boolean;
    scrollIntoViewOptions: {
        block: string;
    };
    placement: import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<import("@floating-ui/core").Placement>, "left" | "right" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end", unknown>;
    appendTo: import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<string | HTMLElement>, unknown, unknown>;
    mask: boolean;
    showArrow: import("hongluan-ui/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
    current: number;
    showClose: import("hongluan-ui/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
    closeOnPressEscape: import("hongluan-ui/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
    targetAreaClickable: import("hongluan-ui/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
}>> & Record<string, any>;
export default HlTour;
export * from './src/tour';
export * from './src/step';
export * from './src/content';
export type { TourMask, TourGap, TourBtnProps } from './src/types';