@luigi-project/core-modular 0.0.20-dev.202610260958 → 0.0.20-dev.202610270048

package/core-api/navigation.d.ts

@@ -10,6 +10,8 @@ export declare class Navigation {
     routingService: RoutingService;
     modalService: ModalService;
     options: NavigationOptions;
+    preventHistoryEntry: boolean;
+    preventContextUpdate: boolean;
     constructor(luigi: Luigi);
     navigate: (path: string, preserveView?: boolean, modalSettings?: ModalSettings, splitViewSettings?: any, drawerSettings?: any) => Promise<void>;
     /**
@@ -74,6 +76,22 @@ export declare class Navigation {
      * @returns {navigation} navigation instance
      */
     fromParent(): Navigation;
+    /**
+     * Sets options to customise route-changing behaviour. The options are used by the `navigate` function. Use it optionally in combination with any of the navigation functions.
+     * @param {Object} options - navigation options
+     * @param {boolean} options.preventHistoryEntry - by default, it is set to `false`. If it is set to `true`, there is no browser history being kept.
+     * @param {boolean} options.preventContextUpdate - by default, it is set to `false`. If it is set to `true`, there is no context update being triggered.
+     * @returns {Navigation} navigation instance
+     * @since NEXTRELEASE
+     * @example
+     * Luigi.navigation().withOptions(
+     *   { preventContextUpdate: true, preventHistoryEntry: true }
+     * ).navigate('/overview')
+     */
+    withOptions(options: {
+        preventHistoryEntry?: boolean;
+        preventContextUpdate?: boolean;
+    }): Navigation;
     withParams(nodeParams: Record<string, any>): Navigation;
     /**
      * Refreshes top navigation badge counters by rendering the navigation again.

package/luigi.js

@@ -9573,6 +9573,8 @@ var ui = {
 		fromParent: !1,
 		nodeParams: {}
 	};
+	preventHistoryEntry = !1;
+	preventContextUpdate = !1;
 	constructor(e) {
 		this.luigi = e, this.hashRouting = e.getConfig().routing?.useHashRouting, this.navService = W.get(vi), this.routingService = W.get(xi), this.modalService = W.get(hi);
 	}
@@ -9586,8 +9588,8 @@ var ui = {
 			options: this.options,
 			path: e,
 			preserveView: t,
-			preventContextUpdate: !1,
-			preventHistoryEntry: !1,
+			preventContextUpdate: this.preventContextUpdate,
+			preventHistoryEntry: this.preventHistoryEntry,
 			withoutSync: !1
 		};
 		return this.navService.handleNavigationRequest(o, void 0);
@@ -9661,6 +9663,9 @@ var ui = {
 	fromParent() {
 		return this.options.fromContext = null, this.options.fromClosestContext = !1, this.options.fromVirtualTreeRoot = !1, this.options.fromParent = !0, this;
 	}
+	withOptions(e) {
+		return a.isObject(e) && (e.preventHistoryEntry !== void 0 && (this.preventHistoryEntry = e.preventHistoryEntry), e.preventContextUpdate !== void 0 && (this.preventContextUpdate = e.preventContextUpdate)), this;
+	}
 	withParams(e) {
 		return e && Object.assign(this.options.nodeParams ?? {}, e), this;
 	}