@sdata/web-vue 1.19.0 → 2.1.1

package/es/tour/index.d.ts

@@ -0,0 +1,664 @@
+import type { App } from 'vue';
+import type { SDOptions } from '../_utils/types';
+import _Tour from './tour.vue';
+declare const Tour: {
+    new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("vue").ExtractPropTypes<{
+        visible: {
+            type: BooleanConstructor;
+            default: undefined;
+        };
+        defaultVisible: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        current: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        defaultCurrent: {
+            type: NumberConstructor;
+            default: number;
+        };
+        steps: {
+            type: import("vue").PropType<import("./types").TourStep[]>;
+            default: () => never[];
+        };
+        zIndex: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        animate: {
+            type: BooleanConstructor;
+            default: undefined;
+        };
+        allowClose: {
+            type: BooleanConstructor;
+            default: undefined;
+        };
+        allowKeyboardControl: {
+            type: BooleanConstructor;
+            default: undefined;
+        };
+        overlayClickBehavior: {
+            type: import("vue").PropType<import("./types").TourOverlayClickBehavior>;
+            default: undefined;
+        };
+        overlayOpacity: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        overlayColor: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        smoothScroll: {
+            type: BooleanConstructor;
+            default: undefined;
+        };
+        disableActiveInteraction: {
+            type: BooleanConstructor;
+            default: undefined;
+        };
+        showProgress: {
+            type: BooleanConstructor;
+            default: undefined;
+        };
+        stagePadding: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        stageRadius: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        popoverOffset: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        showButtons: {
+            type: import("vue").PropType<import("./types").TourAllowedButton[]>;
+            default: undefined;
+        };
+        disableButtons: {
+            type: import("vue").PropType<import("./types").TourAllowedButton[]>;
+            default: undefined;
+        };
+        prevBtnText: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        nextBtnText: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        doneBtnText: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        progressText: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        popoverClass: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        buttonProps: {
+            type: import("vue").PropType<import("./types").TourButtonProps>;
+            default: undefined;
+        };
+        onHighlightStarted: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+        onHighlighted: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+        onDeselected: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+        onDestroyed: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+        onDestroyStarted: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+        onPopoverRender: {
+            type: import("vue").PropType<(popover: import("./types").TourPopoverDom, options: {
+                config: import("./types").TourConfig;
+                state: import("./types").TourState;
+                controller: import("./types").TourController;
+            }) => void>;
+            default: undefined;
+        };
+        onNextClick: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+        onPrevClick: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+        onCloseClick: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+    }>> & Readonly<{
+        onChange?: ((current: number, previous: number) => any) | undefined;
+        onClose?: ((current: number | undefined) => any) | undefined;
+        "onUpdate:visible"?: ((visible: boolean) => any) | undefined;
+        "onUpdate:current"?: ((current: number) => any) | undefined;
+        onVisibleChange?: ((visible: boolean) => any) | undefined;
+    }>, import("./types").TourExpose, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+        change: (current: number, previous: number) => any;
+        close: (current: number | undefined) => any;
+        "update:visible": (visible: boolean) => any;
+        "update:current": (current: number) => any;
+        visibleChange: (visible: boolean) => any;
+    }, import("vue").PublicProps, {
+        visible: boolean;
+        animate: boolean;
+        buttonProps: Partial<Record<import("./types").TourButtonKind, import("..").ButtonProps>>;
+        zIndex: number;
+        defaultVisible: boolean;
+        steps: import("./types").TourStep[];
+        current: number;
+        defaultCurrent: number;
+        onNextClick: import("./types").TourStepHook;
+        onCloseClick: import("./types").TourStepHook;
+        allowClose: boolean;
+        allowKeyboardControl: boolean;
+        overlayClickBehavior: import("./types").TourOverlayClickBehavior;
+        overlayOpacity: number;
+        overlayColor: string;
+        smoothScroll: boolean;
+        disableActiveInteraction: boolean;
+        showProgress: boolean;
+        stagePadding: number;
+        stageRadius: number;
+        popoverOffset: number;
+        showButtons: import("./types").TourAllowedButton[];
+        disableButtons: import("./types").TourAllowedButton[];
+        prevBtnText: string;
+        nextBtnText: string;
+        doneBtnText: string;
+        progressText: string;
+        popoverClass: string;
+        onHighlightStarted: import("./types").TourStepHook;
+        onHighlighted: import("./types").TourStepHook;
+        onDeselected: import("./types").TourStepHook;
+        onDestroyed: import("./types").TourStepHook;
+        onDestroyStarted: import("./types").TourStepHook;
+        onPopoverRender: (popover: import("./types").TourPopoverDom, options: {
+            config: import("./types").TourConfig;
+            state: import("./types").TourState;
+            controller: import("./types").TourController;
+        }) => void;
+        onPrevClick: import("./types").TourStepHook;
+    }, true, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<import("vue").ExtractPropTypes<{
+        visible: {
+            type: BooleanConstructor;
+            default: undefined;
+        };
+        defaultVisible: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        current: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        defaultCurrent: {
+            type: NumberConstructor;
+            default: number;
+        };
+        steps: {
+            type: import("vue").PropType<import("./types").TourStep[]>;
+            default: () => never[];
+        };
+        zIndex: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        animate: {
+            type: BooleanConstructor;
+            default: undefined;
+        };
+        allowClose: {
+            type: BooleanConstructor;
+            default: undefined;
+        };
+        allowKeyboardControl: {
+            type: BooleanConstructor;
+            default: undefined;
+        };
+        overlayClickBehavior: {
+            type: import("vue").PropType<import("./types").TourOverlayClickBehavior>;
+            default: undefined;
+        };
+        overlayOpacity: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        overlayColor: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        smoothScroll: {
+            type: BooleanConstructor;
+            default: undefined;
+        };
+        disableActiveInteraction: {
+            type: BooleanConstructor;
+            default: undefined;
+        };
+        showProgress: {
+            type: BooleanConstructor;
+            default: undefined;
+        };
+        stagePadding: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        stageRadius: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        popoverOffset: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        showButtons: {
+            type: import("vue").PropType<import("./types").TourAllowedButton[]>;
+            default: undefined;
+        };
+        disableButtons: {
+            type: import("vue").PropType<import("./types").TourAllowedButton[]>;
+            default: undefined;
+        };
+        prevBtnText: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        nextBtnText: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        doneBtnText: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        progressText: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        popoverClass: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        buttonProps: {
+            type: import("vue").PropType<import("./types").TourButtonProps>;
+            default: undefined;
+        };
+        onHighlightStarted: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+        onHighlighted: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+        onDeselected: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+        onDestroyed: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+        onDestroyStarted: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+        onPopoverRender: {
+            type: import("vue").PropType<(popover: import("./types").TourPopoverDom, options: {
+                config: import("./types").TourConfig;
+                state: import("./types").TourState;
+                controller: import("./types").TourController;
+            }) => void>;
+            default: undefined;
+        };
+        onNextClick: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+        onPrevClick: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+        onCloseClick: {
+            type: import("vue").PropType<import("./types").TourStepHook>;
+            default: undefined;
+        };
+    }>> & Readonly<{
+        onChange?: ((current: number, previous: number) => any) | undefined;
+        onClose?: ((current: number | undefined) => any) | undefined;
+        "onUpdate:visible"?: ((visible: boolean) => any) | undefined;
+        "onUpdate:current"?: ((current: number) => any) | undefined;
+        onVisibleChange?: ((visible: boolean) => any) | undefined;
+    }>, import("./types").TourExpose, {}, {}, {}, {
+        visible: boolean;
+        animate: boolean;
+        buttonProps: Partial<Record<import("./types").TourButtonKind, import("..").ButtonProps>>;
+        zIndex: number;
+        defaultVisible: boolean;
+        steps: import("./types").TourStep[];
+        current: number;
+        defaultCurrent: number;
+        onNextClick: import("./types").TourStepHook;
+        onCloseClick: import("./types").TourStepHook;
+        allowClose: boolean;
+        allowKeyboardControl: boolean;
+        overlayClickBehavior: import("./types").TourOverlayClickBehavior;
+        overlayOpacity: number;
+        overlayColor: string;
+        smoothScroll: boolean;
+        disableActiveInteraction: boolean;
+        showProgress: boolean;
+        stagePadding: number;
+        stageRadius: number;
+        popoverOffset: number;
+        showButtons: import("./types").TourAllowedButton[];
+        disableButtons: import("./types").TourAllowedButton[];
+        prevBtnText: string;
+        nextBtnText: string;
+        doneBtnText: string;
+        progressText: string;
+        popoverClass: string;
+        onHighlightStarted: import("./types").TourStepHook;
+        onHighlighted: import("./types").TourStepHook;
+        onDeselected: import("./types").TourStepHook;
+        onDestroyed: import("./types").TourStepHook;
+        onDestroyStarted: import("./types").TourStepHook;
+        onPopoverRender: (popover: import("./types").TourPopoverDom, options: {
+            config: import("./types").TourConfig;
+            state: import("./types").TourState;
+            controller: import("./types").TourController;
+        }) => void;
+        onPrevClick: import("./types").TourStepHook;
+    }>;
+    __isFragment?: never;
+    __isTeleport?: never;
+    __isSuspense?: never;
+} & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
+    visible: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    defaultVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    current: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    defaultCurrent: {
+        type: NumberConstructor;
+        default: number;
+    };
+    steps: {
+        type: import("vue").PropType<import("./types").TourStep[]>;
+        default: () => never[];
+    };
+    zIndex: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    animate: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    allowClose: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    allowKeyboardControl: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    overlayClickBehavior: {
+        type: import("vue").PropType<import("./types").TourOverlayClickBehavior>;
+        default: undefined;
+    };
+    overlayOpacity: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    overlayColor: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    smoothScroll: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    disableActiveInteraction: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    showProgress: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    stagePadding: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    stageRadius: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    popoverOffset: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    showButtons: {
+        type: import("vue").PropType<import("./types").TourAllowedButton[]>;
+        default: undefined;
+    };
+    disableButtons: {
+        type: import("vue").PropType<import("./types").TourAllowedButton[]>;
+        default: undefined;
+    };
+    prevBtnText: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    nextBtnText: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    doneBtnText: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    progressText: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    popoverClass: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    buttonProps: {
+        type: import("vue").PropType<import("./types").TourButtonProps>;
+        default: undefined;
+    };
+    onHighlightStarted: {
+        type: import("vue").PropType<import("./types").TourStepHook>;
+        default: undefined;
+    };
+    onHighlighted: {
+        type: import("vue").PropType<import("./types").TourStepHook>;
+        default: undefined;
+    };
+    onDeselected: {
+        type: import("vue").PropType<import("./types").TourStepHook>;
+        default: undefined;
+    };
+    onDestroyed: {
+        type: import("vue").PropType<import("./types").TourStepHook>;
+        default: undefined;
+    };
+    onDestroyStarted: {
+        type: import("vue").PropType<import("./types").TourStepHook>;
+        default: undefined;
+    };
+    onPopoverRender: {
+        type: import("vue").PropType<(popover: import("./types").TourPopoverDom, options: {
+            config: import("./types").TourConfig;
+            state: import("./types").TourState;
+            controller: import("./types").TourController;
+        }) => void>;
+        default: undefined;
+    };
+    onNextClick: {
+        type: import("vue").PropType<import("./types").TourStepHook>;
+        default: undefined;
+    };
+    onPrevClick: {
+        type: import("vue").PropType<import("./types").TourStepHook>;
+        default: undefined;
+    };
+    onCloseClick: {
+        type: import("vue").PropType<import("./types").TourStepHook>;
+        default: undefined;
+    };
+}>> & Readonly<{
+    onChange?: ((current: number, previous: number) => any) | undefined;
+    onClose?: ((current: number | undefined) => any) | undefined;
+    "onUpdate:visible"?: ((visible: boolean) => any) | undefined;
+    "onUpdate:current"?: ((current: number) => any) | undefined;
+    onVisibleChange?: ((visible: boolean) => any) | undefined;
+}>, import("./types").TourExpose, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    change: (current: number, previous: number) => any;
+    close: (current: number | undefined) => any;
+    "update:visible": (visible: boolean) => any;
+    "update:current": (current: number) => any;
+    visibleChange: (visible: boolean) => any;
+}, string, {
+    visible: boolean;
+    animate: boolean;
+    buttonProps: Partial<Record<import("./types").TourButtonKind, import("..").ButtonProps>>;
+    zIndex: number;
+    defaultVisible: boolean;
+    steps: import("./types").TourStep[];
+    current: number;
+    defaultCurrent: number;
+    onNextClick: import("./types").TourStepHook;
+    onCloseClick: import("./types").TourStepHook;
+    allowClose: boolean;
+    allowKeyboardControl: boolean;
+    overlayClickBehavior: import("./types").TourOverlayClickBehavior;
+    overlayOpacity: number;
+    overlayColor: string;
+    smoothScroll: boolean;
+    disableActiveInteraction: boolean;
+    showProgress: boolean;
+    stagePadding: number;
+    stageRadius: number;
+    popoverOffset: number;
+    showButtons: import("./types").TourAllowedButton[];
+    disableButtons: import("./types").TourAllowedButton[];
+    prevBtnText: string;
+    nextBtnText: string;
+    doneBtnText: string;
+    progressText: string;
+    popoverClass: string;
+    onHighlightStarted: import("./types").TourStepHook;
+    onHighlighted: import("./types").TourStepHook;
+    onDeselected: import("./types").TourStepHook;
+    onDestroyed: import("./types").TourStepHook;
+    onDestroyStarted: import("./types").TourStepHook;
+    onPopoverRender: (popover: import("./types").TourPopoverDom, options: {
+        config: import("./types").TourConfig;
+        state: import("./types").TourState;
+        controller: import("./types").TourController;
+    }) => void;
+    onPrevClick: import("./types").TourStepHook;
+}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+    $slots: {
+        default?: () => import("vue").VNodeChild;
+        title?: (props: {
+            step: import("./types").TourStep;
+            current: number | undefined;
+            title: string | undefined;
+            controller: import("./types").TourController;
+            state: import("./types").TourState;
+        }) => import("vue").VNodeChild;
+        description?: (props: {
+            step: import("./types").TourStep;
+            current: number | undefined;
+            description: string | undefined;
+            controller: import("./types").TourController;
+            state: import("./types").TourState;
+        }) => import("vue").VNodeChild;
+        progress?: (props: {
+            step: import("./types").TourStep;
+            current: number;
+            total: number;
+            text: string;
+            controller: import("./types").TourController;
+            state: import("./types").TourState;
+        }) => import("vue").VNodeChild;
+        footer?: (props: {
+            step: import("./types").TourStep;
+            current: number | undefined;
+            isFirst: boolean;
+            isLast: boolean;
+            moveNext: () => void;
+            movePrevious: () => void;
+            close: () => void;
+            controller: import("./types").TourController;
+            state: import("./types").TourState;
+        }) => import("vue").VNodeChild;
+        'previous-button'?: (props: {
+            step: import("./types").TourStep;
+            current: number | undefined;
+            text: string;
+            controller: import("./types").TourController;
+            state: import("./types").TourState;
+        }) => import("vue").VNodeChild;
+        'next-button'?: (props: {
+            step: import("./types").TourStep;
+            current: number | undefined;
+            isLast: boolean;
+            text: string;
+            controller: import("./types").TourController;
+            state: import("./types").TourState;
+        }) => import("vue").VNodeChild;
+        'close-button'?: (props: {
+            step: import("./types").TourStep;
+            current: number | undefined;
+            controller: import("./types").TourController;
+            state: import("./types").TourState;
+        }) => import("vue").VNodeChild;
+    };
+}) & {
+    install: (app: App, options?: SDOptions) => void;
+};
+export type TourInstance = InstanceType<typeof _Tour>;
+export type { TourAlignment, TourAllowedButton, TourController, TourConfig, TourExpose, TourPopover, TourProps, TourSide, TourState, TourStep, } from './types';
+export default Tour;

package/es/tour/index.js

@@ -0,0 +1,10 @@
+import { getComponentPrefix, setGlobalConfig } from "../_utils/global-config.js";
+import tour_default from "./tour.js";
+//#region components/tour/index.ts
+var Tour = Object.assign(tour_default, { install: (app, options) => {
+	setGlobalConfig(app, options);
+	const componentPrefix = getComponentPrefix(options);
+	app.component(componentPrefix + tour_default.name, tour_default);
+} });
+//#endregion
+export { Tour as default };

package/es/tour/style/css.js

@@ -0,0 +1 @@
+import "./index.css";