ngx-ui-tour-core - npm Package Compare versions

Comparing version 9.2.1 to 10.0.0

lib/tour-hotkey-listener.component.d.ts

@@ -13,3 +13,3 @@ import { TourService } from './tour.service';
     static ɵfac: i0.ɵɵFactoryDeclaration<TourHotkeyListenerComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<TourHotkeyListenerComponent, "tour-hotkey-listener", never, {}, {}, never, ["*"], false>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<TourHotkeyListenerComponent, "tour-hotkey-listener", never, {}, {}, never, ["*"], true, never>;
 }

lib/tour.service.d.ts

@@ -1,7 +0,5 @@
-import { RendererFactory2 } from '@angular/core';
 import type { UrlSegment } from '@angular/router';
-import { Router } from '@angular/router';
 import { TourAnchorDirective } from './tour-anchor.directive';
 import { Observable, Subject } from 'rxjs';
-import { BackdropConfig, TourBackdropService } from './tour-backdrop.service';
+import { BackdropConfig } from './tour-backdrop.service';
 import * as i0 from "@angular/core";
@@ -26,3 +24,5 @@ export interface IStepOption {
     delayAfterNavigation?: number;
+    delayBeforeStepShow?: number;
     nextOnAnchorClick?: boolean;
+    duplicateAnchorHandling?: 'error' | 'registerFirst' | 'registerLast';
 }
@@ -34,8 +34,13 @@ export declare enum TourState {
 }
+export declare enum Direction {
+    Forwards = 0,
+    Backwards = 1
+}
+export interface StepChangeParams<T extends IStepOption = IStepOption> {
+    step: T;
+    direction: Direction;
+}
 export declare class TourService<T extends IStepOption = IStepOption> {
-    private readonly router;
-    private readonly rendererFactory;
-    private readonly backdrop;
-    stepShow$: Subject<T>;
-    stepHide$: Subject<T>;
+    stepShow$: Subject<StepChangeParams<T>>;
+    stepHide$: Subject<StepChangeParams<T>>;
     initialize$: Subject<T[]>;
@@ -60,6 +65,7 @@ start$: Subject<void>;
     private direction;
-    private unListenNextOnAnchorClickFn;
-    private renderer;
-    constructor(router: Router, rendererFactory: RendererFactory2, backdrop: TourBackdropService);
+    private readonly router;
+    private readonly backdrop;
+    private readonly anchorClickService;
     initialize(steps: T[], stepDefaults?: T): void;
+    private validateSteps;
     private subscribeToNavigationStartEvent;
@@ -82,2 +88,3 @@ disableHotkeys(): void;
     register(anchorId: string, anchor: TourAnchorDirective): void;
+    private findStepByAnchorId;
     unregister(anchorId: string): void;
@@ -87,3 +94,2 @@ getStatus(): TourState;
     private goToStep;
-    private removeLastAnchorClickListener;
     private listenToOnAnchorClick;
@@ -90,0 +96,0 @@ private navigateToRouteAndSetStep;

package.json

 {
   "name": "ngx-ui-tour-core",
-  "version": "9.2.1",
+  "version": "10.0.0",
   "description": "UI tour library for Angular 12+",
@@ -18,6 +18,6 @@ "keywords": [
   "peerDependencies": {
-    "@angular/common": "^14.0.0",
-    "@angular/core": "^14.0.0",
-    "@angular/router": "^14.0.0",
-    "rxjs": ">=6.0.0",
+    "@angular/common": "^15.0.0",
+    "@angular/core": "^15.0.0",
+    "@angular/router": "^15.0.0",
+    "rxjs": "^7.4.0",
     "typescript": ">=3.8.0"
@@ -24,0 +24,0 @@ },

projects/ngx-ui-tour-core/CHANGELOG.md

@@ -0,1 +1,27 @@
+<a name="10.0.0"></a>
+
+# [10.0.0](https://github.com/hakimio/ngx-ui-tour) (2023-01-10)
+
+### Features
+- Support for Angular 15
+- New `delayBeforeStepShow` config to add delay before showing tour step
+- New `duplicateAnchorHandling` config to customize how duplicate anchor elements should be handled
+- All components and directives are now provided as `standalone`. This allows importing only the components you are 
+  using (ie `TourAnchorMatMenuDirective` or `TourStepTemplateComponent`) and use anchor directive as host directive.
+- `stepShow$` and `stepHide$` event payloads now include tour direction indicating if the user pressed "Next" or 
+  "Prev" button.
+
+### Fixes
+- Fragments/anchors ("foo#bar") are no longer ignored in `route` step config.
+- `prevStep` and `nextStep` configs can now be set to step index "zero".
+
+### Breaking changes
+- `TourModule.forRoot()` method was removed since all services are now provided in "root". Now only the tour module 
+  itself has to be imported.
+- Angular 14 is no longer supported.
+- RxJS v6 is no longer supported.
+- `stepShow$` and `stepHide$` event payloads have changed.
+- Steps marked as both `async` and `optional` at the same time will now throw an error since this option combination 
+is not supported by the library.
+
 <a name="9.2.1"></a>
@@ -2,0 +28,0 @@

public_api.d.ts

@@ -1,3 +0,2 @@
-export { TourModule, TourService, TourBackdropService, BackdropConfig } from './lib/tour.module';
-export { IStepOption, TourState } from './lib/tour.service';
+export { IStepOption, TourState, TourService, Direction, StepChangeParams } from './lib/tour.service';
 export { TourAnchorDirective } from './lib/tour-anchor.directive';
@@ -7,1 +6,2 @@ export { TourHotkeyListenerComponent } from './lib/tour-hotkey-listener.component';
 export { ScrollingUtil } from './lib/scrolling-util';
+export { TourBackdropService, BackdropConfig } from './lib/tour-backdrop.service';

README.md

@@ -5,3 +5,3 @@ ![Ngx UI Tour](https://user-images.githubusercontent.com/768105/130578626-8b6cbefb-217c-4943-8661-22459a7b67a3.png)
 
-Angular Material, Taiga UI, Ng Bootstrap and Ngx Bootstrap UIs are supported.
+Angular Material, Ionic, Taiga UI, Ng Bootstrap and Ngx Bootstrap UIs are supported.
 
@@ -42,2 +42,3 @@ `ngx-ui-tour` is a fork of __Isaac Mann's__ `ngx-tour`. The project had to be forked since the original is no longer
 |---------|------|-------------|
+| 15      | 7    | 10          |
 | 14      | 6, 7 | 9           |
@@ -51,2 +52,3 @@ | 12-13   | 6, 7 | 8           |
 |---------|------|-------------|
+| 15      | 7    | 12          |
 | 14      | 6, 7 | 11          |
@@ -56,2 +58,8 @@ | 12-13   | 6, 7 | 10          |
 
+### Ionic tour UI
+
+| Angular | RxJS | Ionic | ngx-ui-tour |
+|---------|------|-------|-------------|
+| 15      | 7    | 6     | 1           |
+
 ### Taiga UI tour UI
@@ -61,2 +69,3 @@
 |---------|------|----------|-------------|
+| 15      | 7    | 3        | 4           |
 | 14      | 6, 7 | 3        | 3           |
@@ -69,2 +78,3 @@ | 12-13   | 6, 7 | 2        | 2           |
 - [Material Design UI](https://hakimio.github.io/ngx-ui-tour/md-menu/Setup)
+- [Ionic UI](https://hakimio.github.io/ngx-ui-tour/ion-popover/Setup)
 - [NG Bootstrap UI](https://hakimio.github.io/ngx-ui-tour/ng-bootstrap/Setup)
@@ -71,0 +81,0 @@ - [Ngx Bootstrap UI](https://hakimio.github.io/ngx-ui-tour/ngx-bootstrap/Setup)

No alert changes

Improved metrics

Total package byte prevSize

256459

increased by2.89%

Lines of code

1962

increased by3.37%

Number of lines in readme file

115

increased by9.52%

No dependency changes