@sapui5/sap.ushell 1.140.0 → 1.141.0

package/src/main/js/sap/ushell/library.js

@@ -45,7 +45,7 @@ sap.ui.define([
     const oUshellLibrary = Library.init({
         name: "sap.ushell",
         apiVersion: 2,
-        version: "1.140.0",
+        version: "1.141.0",
         dependencies: [
             "sap.ui.core",
             "sap.m"

package/src/main/js/sap/ushell/modules/NavigationMenu/ListProvider.js

@@ -0,0 +1,56 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @file This is an empty wrapper for the ListProvider implementation to document the required interface
+ */
+sap.ui.define([
+], (
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.modules.NavigationMenu.ListProvider
+     * @class
+     * @description The required interface for a navigation menu list provider.
+     *
+     * @abstract
+     *
+     * @since 1.141.0
+     * @private
+     * @ui5-restricted SAL
+     */
+    class ListProvider {
+        /**
+         * @param {sap.ushell.modules.NavigationMenu.ListProviderAPI} oListProviderAPI - The API for the list provider
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        constructor (oListProviderAPI) {}
+
+        /**
+         * @returns {Promise<sap.tnt.NavigationList>} A promise that resolves to the root item of the navigation list.
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        async getRootItem () {
+            throw new Error("Method not implemented.");
+        }
+
+        /**
+         * @returns {Promise<string>} A promise that resolves to the selected key from the spaces.
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        async findSelectedKey () {
+            throw new Error("Method not implemented.");
+        }
+    }
+
+    return ListProvider;
+});

package/src/main/js/sap/ushell/modules/NavigationMenu/ListProviderAPI.js

@@ -0,0 +1,119 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @file This is an empty wrapper for the ListProviderAPI implementation to document the required interface
+ */
+sap.ui.define([
+], (
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.modules.NavigationMenu.ListProviderAPI
+     * @namespace
+     * @description The API for an navigation menu list provider.
+     * This module cannot be required it gets injected in the constructor of the ListProvider.
+     *
+     * @hideconstructor
+     *
+     * @since 1.141.0
+     * @private
+     * @ui5-restricted SAL
+     */
+    class ListProviderAPI {
+        /**
+         * Returns the configuration value for the provided path.
+         * The configuration path has to be provided in dot notation.
+         * The contents of the configuration have to be set with the setter methods in {@link sap.ushell.modules.NavigationMenu}.
+         * @param {string} sPath The configuration path to get the value for.
+         * @returns {any} The configuration value for the provided path.
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        getConfigValue (sPath) {
+            // eslint-disable-next-line no-constant-condition
+            if (false) {
+                return undefined; // allows to defined @returns type
+            }
+
+            throw new Error("Method not implemented.");
+        }
+
+        /**
+         * Returns the navigation container facade. With this a list provider can make updates in the surrounding NavContainer.
+         * @returns {sap.ushell.modules.NavigationMenu.NavContainer} The navigation container facade.
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        getNavContainerFacade () {
+            // eslint-disable-next-line no-constant-condition
+            if (false) {
+                return undefined; // allows to defined @returns type
+            }
+
+            throw new Error("Method not implemented.");
+        }
+
+        /**
+         * Updates the selected key in the navigation container based on {@link sap.ushell.modules.NavigationMenu.ListProvider#findSelectedKey}.
+         * @returns {Promise} Resolves once selected key was updated
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        async updateSelectedKey () {
+            throw new Error("Method not implemented.");
+        }
+
+        /**
+         * Opens the side navigation.
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        openSideNavigation () {
+            throw new Error("Method not implemented.");
+        }
+
+        /**
+         * Closes the side navigation.
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        closeSideNavigation () {
+            throw new Error("Method not implemented.");
+        }
+
+        /**
+         * Expands the side navigation.
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        expandSideNavigation () {
+            throw new Error("Method not implemented.");
+        }
+
+        /**
+         * Collapses the side navigation.
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        collapseSideNavigation () {
+            throw new Error("Method not implemented.");
+        }
+    }
+
+    return ListProviderAPI;
+});

package/src/main/js/sap/ushell/modules/NavigationMenu/NavContainer.js

@@ -0,0 +1,60 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @file This is an empty wrapper for the NavContainer API which provides methods to interact with the navigation menu container.
+ */
+sap.ui.define([
+], (
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.modules.NavigationMenu.NavContainer
+     * @namespace
+     * @description The API to interact with the navigation menu container.
+     * This module cannot be required. It has to be fetched via the respective APIs e.g. {@link sap.ushell.modules.NavigationMenu.ListProviderAPI#getNavContainerFacade}.
+     * @hideconstructor
+     *
+     * @since 1.141.0
+     * @private
+     * @ui5-restricted SAL
+     */
+    class NavContainer {
+        /**
+         * Adds a control to the navigation container.
+         * @param {sap.ui.core.Control} oControl The control to add.
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        add (oControl) {
+            throw new Error("Method not implemented.");
+        }
+
+        /**
+         * Navigates to the specified control.
+         * @param {string|sap.ui.core.Control} vControl The control to navigate to.
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        to (vControl) {
+            throw new Error("Method not implemented.");
+        }
+
+        /**
+         * Navigates to the root control.
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        toRoot () {
+            throw new Error("Method not implemented.");
+        }
+    }
+
+    return NavContainer;
+});

package/src/main/js/sap/ushell/modules/NavigationMenu/NavigationMenuMode.js

@@ -0,0 +1,37 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+sap.ui.define([
+], (
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.modules.NavigationMenu.NavigationMenuMode
+     * @enum {string}
+     *
+     * @since 1.141.0
+     * @private
+     * @ui5-restricted SAL
+     */
+    const NavigationMenuMode = {
+        /**
+         * Renders the NavigationMenu primarily as docked area.
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        Docked: "Docked",
+
+        /**
+         * Renders the NavigationMenu primarily as popover.
+         *
+         * @since 1.141.0
+         * @private
+         * @ui5-restricted SAL
+         */
+        Popover: "Popover"
+    };
+
+    return NavigationMenuMode;
+});

package/src/main/js/sap/ushell/modules/NavigationMenu.js

@@ -6,26 +6,21 @@
  * The navigation menu is an extension of the sap.tnt.SideNavigation that provides navigation capabilities.
  */
 sap.ui.define([
-    "sap/ushell/Config"
+    "sap/ushell/Config",
+    "sap/ushell/modules/NavigationMenu/NavigationMenuMode"
 ], (
-    Config
+    Config,
+    NavigationMenuMode
 ) => {
     "use strict";
 
-    /**
-     * @enum {string} NavigationMenuMode - Defines the position of the navigation menu.
-     * @private
-     * @ui5-restricted SAL
-     */
-    const NavigationMenuMode = {
-        Docked: "Docked",
-        Popover: "Popover"
-    };
-
     /**
      * @alias sap.ushell.modules.NavigationMenu
      * @namespace
      * @description The navigation menu API provides a way of placing content on the navigation menu.
+     * The ListProviders have to provide items as {@link sap.tnt.NavigationList} which is then embedded in the {@link sap.tnt.SideNavigation}.
+     * The items have to provide unique keys to have them properly selected on navigation. The selected key has to be determined by the
+     * extending ListProvider via {@link sap.ushell.modules.NavigationMenu.ListProvider#findSelectedKey}.
      *
      * @since 1.136.0
      * @private
@@ -41,7 +36,9 @@ sap.ui.define([
         /**
          * Sets the navigation list provider for the navigation menu.
          *
-         * @param {string} sModulePath The module path of the navigation list provider.
+         * @param {string} sModulePath
+         * The module path of the navigation list provider.
+         * The module needs to fulfill the {@link sap.ushell.modules.NavigationMenu.ListProvider} interface.
          * @param {object} oConfiguration The configuration object for the navigation list provider.
          *
          * @since 1.136.0
@@ -58,7 +55,9 @@ sap.ui.define([
         /**
          * Sets the navigation list provider for the fixed area of the navigation menu.
          *
-         * @param {string} sModulePath The module path of the navigation list provider.
+         * @param {string} sModulePath
+         * The module path of the navigation list provider.
+         * The module needs to fulfill the {@link sap.ushell.modules.NavigationMenu.ListProvider} interface.
          * @param {object} oConfiguration The configuration object for the navigation list provider.
          *
          * @since 1.136.0
@@ -75,10 +74,12 @@ sap.ui.define([
         /**
          * Sets the mode of the navigation menu.
          *
-         * @param {NavigationMenuMode} sMode The mode of the navigation menu. Can be "Docked" or "Popover".
+         * @param {sap.ushell.modules.NavigationMenu.NavigationMenuMode} sMode The mode of the navigation menu. Can be "Docked" or "Popover".
+         *
+         * @private
          */
         setMode (sMode) {
-            if (sMode !== NavigationMenuMode.Docked && sMode !== NavigationMenuMode.Popover) {
+            if (!Object.values(NavigationMenuMode).includes(sMode)) {
                 throw new Error(`Invalid mode: ${sMode}`);
             }
             Config.emit("/core/sideNavigation/mode", sMode);

package/src/main/js/sap/ushell/navigationMode.js

@@ -11,7 +11,7 @@
  * Method Compute is used by ClientSide TargetResolution and takes not only the
  * next application but also the current application into account.
  *
- * @version 1.140.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/performance/FesrEnhancer.js

@@ -68,8 +68,6 @@ sap.ui.define([
         }
     };
 
-    const oRendererManagedComponents = new RendererManagedComponents();
-
     const oFesrEnhancer = {
         _fnOriginalOnBeforeCreated: null,
         _oLastTrackedRecord: null,
@@ -441,7 +439,7 @@ sap.ui.define([
                             sDeterminedScenario = SCENARIOS.FINDER_INITIAL;
                             break;
                         default:
-                            if (oRendererManagedComponents.isComponentName(oFesrHandle.appNameLong)) {
+                            if (RendererManagedComponents.isManagedComponentName(oFesrHandle.appNameLong)) {
                                 // managed renderer component, e.g. "sap.ushell.components.pages", or menu
                                 if (oLastClosedRecord.getStep() === SCENARIOS.APP_INITIAL) {
                                     sDeterminedScenario = SCENARIOS.APP_INITIAL;

package/src/main/js/sap/ushell/performance/ShellAnalytics.js

@@ -3,7 +3,7 @@
  * @fileOverview Provides analytical data like duration for navigation steps in the shell, in FLP,
  *               in particular an array of all statistical records
  *
- * @version 1.140.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/performance/StatisticalRecord.js

@@ -3,7 +3,7 @@
  * @fileOverview Class for statistical record
  *               It should contain data like step, duration after a navigation in the shell, can have status open.
  *               The closing of a record is logged in debug mode
- * @version 1.140.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/plugins/BaseRTAPlugin.js

@@ -1,13 +1,17 @@
 // Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/ui/core/Component",
-    "sap/ui/core/Element",
     "sap/ushell/appRuntime/ui5/plugins/baseRta/AppLifeCycleUtils",
     "sap/ushell/appRuntime/ui5/plugins/baseRta/CheckConditions",
     "sap/ushell/appRuntime/ui5/plugins/baseRta/Trigger"
+    /*
+     * Be careful with new dependencies.
+     * Only include dependencies that are already bundled in
+     * core-min/core-ext, appruntime or the flex-plugins bundle
+     * otherwise load the library lazily before use.
+     */
 ], (
     Component,
-    Element,
     AppLifeCycleUtils,
     CheckConditions,
     Trigger

package/src/main/js/sap/ushell/plugins/appwarmup/Component.js

@@ -87,7 +87,7 @@ sap.ui.define(
         const sComponentName = "sap.ushell.plugins.appwarmup.Component";
         return Component.extend(sComponentName, {
             metadata: {
-                version: "1.140.0",
+                version: "1.141.0",
                 library: "sap.ushell"
             },
 

package/src/main/js/sap/ushell/renderer/AccessKeysHandler.js

@@ -57,7 +57,7 @@ sap.ui.define([
         this.oConfigModel = ShellModel.getConfigModel();
         // prevent browser event ctrl+up/down from scrolling page
         // created by user `keydown` native event needs to be cancelled so browser will not make default action, which is scroll.
-        // Instead we clone same event and dispatch it programmatic, so all handlers expecting to this event will still work
+        // Instead, we clone same event and dispatch it programmatic, so all handlers expecting to this event will still work
 
         document.addEventListener("keydown", (oEvent) => {
             // if Shift key was pressed alone, don't perform any action
@@ -95,9 +95,9 @@ sap.ui.define([
             if (this.fnExternalShortcuts) {
                 this.fnExternalShortcuts(oEvent);
             }
-        }, true); // End of event handler
+        }, true);
 
-        // save the bound function so that it can be deregistered later
+        // Save the bound function so that it can be deregistered later
         this._cancelHelpEvent = this._cancelHelpEvent.bind(this);
     };
 
@@ -162,11 +162,6 @@ sap.ui.define([
         const bEnableAppFinder = Config.last("/core/catalog/enabled");
         const bEnableNotifications = Config.last("/core/shell/model/enableNotifications");
 
-        if (Device.browser.msie) {
-            // the Internet Explorer would display its F1 help also on CTRL + F1 if the help event wasn't cancelled
-            document.addEventListener("help", this._cancelHelpEvent);
-        }
-
         let aShortCuts = [];
         aShortCuts = aShortCuts.concat(this.aShortcutsDescriptions);
 
@@ -270,6 +265,11 @@ sap.ui.define([
             return;
         }
 
+        if (Config.last("/core/shellBar/enabled")) {
+            Element.getElementById("shell-header").setFocusToAppFinderButton();
+            return;
+        }
+
         const oAppFinderBtn = window.document.getElementById("openCatalogBtn");
 
         if (oAppFinderBtn) {
@@ -346,7 +346,7 @@ sap.ui.define([
             if (bAdvancedShellActions) {
                 if (oEvent.keyCode === 65) { // ALT + A
                     this._blockBrowserDefault(oEvent).then(this._focusAppFinderButton.bind(this));
-                } else if (oEvent.keyCode === 83) {
+                } else if (oEvent.keyCode === 83) { // ALT + S
                     this._blockBrowserDefault(oEvent).then(this._focusSettingsButton.bind(this));
                 }
             }
@@ -372,10 +372,13 @@ sap.ui.define([
                         return;
                     }
 
-                    const oLogo = document.getElementById("shell-header-logo");
-                    if (oLogo) {
-                        oLogo.focus();
-                        return;
+                    if (Config.last("/core/shellBar/enabled")) {
+                        oShellHeader.setFocusToLogo();
+                    } else {
+                        const oLogo = document.getElementById("shell-header-logo");
+                        if (oLogo) {
+                            oLogo.focus();
+                        }
                     }
                 });
             } else if (oEvent.keyCode === 77) { // ALT + M
@@ -402,6 +405,7 @@ sap.ui.define([
         }
     };
 
+    // eslint-disable-next-line complexity
     AccessKeysHandler.prototype._handleCtrlShortcutKeys = function (oEvent, bAdvancedShellActions) {
         if (oEvent.shiftKey) {
             if (oEvent.keyCode === 70) { // CTRL + SHIFT + F

package/src/main/js/sap/ushell/renderer/Renderer.js

@@ -106,9 +106,9 @@ sap.ui.define([
      */
     const Renderer = UIComponent.extend("sap.ushell.renderer.Renderer", /** @lends sap.ushell.renderer.Renderer.prototype */ {
         metadata: {
-            version: "1.140.0",
+            version: "1.141.0",
             dependencies: {
-                version: "1.140.0",
+                version: "1.141.0",
                 libs: ["sap.ui.core", "sap.m"],
                 components: []
             },
@@ -1126,13 +1126,13 @@ sap.ui.define([
 
         if (!controlType) {
             Log.warning("You must specify control type in order to create it");
-            oDeferred.reject("You must specify control type in order to create it");
+            oDeferred.reject(new Error("You must specify control type in order to create it"));
             return oDeferred.promise();
         }
 
         if (!oControlProperties) {
             Log.warning("You must specify control properties in order to create it");
-            oDeferred.reject("You must specify control properties in order to create it");
+            oDeferred.reject(new Error("You must specify control properties in order to create it"));
             return oDeferred.promise();
         }
 
@@ -1477,13 +1477,13 @@ sap.ui.define([
 
         if (!controlType) {
             Log.warning("You must specify control type in order to create it");
-            oDeferred.reject("You must specify control type in order to create it");
+            oDeferred.reject(new Error("You must specify control type in order to create it"));
             return oDeferred.promise();
         }
 
         if (!oControlProperties) {
             Log.warning("You must specify control properties in order to create it");
-            oDeferred.reject("You must specify control properties in order to create it");
+            oDeferred.reject(new Error("You must specify control properties in order to create it"));
             return oDeferred.promise();
         }
 
@@ -1635,7 +1635,7 @@ sap.ui.define([
             } else {
                 const sNoControlTypeErrorMessage = "You must specify control type in order to create it";
                 Log.warning(sNoControlTypeErrorMessage);
-                oDeferred.reject(sNoControlTypeErrorMessage);
+                oDeferred.reject(new Error(sNoControlTypeErrorMessage));
                 return oDeferred.promise();
             }
         }
@@ -1643,7 +1643,7 @@ sap.ui.define([
         if (!oControlProperties) {
             const sNoControlPropertiesErrorMessage = "You must specify control properties in order to create it";
             Log.warning(sNoControlPropertiesErrorMessage);
-            oDeferred.reject(sNoControlPropertiesErrorMessage);
+            oDeferred.reject(new Error(sNoControlPropertiesErrorMessage));
             return oDeferred.promise();
         }
 
@@ -1667,7 +1667,7 @@ sap.ui.define([
         }, () => {
             const sControlTypeErrorMessage = `The control type ${sControlType} is not available.`;
             Log.error(sControlTypeErrorMessage);
-            oDeferred.reject(sControlTypeErrorMessage);
+            oDeferred.reject(new Error(sControlTypeErrorMessage));
         });
 
         return oDeferred.promise();
@@ -1787,7 +1787,7 @@ sap.ui.define([
 
         if (!oControlProperties) {
             Log.warning("You must specify control properties in order to create it");
-            oDeferred.reject("You must specify control properties in order to create it");
+            oDeferred.reject(new Error("You must specify control properties in order to create it"));
             return oDeferred.promise();
         }
 
@@ -1933,13 +1933,13 @@ sap.ui.define([
 
         if (!controlType) {
             Log.warning("You must specify control type in order to create it");
-            oDeferred.reject("You must specify control type in order to create it");
+            oDeferred.reject(new Error("You must specify control type in order to create it"));
             return oDeferred.promise();
         }
 
         if (!oControlProperties) {
             Log.warning("You must specify control properties in order to create it");
-            oDeferred.reject("You must specify control properties in order to create it");
+            oDeferred.reject(new Error("You must specify control properties in order to create it"));
             return oDeferred.promise();
         }
 

package/src/main/js/sap/ushell/renderer/RendererAppContainer.js

@@ -140,13 +140,13 @@ sap.ui.define([
      * @since 1.136.0
      * @private
      */
-    RendererAppContainer.prototype.loadChild = function () {
+    RendererAppContainer.prototype.loadChild = async function () {
         if (!this._hasValidConfig()) {
-            return Promise.reject("The RenderAppContainer does not yet have all of the required properties set, and thus can not be loaded.");
+            throw new Error("The RenderAppContainer does not yet have all of the required properties set, and thus can not be loaded.");
         }
 
         if (this._getChild()) {
-            return Promise.reject("The RenderAppContainer already has a Component loaded. A Component is not allowed to be loaded twice!");
+            throw new Error("The RenderAppContainer already has a Component loaded. A Component is not allowed to be loaded twice!");
         }
 
         if (!this._oComponentPromise) {