angular-shepherd/index.d.ts

An Angular wrapper for the site tour library Shepherd.

import { TourOptions, StepOptions, Tour } from 'shepherd.js';
import * as i0 from '@angular/core';

interface RequiredElement {
    message: string;
    selector: string;
    title: string;
}
declare class ShepherdService {
    confirmCancel: TourOptions['confirmCancel'];
    confirmCancelMessage?: TourOptions['confirmCancelMessage'];
    defaultStepOptions: StepOptions;
    errorTitle?: string;
    exitOnEsc: TourOptions['exitOnEsc'];
    isActive: boolean;
    keyboardNavigation: TourOptions['keyboardNavigation'];
    messageForUser: string | null;
    modal: boolean;
    requiredElements: Array<RequiredElement>;
    tourName: TourOptions['tourName'];
    tourObject: Tour | null;
    constructor();
    /**
     * Get the tour object and call back
     */
    back(): void;
    /**
     * Cancel the tour
     */
    cancel(): void;
    /**
     * Complete the tour
     */
    complete(): void;
    /**
     * Hides the current step
     */
    hide(): void;
    /**
     * Advance the tour to the next step
     */
    next(): void;
    /**
     * Show a specific step, by passing its id
     * @param id The id of the step you want to show
     */
    show(id: string | number): void;
    /**
     * Start the tour
     */
    start(): void;
    /**
     * This function is called when a tour is completed or cancelled to initiate cleanup.
     * @param completeOrCancel 'complete' or 'cancel'
     */
    onTourFinish(completeOrCancel: string): void;
    /**
     * Take a set of steps and create a tour object based on the current configuration
     * @param steps An array of steps
     */
    addSteps(steps: Array<StepOptions>): void;
    /**
     * Observes the array of requiredElements, which are the elements that must be present at the start of the tour,
     * and determines if they exist, and are visible, if either is false, it will stop the tour from executing.
     */
    private requiredElementsPresent;
    /**
     * Initializes the tour, creates a new Shepherd.Tour. sets options, and binds events
     */
    private _initialize;
    static ɵfac: i0.ɵɵFactoryDeclaration<ShepherdService, never>;
    static ɵprov: i0.ɵɵInjectableDeclaration<ShepherdService>;
}

export { ShepherdService };