angular-custom-tour - npm Package Compare versions

Comparing version 0.0.11 to 0.0.12

package.json

@@ -8,3 +8,3 @@ {
   },
-  "version": "0.0.11",
+  "version": "0.0.12",
   "license": "MIT",
@@ -11,0 +11,0 @@ "main": "bundles/angular-custom-tour.umd.min.js",

README.md

@@ -89,7 +89,3 @@ [![Build Status](https://img.shields.io/travis/miraxes/angular-custom-tour.svg?style=flat-square)](https://travis-ci.org/miraxes/angular-custom-tour)
   startTour() {
-    let hOpt = new HintOptions();
-
-    hOpt.elementsDisabled = false; //change whatever you want
-
-    this.hintService.initialize(hOpt);
+    this.hintService.initialize({elementsDisabled: false}); // HintOptions
   }
@@ -100,3 +96,3 @@
 
-Colons can be used to align columns.
+## HintOptions
 
@@ -106,2 +102,3 @@ | option                     | default   | Usage  |
 | elementsDisabled: boolean  | true      | Disabling highlightedElement (click) wont work|
+| dismissOnOverlay: boolean  | false     | Go to next step when clicking on overlay (close tour if this is last step)|
 | defaultPosition: string    | 'bottom'  | Position of tour step to highlightedElement |
@@ -108,0 +105,0 @@ | defaultOrder: number       | 99        | Order of showing steps |

src/hint.component.d.ts

@@ -6,2 +6,3 @@ import { HintService } from './hint.service';
     constructor(hintService: HintService);
+    dismiss(): void;
 }

src/hint.component.js

@@ -19,6 +19,9 @@ "use strict";
     }
+    HintComponent.prototype.dismiss = function () {
+        this.hintService.overlayNext();
+    };
     HintComponent = __decorate([
         core_1.Component({
             selector: 'tour-overlay',
-            template: "<div class=\"hint-overlay\" *ngIf=\"show\"></div>",
+            template: "<div class=\"hint-overlay\" *ngIf=\"show\" (click)=\"dismiss()\"></div>",
         }), 
@@ -25,0 +28,0 @@ __metadata('design:paramtypes', [hint_service_1.HintService])

src/hint.service.d.ts

@@ -36,2 +36,7 @@ import { Subject } from 'rxjs/Subject';
     /**
+     * On overlay click behaviour
+     * @method overlayNext
+     */
+    overlayNext(): void;
+    /**
      * Show step previous to {Step} this.currentStep
@@ -38,0 +43,0 @@ * @method showPrev

src/hint.service.js

@@ -59,2 +59,15 @@ "use strict";
     /**
+     * On overlay click behaviour
+     * @method overlayNext
+     */
+    HintService.prototype.overlayNext = function () {
+        if (this.hasNext()) {
+            this.anchors[this.currentStep.selector].hideStep();
+            this.showNext();
+        }
+        else {
+            this.end();
+        }
+    };
+    /**
      * Show step previous to {Step} this.currentStep
@@ -61,0 +74,0 @@ * @method showPrev

src/options.d.ts

@@ -8,2 +8,3 @@ export declare class HintOptions {
     stepTag?: string;
+    dismissOnOverlay?: boolean;
 }

src/options.js

@@ -11,2 +11,3 @@ "use strict";
         this.stepTag = variables_1.HintConfig.HINT_TAG;
+        this.dismissOnOverlay = variables_1.HintConfig.DISMISS_ON_OVERLAY;
     }
@@ -13,0 +14,0 @@ return HintOptions;

src/variables.d.ts

@@ -8,2 +8,3 @@ export declare const HintConfig: {
     APPLY_RELATIVE: boolean;
+    DISMISS_ON_OVERLAY: boolean;
 };

src/variables.js

@@ -10,3 +10,4 @@ "use strict";
     APPLY_RELATIVE: true,
+    DISMISS_ON_OVERLAY: false,
 };
 //# sourceMappingURL=variables.js.map

No alert changes

Improved metrics

Total package byte prevSize

39955

3.02%

Lines of code

734

3.67%

Worsened metrics

Number of lines in readme file

108

-2.7%

No dependency changes