cb-tour-guide
Version:
Guided tour for your Angular6+ applications.
189 lines • 11.7 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;
}
var Orientation = /** @class */ (function () {
function 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';
return Orientation;
}());
export { Orientation };
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} */
var ProgressIndicatorLocation = {
InsideNextButton: 'inside-next-button',
TopOfTourBlock: 'top-of-tour-block',
None: 'none',
Dots: 'dots',
};
export { ProgressIndicatorLocation };
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ3VpZGVkLXRvdXIuY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6Im5nOi8vY2ItdG91ci1ndWlkZS8iLCJzb3VyY2VzIjpbImxpYi9ndWlkZWQtdG91ci5jb25zdGFudHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7OztBQUNBLDhCQTZCQzs7O0lBNUJHLHdCQUFjOztJQUNkLHNDQUE0Qjs7SUFDNUIsZ0NBQXNCOztJQUN0QixnQ0FBc0I7O0lBQ3RCLGdDQUFzQjs7SUFDdEIsa0NBQXdCOztJQUN4Qiw0QkFBbUI7O0lBQ25CLHlCQUFlOzs7OztJQUVmLDRCQUFrQjs7Ozs7SUFFbEIseUJBQWU7Ozs7O0lBRWYsMkJBQWdCOzs7OztJQUVoQiwrQkFBdUQ7Ozs7O0lBRXZELDBCQUFvQjs7Ozs7SUFFcEIsK0JBQXlCOzs7OztJQUV6Qiw0QkFBbUI7Ozs7O0lBRW5CLG9DQUEwQjs7Ozs7SUFFMUIsdUNBQThCOzs7OztJQUU5QixvQ0FBMEI7Ozs7O0FBRzlCLGdDQTRCQzs7Ozs7O0lBMUJHLDRCQUFlOzs7OztJQUVmLDRCQUFpQjs7Ozs7SUFFakIsMkJBQWtCOztJQUNsQixrQ0FBaUU7O0lBQ2pFLGtDQUFpRTs7Ozs7SUFFakUsa0NBQStDOzs7OztJQUUvQyxzQ0FBOEI7Ozs7O0lBRTlCLHVDQUEyQjs7Ozs7SUFFM0Isa0NBS0M7Ozs7OztJQUtELGtEQUF1Qzs7SUFDdkMsd0NBQWdDOzs7OztBQUdwQyw4Q0FLQzs7Ozs7O0lBSEcsd0RBQWtDOzs7OztJQUVsQywrQ0FBcUI7O0FBR3pCO0lBQUE7SUFVQSxDQUFDO0lBVDBCLGtCQUFNLEdBQUcsUUFBUSxDQUFDO0lBQ2xCLHNCQUFVLEdBQUcsYUFBYSxDQUFDO0lBQzNCLHVCQUFXLEdBQUcsY0FBYyxDQUFDO0lBQzdCLGtCQUFNLEdBQUcsUUFBUSxDQUFDO0lBQ2xCLGdCQUFJLEdBQUcsTUFBTSxDQUFDO0lBQ2QsaUJBQUssR0FBRyxPQUFPLENBQUM7SUFDaEIsZUFBRyxHQUFHLEtBQUssQ0FBQztJQUNaLG1CQUFPLEdBQUcsVUFBVSxDQUFDO0lBQ3JCLG9CQUFRLEdBQUcsV0FBVyxDQUFDO0lBQ2xELGtCQUFDO0NBQUEsQUFWRCxJQVVDO1NBVlksV0FBVzs7O0lBQ3BCLG1CQUF5Qzs7SUFDekMsdUJBQWtEOztJQUNsRCx3QkFBb0Q7O0lBQ3BELG1CQUF5Qzs7SUFDekMsaUJBQXFDOztJQUNyQyxrQkFBdUM7O0lBQ3ZDLGdCQUFtQzs7SUFDbkMsb0JBQTRDOztJQUM1QyxxQkFBOEM7Ozs7SUFJOUMsa0JBQW1CLG9CQUFvQjtJQUN2QyxnQkFBaUIsbUJBQW1CO0lBQ3BDLE1BQU8sTUFBTTtJQUNiLE1BQU8sTUFBTSIsInNvdXJjZXNDb250ZW50IjpbIlxuZXhwb3J0IGludGVyZmFjZSBUb3VyU3RlcCB7XG4gICAgaWNvbj86IHN0cmluZyxcbiAgICBjb25uZWN0b3JEaXJlY3Rpb24/OiBzdHJpbmcsXG4gICAgbmV4dEJ0bkNsYXNzPzogc3RyaW5nLFxuICAgIGJhY2tCdG5DbGFzcz86IHN0cmluZyxcbiAgICBza2lwQnRuQ2xhc3M/OiBzdHJpbmcsXG4gICAgY29udGFpbmVyQ2xhc3M/OiBzdHJpbmcsXG4gICAgaXNNb2JpbGU/OiBib29sZWFuO1xuICAgIGNsYXNzPzogc3RyaW5nLFxuICAgIC8qKiBTZWxlY3RvciBmb3IgZWxlbWVudCB0aGF0IHdpbGwgYmUgaGlnaGxpZ2h0ZWQgKi9cbiAgICBzZWxlY3Rvcj86IHN0cmluZztcbiAgICAvKiogVG91ciB0aXRsZSB0ZXh0ICovXG4gICAgdGl0bGU/OiBzdHJpbmc7XG4gICAgLyoqIFRvdXIgc3RlcCB0ZXh0ICovXG4gICAgY29udGVudDogc3RyaW5nO1xuICAgIC8qKiBXaGVyZSB0aGUgdG91ciBzdGVwIHdpbGwgYXBwZWFyIG5leHQgdG8gdGhlIHNlbGVjdGVkIGVsZW1lbnQgKi9cbiAgICBvcmllbnRhdGlvbj86IE9yaWVudGF0aW9uIHwgT3JpZW50YXRpb25Db25maWd1cmF0aW9uW107XG4gICAgLyoqIEFjdGlvbiB0aGF0IGhhcHBlbnMgd2hlbiB0aGUgc3RlcCBpcyBvcGVuZWQgKi9cbiAgICBhY3Rpb24/OiAoKSA9PiB2b2lkO1xuICAgIC8qKiBBY3Rpb24gdGhhdCBoYXBwZW5zIHdoZW4gdGhlIHN0ZXAgaXMgY2xvc2VkICovXG4gICAgY2xvc2VBY3Rpb24/OiAoKSA9PiB2b2lkO1xuICAgIC8qKiBTa2lwcyB0aGlzIHN0ZXAsIHRoaXMgaXMgc28geW91IGRvIG5vdCBoYXZlIGNyZWF0ZSBtdWx0aXBsZSB0b3VyIGNvbmZpZ3VyYXRpb25zIGJhc2VkIG9uIHVzZXIgc2V0dGluZ3MvY29uZmlndXJhdGlvbiAqL1xuICAgIHNraXBTdGVwPzogYm9vbGVhbjtcbiAgICAvKiogQWRkcyBzb21lIHBhZGRpbmcgZm9yIHRoaW5ncyBsaWtlIHN0aWNreSBoZWFkZXJzIHdoZW4gc2Nyb2xsaW5nIHRvIGFuIGVsZW1lbnQgKi9cbiAgICBzY3JvbGxBZGp1c3RtZW50PzogbnVtYmVyO1xuICAgIC8qKiBBZGRzIGRlZmF1bHQgcGFkZGluZyBhcm91bmQgdG91ciBoaWdobGlnaHRpbmcuIERvZXMgbm90IG5lZWQgdG8gYmUgdHJ1ZSBmb3IgaGlnaGxpZ2h0UGFkZGluZyB0byB3b3JrICovXG4gICAgdXNlSGlnaGxpZ2h0UGFkZGluZz86IGJvb2xlYW47XG4gICAgLyoqIEFkZHMgcGFkZGluZyBhcm91bmQgdG91ciBoaWdobGlnaHRpbmcgaW4gcGl4ZWxzLCB0aGlzIG92ZXJ3cml0ZXMgdGhlIGRlZmF1bHQgZm9yIHRoaXMgc3RlcC4gSXMgbm90IGRlcGVuZGVudCBvbiB1c2VIaWdobGlnaHRQYWRkaW5nIGJlaW5nIHRydWUgKi9cbiAgICBoaWdobGlnaHRQYWRkaW5nPzogbnVtYmVyO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIEd1aWRlZFRvdXIge1xuICAgIC8qKiBJZGVudGlmaWVyIGZvciB0b3VyICovXG4gICAgdG91cklkOiBzdHJpbmc7XG4gICAgLyoqIFVzZSBvcmIgdG8gc3RhcnQgdG91ciAqL1xuICAgIHVzZU9yYj86IGJvb2xlYW47XG4gICAgLyoqIFN0ZXBzIGZvIHRoZSB0b3VyICovXG4gICAgc3RlcHM6IFRvdXJTdGVwW107XG4gICAgbmV4dENhbGxiYWNrPzogKGN1cnJlbnRTdGVwOiBudW1iZXIsIHN0ZXBPYmplY3Q6IG9iamVjdCkgPT4gdm9pZDtcbiAgICBwcmV2Q2FsbGJhY2s/OiAoY3VycmVudFN0ZXA6IG51bWJlciwgc3RlcE9iamVjdDogb2JqZWN0KSA9PiB2b2lkO1xuICAgIC8qKiBGdW5jdGlvbiB3aWxsIGJlIGNhbGxlZCB3aGVuIHRvdXIgaXMgc2tpcHBlZCAqL1xuICAgIHNraXBDYWxsYmFjaz86IChzdGVwU2tpcHBlZE9uOiBudW1iZXIpID0+IHZvaWQ7XG4gICAgLyoqIEZ1bmN0aW9uIHdpbGwgYmUgY2FsbGVkIHdoZW4gdG91ciBpcyBjb21wbGV0ZWQgKi9cbiAgICBjb21wbGV0ZUNhbGxiYWNrPzogKCkgPT4gdm9pZDtcbiAgICAvKiogTWluaW11bSBzaXplIG9mIHNjcmVlbiBpbiBwaXhlbHMgYmVmb3JlIHRoZSB0b3VyIGlzIHJ1biwgaWYgdGhlIHRvdXIgaXMgcmVzaXplZCBiZWxvdyB0aGlzIHZhbHVlIHRoZSB1c2VyIHdpbGwgYmUgdG9sZCB0byByZXNpemUgKi9cbiAgICBtaW5pbXVtU2NyZWVuU2l6ZT86IG51bWJlcjtcbiAgICAvKiogRGlhbG9nIHNob3duIGlmIHRoZSB3aW5kb3cgd2lkdGggaXMgc21hbGxlciB0aGFuIHRoZSBkZWZpbmVkIG1pbmltdW0gc2NyZWVuIHNpemUuICovXG4gICAgcmVzaXplRGlhbG9nPzoge1xuICAgICAgICAvKiogUmVzaXplIGRpYWxvZyB0aXRsZSB0ZXh0ICovXG4gICAgICAgIHRpdGxlPzogc3RyaW5nO1xuICAgICAgICAvKiogUmVzaXplIGRpYWxvZyB0ZXh0ICovXG4gICAgICAgIGNvbnRlbnQ6IHN0cmluZztcbiAgICB9XG4gICAgLyoqXG4gICAgICogUHJldmVudHMgdGhlIHRvdXIgZnJvbSBhZHZhbmNpbmcgYnkgY2xpY2tpbmcgdGhlIGJhY2tkcm9wLlxuICAgICAqIFRoaXMgc2hvdWxkIG9ubHkgYmUgc2V0IGlmIHlvdSBhcmUgY29tcGxldGVseSBzdXJlIHlvdXIgdG91ciBpcyBkaXNwbGF5aW5nIGNvcnJlY3RseSBvbiBhbGwgc2NyZWVuIHNpemVzIG90aGVyd2lzZSBhIHVzZXIgY2FuIGdldCBzdHVjay5cbiAgICAgKi9cbiAgICBwcmV2ZW50QmFja2Ryb3BGcm9tQWR2YW5jaW5nPzogYm9vbGVhbjtcbiAgICBjbG9zZU1vZGFsQ2FsbGJhY2s/OiAoKSA9PiB2b2lkO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIE9yaWVudGF0aW9uQ29uZmlndXJhdGlvbiB7XG4gICAgLyoqIFdoZXJlIHRoZSB0b3VyIHN0ZXAgd2lsbCBhcHBlYXIgbmV4dCB0byB0aGUgc2VsZWN0ZWQgZWxlbWVudCAqL1xuICAgIG9yaWVudGF0aW9uRGlyZWN0aW9uOiBPcmllbnRhdGlvbjtcbiAgICAvKiogV2hlbiB0aGlzIG9yaWVudGF0aW9uIGNvbmZpZ3VyYXRpb24gc3RhcnRzIGluIHBpeGVscyAqL1xuICAgIG1heGltdW1TaXplPzogbnVtYmVyO1xufVxuXG5leHBvcnQgY2xhc3MgT3JpZW50YXRpb24ge1xuICAgIHB1YmxpYyBzdGF0aWMgcmVhZG9ubHkgQm90dG9tID0gJ2JvdHRvbSc7XG4gICAgcHVibGljIHN0YXRpYyByZWFkb25seSBCb3R0b21MZWZ0ID0gJ2JvdHRvbS1sZWZ0JztcbiAgICBwdWJsaWMgc3RhdGljIHJlYWRvbmx5IEJvdHRvbVJpZ2h0ID0gJ2JvdHRvbS1yaWdodCc7XG4gICAgcHVibGljIHN0YXRpYyByZWFkb25seSBDZW50ZXIgPSAnY2VudGVyJztcbiAgICBwdWJsaWMgc3RhdGljIHJlYWRvbmx5IExlZnQgPSAnbGVmdCc7XG4gICAgcHVibGljIHN0YXRpYyByZWFkb25seSBSaWdodCA9ICdyaWdodCc7XG4gICAgcHVibGljIHN0YXRpYyByZWFkb25seSBUb3AgPSAndG9wJztcbiAgICBwdWJsaWMgc3RhdGljIHJlYWRvbmx5IFRvcExlZnQgPSAndG9wLWxlZnQnO1xuICAgIHB1YmxpYyBzdGF0aWMgcmVhZG9ubHkgVG9wUmlnaHQgPSAndG9wLXJpZ2h0Jztcbn1cblxuZXhwb3J0IGVudW0gUHJvZ3Jlc3NJbmRpY2F0b3JMb2NhdGlvbiB7XG4gICAgSW5zaWRlTmV4dEJ1dHRvbiA9ICdpbnNpZGUtbmV4dC1idXR0b24nLFxuICAgIFRvcE9mVG91ckJsb2NrID0gJ3RvcC1vZi10b3VyLWJsb2NrJyxcbiAgICBOb25lID0gJ25vbmUnLFxuICAgIERvdHMgPSAnZG90cydcbn0gIFxuIl19