cb-tour-guide
Version:
Guided tour for your Angular6+ applications.
185 lines • 11.5 kB
JavaScript
/**
* @fileoverview added by tsickle
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* @record
*/
export function TourStep() { }
if (false) {
/** @type {?|undefined} */
TourStep.prototype.icon;
/** @type {?|undefined} */
TourStep.prototype.connectorDirection;
/** @type {?|undefined} */
TourStep.prototype.nextBtnClass;
/** @type {?|undefined} */
TourStep.prototype.backBtnClass;
/** @type {?|undefined} */
TourStep.prototype.skipBtnClass;
/** @type {?|undefined} */
TourStep.prototype.containerClass;
/** @type {?|undefined} */
TourStep.prototype.isMobile;
/** @type {?|undefined} */
TourStep.prototype.class;
/**
* Selector for element that will be highlighted
* @type {?|undefined}
*/
TourStep.prototype.selector;
/**
* Tour title text
* @type {?|undefined}
*/
TourStep.prototype.title;
/**
* Tour step text
* @type {?}
*/
TourStep.prototype.content;
/**
* Where the tour step will appear next to the selected element
* @type {?|undefined}
*/
TourStep.prototype.orientation;
/**
* Action that happens when the step is opened
* @type {?|undefined}
*/
TourStep.prototype.action;
/**
* Action that happens when the step is closed
* @type {?|undefined}
*/
TourStep.prototype.closeAction;
/**
* Skips this step, this is so you do not have create multiple tour configurations based on user settings/configuration
* @type {?|undefined}
*/
TourStep.prototype.skipStep;
/**
* Adds some padding for things like sticky headers when scrolling to an element
* @type {?|undefined}
*/
TourStep.prototype.scrollAdjustment;
/**
* Adds default padding around tour highlighting. Does not need to be true for highlightPadding to work
* @type {?|undefined}
*/
TourStep.prototype.useHighlightPadding;
/**
* Adds padding around tour highlighting in pixels, this overwrites the default for this step. Is not dependent on useHighlightPadding being true
* @type {?|undefined}
*/
TourStep.prototype.highlightPadding;
}
/**
* @record
*/
export function GuidedTour() { }
if (false) {
/**
* Identifier for tour
* @type {?}
*/
GuidedTour.prototype.tourId;
/**
* Use orb to start tour
* @type {?|undefined}
*/
GuidedTour.prototype.useOrb;
/**
* Steps fo the tour
* @type {?}
*/
GuidedTour.prototype.steps;
/** @type {?|undefined} */
GuidedTour.prototype.nextCallback;
/** @type {?|undefined} */
GuidedTour.prototype.prevCallback;
/**
* Function will be called when tour is skipped
* @type {?|undefined}
*/
GuidedTour.prototype.skipCallback;
/**
* Function will be called when tour is completed
* @type {?|undefined}
*/
GuidedTour.prototype.completeCallback;
/**
* 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
* @type {?|undefined}
*/
GuidedTour.prototype.minimumScreenSize;
/**
* Dialog shown if the window width is smaller than the defined minimum screen size.
* @type {?|undefined}
*/
GuidedTour.prototype.resizeDialog;
/**
* 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.
* @type {?|undefined}
*/
GuidedTour.prototype.preventBackdropFromAdvancing;
/** @type {?|undefined} */
GuidedTour.prototype.closeModalCallback;
}
/**
* @record
*/
export function OrientationConfiguration() { }
if (false) {
/**
* Where the tour step will appear next to the selected element
* @type {?}
*/
OrientationConfiguration.prototype.orientationDirection;
/**
* When this orientation configuration starts in pixels
* @type {?|undefined}
*/
OrientationConfiguration.prototype.maximumSize;
}
export class Orientation {
}
Orientation.Bottom = 'bottom';
Orientation.BottomLeft = 'bottom-left';
Orientation.BottomRight = 'bottom-right';
Orientation.Center = 'center';
Orientation.Left = 'left';
Orientation.Right = 'right';
Orientation.Top = 'top';
Orientation.TopLeft = 'top-left';
Orientation.TopRight = 'top-right';
if (false) {
/** @type {?} */
Orientation.Bottom;
/** @type {?} */
Orientation.BottomLeft;
/** @type {?} */
Orientation.BottomRight;
/** @type {?} */
Orientation.Center;
/** @type {?} */
Orientation.Left;
/** @type {?} */
Orientation.Right;
/** @type {?} */
Orientation.Top;
/** @type {?} */
Orientation.TopLeft;
/** @type {?} */
Orientation.TopRight;
}
/** @enum {string} */
const ProgressIndicatorLocation = {
InsideNextButton: 'inside-next-button',
TopOfTourBlock: 'top-of-tour-block',
None: 'none',
Dots: 'dots',
};
export { ProgressIndicatorLocation };
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ3VpZGVkLXRvdXIuY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6Im5nOi8vY2ItdG91ci1ndWlkZS8iLCJzb3VyY2VzIjpbImxpYi9ndWlkZWQtdG91ci5jb25zdGFudHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7OztBQUNBLDhCQTZCQzs7O0lBNUJHLHdCQUFjOztJQUNkLHNDQUE0Qjs7SUFDNUIsZ0NBQXNCOztJQUN0QixnQ0FBc0I7O0lBQ3RCLGdDQUFzQjs7SUFDdEIsa0NBQXdCOztJQUN4Qiw0QkFBbUI7O0lBQ25CLHlCQUFlOzs7OztJQUVmLDRCQUFrQjs7Ozs7SUFFbEIseUJBQWU7Ozs7O0lBRWYsMkJBQWdCOzs7OztJQUVoQiwrQkFBdUQ7Ozs7O0lBRXZELDBCQUFvQjs7Ozs7SUFFcEIsK0JBQXlCOzs7OztJQUV6Qiw0QkFBbUI7Ozs7O0lBRW5CLG9DQUEwQjs7Ozs7SUFFMUIsdUNBQThCOzs7OztJQUU5QixvQ0FBMEI7Ozs7O0FBRzlCLGdDQTRCQzs7Ozs7O0lBMUJHLDRCQUFlOzs7OztJQUVmLDRCQUFpQjs7Ozs7SUFFakIsMkJBQWtCOztJQUNsQixrQ0FBaUU7O0lBQ2pFLGtDQUFpRTs7Ozs7SUFFakUsa0NBQStDOzs7OztJQUUvQyxzQ0FBOEI7Ozs7O0lBRTlCLHVDQUEyQjs7Ozs7SUFFM0Isa0NBS0M7Ozs7OztJQUtELGtEQUF1Qzs7SUFDdkMsd0NBQWdDOzs7OztBQUdwQyw4Q0FLQzs7Ozs7O0lBSEcsd0RBQWtDOzs7OztJQUVsQywrQ0FBcUI7O0FBR3pCLE1BQU0sT0FBTyxXQUFXOztBQUNHLGtCQUFNLEdBQUcsUUFBUSxDQUFDO0FBQ2xCLHNCQUFVLEdBQUcsYUFBYSxDQUFDO0FBQzNCLHVCQUFXLEdBQUcsY0FBYyxDQUFDO0FBQzdCLGtCQUFNLEdBQUcsUUFBUSxDQUFDO0FBQ2xCLGdCQUFJLEdBQUcsTUFBTSxDQUFDO0FBQ2QsaUJBQUssR0FBRyxPQUFPLENBQUM7QUFDaEIsZUFBRyxHQUFHLEtBQUssQ0FBQztBQUNaLG1CQUFPLEdBQUcsVUFBVSxDQUFDO0FBQ3JCLG9CQUFRLEdBQUcsV0FBVyxDQUFDOzs7SUFSOUMsbUJBQXlDOztJQUN6Qyx1QkFBa0Q7O0lBQ2xELHdCQUFvRDs7SUFDcEQsbUJBQXlDOztJQUN6QyxpQkFBcUM7O0lBQ3JDLGtCQUF1Qzs7SUFDdkMsZ0JBQW1DOztJQUNuQyxvQkFBNEM7O0lBQzVDLHFCQUE4Qzs7OztJQUk5QyxrQkFBbUIsb0JBQW9CO0lBQ3ZDLGdCQUFpQixtQkFBbUI7SUFDcEMsTUFBTyxNQUFNO0lBQ2IsTUFBTyxNQUFNIiwic291cmNlc0NvbnRlbnQiOlsiXG5leHBvcnQgaW50ZXJmYWNlIFRvdXJTdGVwIHtcbiAgICBpY29uPzogc3RyaW5nLFxuICAgIGNvbm5lY3RvckRpcmVjdGlvbj86IHN0cmluZyxcbiAgICBuZXh0QnRuQ2xhc3M/OiBzdHJpbmcsXG4gICAgYmFja0J0bkNsYXNzPzogc3RyaW5nLFxuICAgIHNraXBCdG5DbGFzcz86IHN0cmluZyxcbiAgICBjb250YWluZXJDbGFzcz86IHN0cmluZyxcbiAgICBpc01vYmlsZT86IGJvb2xlYW47XG4gICAgY2xhc3M/OiBzdHJpbmcsXG4gICAgLyoqIFNlbGVjdG9yIGZvciBlbGVtZW50IHRoYXQgd2lsbCBiZSBoaWdobGlnaHRlZCAqL1xuICAgIHNlbGVjdG9yPzogc3RyaW5nO1xuICAgIC8qKiBUb3VyIHRpdGxlIHRleHQgKi9cbiAgICB0aXRsZT86IHN0cmluZztcbiAgICAvKiogVG91ciBzdGVwIHRleHQgKi9cbiAgICBjb250ZW50OiBzdHJpbmc7XG4gICAgLyoqIFdoZXJlIHRoZSB0b3VyIHN0ZXAgd2lsbCBhcHBlYXIgbmV4dCB0byB0aGUgc2VsZWN0ZWQgZWxlbWVudCAqL1xuICAgIG9yaWVudGF0aW9uPzogT3JpZW50YXRpb24gfCBPcmllbnRhdGlvbkNvbmZpZ3VyYXRpb25bXTtcbiAgICAvKiogQWN0aW9uIHRoYXQgaGFwcGVucyB3aGVuIHRoZSBzdGVwIGlzIG9wZW5lZCAqL1xuICAgIGFjdGlvbj86ICgpID0+IHZvaWQ7XG4gICAgLyoqIEFjdGlvbiB0aGF0IGhhcHBlbnMgd2hlbiB0aGUgc3RlcCBpcyBjbG9zZWQgKi9cbiAgICBjbG9zZUFjdGlvbj86ICgpID0+IHZvaWQ7XG4gICAgLyoqIFNraXBzIHRoaXMgc3RlcCwgdGhpcyBpcyBzbyB5b3UgZG8gbm90IGhhdmUgY3JlYXRlIG11bHRpcGxlIHRvdXIgY29uZmlndXJhdGlvbnMgYmFzZWQgb24gdXNlciBzZXR0aW5ncy9jb25maWd1cmF0aW9uICovXG4gICAgc2tpcFN0ZXA/OiBib29sZWFuO1xuICAgIC8qKiBBZGRzIHNvbWUgcGFkZGluZyBmb3IgdGhpbmdzIGxpa2Ugc3RpY2t5IGhlYWRlcnMgd2hlbiBzY3JvbGxpbmcgdG8gYW4gZWxlbWVudCAqL1xuICAgIHNjcm9sbEFkanVzdG1lbnQ/OiBudW1iZXI7XG4gICAgLyoqIEFkZHMgZGVmYXVsdCBwYWRkaW5nIGFyb3VuZCB0b3VyIGhpZ2hsaWdodGluZy4gRG9lcyBub3QgbmVlZCB0byBiZSB0cnVlIGZvciBoaWdobGlnaHRQYWRkaW5nIHRvIHdvcmsgKi9cbiAgICB1c2VIaWdobGlnaHRQYWRkaW5nPzogYm9vbGVhbjtcbiAgICAvKiogQWRkcyBwYWRkaW5nIGFyb3VuZCB0b3VyIGhpZ2hsaWdodGluZyBpbiBwaXhlbHMsIHRoaXMgb3ZlcndyaXRlcyB0aGUgZGVmYXVsdCBmb3IgdGhpcyBzdGVwLiBJcyBub3QgZGVwZW5kZW50IG9uIHVzZUhpZ2hsaWdodFBhZGRpbmcgYmVpbmcgdHJ1ZSAqL1xuICAgIGhpZ2hsaWdodFBhZGRpbmc/OiBudW1iZXI7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgR3VpZGVkVG91ciB7XG4gICAgLyoqIElkZW50aWZpZXIgZm9yIHRvdXIgKi9cbiAgICB0b3VySWQ6IHN0cmluZztcbiAgICAvKiogVXNlIG9yYiB0byBzdGFydCB0b3VyICovXG4gICAgdXNlT3JiPzogYm9vbGVhbjtcbiAgICAvKiogU3RlcHMgZm8gdGhlIHRvdXIgKi9cbiAgICBzdGVwczogVG91clN0ZXBbXTtcbiAgICBuZXh0Q2FsbGJhY2s/OiAoY3VycmVudFN0ZXA6IG51bWJlciwgc3RlcE9iamVjdDogb2JqZWN0KSA9PiB2b2lkO1xuICAgIHByZXZDYWxsYmFjaz86IChjdXJyZW50U3RlcDogbnVtYmVyLCBzdGVwT2JqZWN0OiBvYmplY3QpID0+IHZvaWQ7XG4gICAgLyoqIEZ1bmN0aW9uIHdpbGwgYmUgY2FsbGVkIHdoZW4gdG91ciBpcyBza2lwcGVkICovXG4gICAgc2tpcENhbGxiYWNrPzogKHN0ZXBTa2lwcGVkT246IG51bWJlcikgPT4gdm9pZDtcbiAgICAvKiogRnVuY3Rpb24gd2lsbCBiZSBjYWxsZWQgd2hlbiB0b3VyIGlzIGNvbXBsZXRlZCAqL1xuICAgIGNvbXBsZXRlQ2FsbGJhY2s/OiAoKSA9PiB2b2lkO1xuICAgIC8qKiBNaW5pbXVtIHNpemUgb2Ygc2NyZWVuIGluIHBpeGVscyBiZWZvcmUgdGhlIHRvdXIgaXMgcnVuLCBpZiB0aGUgdG91ciBpcyByZXNpemVkIGJlbG93IHRoaXMgdmFsdWUgdGhlIHVzZXIgd2lsbCBiZSB0b2xkIHRvIHJlc2l6ZSAqL1xuICAgIG1pbmltdW1TY3JlZW5TaXplPzogbnVtYmVyO1xuICAgIC8qKiBEaWFsb2cgc2hvd24gaWYgdGhlIHdpbmRvdyB3aWR0aCBpcyBzbWFsbGVyIHRoYW4gdGhlIGRlZmluZWQgbWluaW11bSBzY3JlZW4gc2l6ZS4gKi9cbiAgICByZXNpemVEaWFsb2c/OiB7XG4gICAgICAgIC8qKiBSZXNpemUgZGlhbG9nIHRpdGxlIHRleHQgKi9cbiAgICAgICAgdGl0bGU/OiBzdHJpbmc7XG4gICAgICAgIC8qKiBSZXNpemUgZGlhbG9nIHRleHQgKi9cbiAgICAgICAgY29udGVudDogc3RyaW5nO1xuICAgIH1cbiAgICAvKipcbiAgICAgKiBQcmV2ZW50cyB0aGUgdG91ciBmcm9tIGFkdmFuY2luZyBieSBjbGlja2luZyB0aGUgYmFja2Ryb3AuXG4gICAgICogVGhpcyBzaG91bGQgb25seSBiZSBzZXQgaWYgeW91IGFyZSBjb21wbGV0ZWx5IHN1cmUgeW91ciB0b3VyIGlzIGRpc3BsYXlpbmcgY29ycmVjdGx5IG9uIGFsbCBzY3JlZW4gc2l6ZXMgb3RoZXJ3aXNlIGEgdXNlciBjYW4gZ2V0IHN0dWNrLlxuICAgICAqL1xuICAgIHByZXZlbnRCYWNrZHJvcEZyb21BZHZhbmNpbmc/OiBib29sZWFuO1xuICAgIGNsb3NlTW9kYWxDYWxsYmFjaz86ICgpID0+IHZvaWQ7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgT3JpZW50YXRpb25Db25maWd1cmF0aW9uIHtcbiAgICAvKiogV2hlcmUgdGhlIHRvdXIgc3RlcCB3aWxsIGFwcGVhciBuZXh0IHRvIHRoZSBzZWxlY3RlZCBlbGVtZW50ICovXG4gICAgb3JpZW50YXRpb25EaXJlY3Rpb246IE9yaWVudGF0aW9uO1xuICAgIC8qKiBXaGVuIHRoaXMgb3JpZW50YXRpb24gY29uZmlndXJhdGlvbiBzdGFydHMgaW4gcGl4ZWxzICovXG4gICAgbWF4aW11bVNpemU/OiBudW1iZXI7XG59XG5cbmV4cG9ydCBjbGFzcyBPcmllbnRhdGlvbiB7XG4gICAgcHVibGljIHN0YXRpYyByZWFkb25seSBCb3R0b20gPSAnYm90dG9tJztcbiAgICBwdWJsaWMgc3RhdGljIHJlYWRvbmx5IEJvdHRvbUxlZnQgPSAnYm90dG9tLWxlZnQnO1xuICAgIHB1YmxpYyBzdGF0aWMgcmVhZG9ubHkgQm90dG9tUmlnaHQgPSAnYm90dG9tLXJpZ2h0JztcbiAgICBwdWJsaWMgc3RhdGljIHJlYWRvbmx5IENlbnRlciA9ICdjZW50ZXInO1xuICAgIHB1YmxpYyBzdGF0aWMgcmVhZG9ubHkgTGVmdCA9ICdsZWZ0JztcbiAgICBwdWJsaWMgc3RhdGljIHJlYWRvbmx5IFJpZ2h0ID0gJ3JpZ2h0JztcbiAgICBwdWJsaWMgc3RhdGljIHJlYWRvbmx5IFRvcCA9ICd0b3AnO1xuICAgIHB1YmxpYyBzdGF0aWMgcmVhZG9ubHkgVG9wTGVmdCA9ICd0b3AtbGVmdCc7XG4gICAgcHVibGljIHN0YXRpYyByZWFkb25seSBUb3BSaWdodCA9ICd0b3AtcmlnaHQnO1xufVxuXG5leHBvcnQgZW51bSBQcm9ncmVzc0luZGljYXRvckxvY2F0aW9uIHtcbiAgICBJbnNpZGVOZXh0QnV0dG9uID0gJ2luc2lkZS1uZXh0LWJ1dHRvbicsXG4gICAgVG9wT2ZUb3VyQmxvY2sgPSAndG9wLW9mLXRvdXItYmxvY2snLFxuICAgIE5vbmUgPSAnbm9uZScsXG4gICAgRG90cyA9ICdkb3RzJ1xufSAgXG4iXX0=