igot-cb-tour-guide/lib/guided-tour.constants.d.ts

Guided tour for your Angular6+ applications.

export interface TourStep {
    icon?: string;
    connectorDirection?: string;
    nextBtnClass?: string;
    backBtnClass?: string;
    skipBtnClass?: string;
    containerClass?: string;
    isMobile?: boolean;
    class?: string;
    /** Selector for element that will be highlighted */
    selector?: string;
    /** Tour title text */
    title?: string;
    /** Tour step text */
    content: string;
    /** Where the tour step will appear next to the selected element */
    orientation?: Orientation | OrientationConfiguration[];
    /** Action that happens when the step is opened */
    action?: () => void;
    /** Action that happens when the step is closed */
    closeAction?: () => void;
    /** Skips this step, this is so you do not have create multiple tour configurations based on user settings/configuration */
    skipStep?: boolean;
    /** Adds some padding for things like sticky headers when scrolling to an element */
    scrollAdjustment?: number;
    /** Adds default padding around tour highlighting. Does not need to be true for highlightPadding to work */
    useHighlightPadding?: boolean;
    /** Adds padding around tour highlighting in pixels, this overwrites the default for this step. Is not dependent on useHighlightPadding being true */
    highlightPadding?: number;
}
export interface GuidedTour {
    /** Identifier for tour */
    tourId: string;
    /** Use orb to start tour */
    useOrb?: boolean;
    /** Steps fo the tour */
    steps: TourStep[];
    nextCallback?: (currentStep: number, stepObject: object) => void;
    prevCallback?: (currentStep: number, stepObject: object) => void;
    /** Function will be called when tour is skipped */
    skipCallback?: (stepSkippedOn: number) => void;
    /** Function will be called when tour is completed */
    completeCallback?: () => void;
    /** Minimum size of screen in pixels before the tour is run, if the tour is resized below this value the user will be told to resize */
    minimumScreenSize?: number;
    /** Dialog shown if the window width is smaller than the defined minimum screen size. */
    resizeDialog?: {
        /** Resize dialog title text */
        title?: string;
        /** Resize dialog text */
        content: string;
    };
    /**
     * Prevents the tour from advancing by clicking the backdrop.
     * This should only be set if you are completely sure your tour is displaying correctly on all screen sizes otherwise a user can get stuck.
     */
    preventBackdropFromAdvancing?: boolean;
}
export interface OrientationConfiguration {
    /** Where the tour step will appear next to the selected element */
    orientationDirection: Orientation;
    /** When this orientation configuration starts in pixels */
    maximumSize?: number;
}
export declare class Orientation {
    static readonly Bottom = "bottom";
    static readonly BottomLeft = "bottom-left";
    static readonly BottomRight = "bottom-right";
    static readonly Center = "center";
    static readonly Left = "left";
    static readonly Right = "right";
    static readonly Top = "top";
    static readonly TopLeft = "top-left";
    static readonly TopRight = "top-right";
}
export declare enum ProgressIndicatorLocation {
    InsideNextButton = "inside-next-button",
    TopOfTourBlock = "top-of-tour-block",
    None = "none",
    Dots = "dots"
}