@luigi-project/client 2.31.1-dev.20261010103 → 2.31.1-dev.20261020053

package/esm/luigi-client.d.mts

@@ -214,6 +214,29 @@ export declare interface UxManager {
    */
   getCurrentTheme: () => any;
 
+  /**
+   * Returns whether F6 fast navigation is enabled in the Luigi Core configuration (`settings.F6Navigation`).
+   * When `true`, a micro frontend should forward its F6 / Shift+F6 keydown events to Luigi Core so that focus can move out of the iframe to the next / previous page group.
+   * @returns {boolean} whether F6 fast navigation is enabled
+   * @memberof uxManager
+   * @since NEXTRELEASE
+   * @example LuigiClient.uxManager().isF6NavigationEnabled();
+   */
+  isF6NavigationEnabled: () => boolean;
+
+  /**
+   * Starts forwarding F6 / Shift+F6 keydown events from this micro frontend to Luigi Core, so that keyboard fast navigation can move focus out of the iframe to the next / previous page group.
+   * While focus is inside the iframe, the F6 keydown fires in the micro frontend's own document and never reaches Luigi Core; calling this method bridges those events. Forwarding only takes effect while core has fast navigation enabled (see {@link #isF6NavigationEnabled isF6NavigationEnabled()}), so it is safe to call unconditionally.
+   * @returns {function} a cleanup function that stops forwarding when called, e.g. on micro frontend teardown
+   * @memberof uxManager
+   * @since NEXTRELEASE
+   * @example
+   * const stopF6Forwarding = LuigiClient.uxManager().enableF6NavigationForwarding();
+   * // later, e.g. on teardown:
+   * stopF6Forwarding();
+   */
+  enableF6NavigationForwarding: () => () => void;
+
   /**
    * Sets current locale to the specified one.
    *

package/esm/luigi-client.mjs

@@ -1785,6 +1785,40 @@ class UxManager extends LuigiClientBase {
     return lifecycleManager$1.currentContext?.internal?.currentTheme;
   }
 
+  /**
+   * Returns whether F6 fast navigation is enabled in the Luigi Core configuration (`settings.F6Navigation`).
+   * When `true`, a micro frontend should forward its F6 / Shift+F6 keydown events to Luigi Core so that focus can move out of the iframe to the next / previous page group.
+   * @returns {boolean} whether F6 fast navigation is enabled
+   * @memberof uxManager
+   * @since NEXTRELEASE
+   * @example LuigiClient.uxManager().isF6NavigationEnabled();
+   */
+  isF6NavigationEnabled() {
+    return !!lifecycleManager$1.currentContext?.internal?.fastNavigation;
+  }
+
+  /**
+   * Starts forwarding F6 / Shift+F6 keydown events from this micro frontend to Luigi Core, so that keyboard fast navigation can move focus out of the iframe to the next / previous page group.
+   * While focus is inside the iframe, the F6 keydown fires in the micro frontend's own document and never reaches Luigi Core; calling this method bridges those events. Forwarding only takes effect while core has fast navigation enabled (see {@link #isF6NavigationEnabled isF6NavigationEnabled()}), so it is safe to call unconditionally.
+   * @returns {function} a cleanup function that stops forwarding when called, e.g. on micro frontend teardown
+   * @memberof uxManager
+   * @since NEXTRELEASE
+   * @example
+   * const stopF6Forwarding = LuigiClient.uxManager().enableF6NavigationForwarding();
+   * // later, e.g. on teardown:
+   * stopF6Forwarding();
+   */
+  enableF6NavigationForwarding() {
+    const handler = (e) => {
+      if (e.key === 'F6' && this.isF6NavigationEnabled()) {
+        e.preventDefault();
+        helpers.sendPostMessageToLuigiCore({ msg: 'luigi.fast-nav', shiftKey: e.shiftKey });
+      }
+    };
+    window.addEventListener('keydown', handler);
+    return () => window.removeEventListener('keydown', handler);
+  }
+
   /**
    * <!-- label-success: Web App API only  -->
    * Gets the CSS variables from Luigi Core with their key and value.