@sapui5/sap.ushell 1.122.1 → 1.123.0

package/src/main/js/sap/ushell/ui/AppContainer.js

@@ -187,16 +187,60 @@ sap.ui.define([
 
     // Stubs for Fiori2 API - these methods are noop in Fiori3
     var noop = function () { };
+    /**
+     * @deprecated since 1.120 The ViewPortState is related to Fiori2 and not used anymore.
+     */
     AppContainer.prototype.switchState = noop;
+
+    /**
+     * @deprecated since 1.120 The ViewPortState is related to Fiori2 and not used anymore.
+     */
     AppContainer.prototype._handleSizeChange = noop;
+
+    /**
+     * @deprecated since 1.120 The ViewPortState is related to Fiori2 and not used anymore.
+     */
     AppContainer.prototype.shiftCenterTransitionEnabled = noop;
+
+    /**
+     * @deprecated since 1.120 The ViewPortState is related to Fiori2 and not used anymore.
+     */
     AppContainer.prototype.shiftCenterTransition = noop;
+
+    /**
+     * @deprecated since 1.120 The ViewPortState is related to Fiori2 and not used anymore.
+     */
     AppContainer.prototype.addLeftViewPort = noop;
+
+    /**
+     * @deprecated since 1.120 The ViewPortState is related to Fiori2 and not used anymore.
+     */
     AppContainer.prototype.addRightViewPort = noop;
+
+    /**
+     * @deprecated since 1.120 The ViewPortState is related to Fiori2 and not used anymore.
+     */
     AppContainer.prototype.attachAfterSwitchState = noop;
+
+    /**
+     * @deprecated since 1.120 The ViewPortState is related to Fiori2 and not used anymore.
+     */
     AppContainer.prototype.detachAfterSwitchState = noop;
+
+    /**
+     * @deprecated since 1.120 The ViewPortState is related to Fiori2 and not used anymore.
+     */
     AppContainer.prototype.attachAfterSwitchStateAnimationFinished = noop;
+
+    /**
+     * @deprecated since 1.120 The ViewPortState is related to Fiori2 and not used anymore.
+     */
     AppContainer.prototype.detachAfterSwitchStateAnimationFinished = noop;
+
+    /**
+     * @returns {string} The current ViewPort State
+     * @deprecated since 1.120 The ViewPortState is related to Fiori2 and not used anymore.
+     */
     AppContainer.prototype.getCurrentState = function () {
         return "Center";
     };

package/src/main/js/sap/ushell/ui/appfinder/AppBoxInternal.js

@@ -7,9 +7,9 @@ sap.ui.define([
     "sap/ui/core/IconPool",
     "sap/ushell/library", // css style dependency
     "sap/ushell/resources",
-    "sap/ushell/ui/appfinder/AppBoxRenderer",
+    "sap/ushell/ui/appfinder/AppBoxInternalRenderer",
     "sap/ushell/Config"
-], function (Control, Icon, IconPool, ushellLibrary, resources, AppBoxRenderer, Config) {
+], function (Control, Icon, IconPool, ushellLibrary, resources, AppBoxInternalRenderer, Config) {
     "use strict";
 
     /**
@@ -84,7 +84,7 @@ sap.ui.define([
                 afterRendering: {}
             }
         },
-        renderer: AppBoxRenderer
+        renderer: AppBoxInternalRenderer
     });
 
     /**

package/src/main/js/sap/ushell/ui/appfinder/AppBoxInternalRenderer.js

@@ -0,0 +1,103 @@
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/ushell/resources"
+], function (resources) {
+    "use strict";
+
+    /**
+     * AppBox renderer.
+     * @namespace
+     */
+    var AppBoxInternalRenderer = {
+        apiVersion: 2
+    };
+
+    /**
+     * Renders the HTML for the given AppBox control, using the provided
+     * {@link sap.ui.core.RenderManager}.
+     *
+     * @param {sap.ui.core.RenderManager} rm
+     *            the RenderManager that can be used for writing to
+     *            the Render-Output-Buffer
+     * @param {sap.ui.core.Control} oAppBox
+     *            the AppBox to be rendered
+     */
+    AppBoxInternalRenderer.render = function (rm, oAppBox) {
+        rm.openStart("li", oAppBox);
+        rm.class("sapUshellAppBox");
+        rm.attr("aria-label", oAppBox._getAriaLabel());
+        rm.attr("aria-roledescription", resources.i18n.getText("tile"));
+        rm.attr("aria-describedby", oAppBox.getId());
+        rm.openEnd(); // li - tag
+
+        rm.openStart("div");
+        rm.class("sapUshellAppBoxInner");
+        rm.openEnd(); // div - tag
+
+        // icon
+        var bHasIcon = oAppBox.getIcon();
+        if (bHasIcon) {
+            rm.renderControl(oAppBox._oIcon);
+        }
+
+        rm.openStart("div");
+        if (bHasIcon) {
+            rm.class("sapUshellAppBoxHeader");
+        } else {
+            rm.class("sapUshellAppBoxHeaderNoIcon");
+        }
+        rm.openEnd(); // div - tag
+
+        // title
+        rm.openStart("div", oAppBox.getId() + "-title");
+        rm.class("sapUshellAppBoxTitle");
+        rm.openEnd(); // div - tag
+        rm.text(oAppBox.getTitle());
+        rm.close("div");
+
+        // subtitle
+        if (oAppBox.getSubtitle()) {
+            rm.openStart("div", oAppBox.getId() + "-subTitle");
+            rm.class("sapUshellAppBoxSubtitle");
+            rm.openEnd(); // div - tag
+            rm.text(oAppBox.getSubtitle());
+            rm.close("div");
+        }
+
+        rm.close("div");
+        rm.close("div");
+
+        rm.openStart("div");
+        rm.class("sapUshellAppBoxActionsArea");
+        if (oAppBox.getTitle) {
+            rm.attr("role", "toolbar");
+            rm.attr("aria-label", oAppBox.getTitle());
+        }
+        rm.openEnd(); // div - tag
+
+        // Content Provider Label
+        if (oAppBox.getShowContentProviderLabel() && oAppBox.getContentProviderLabel() !== "") {
+            rm.openStart("div", oAppBox.getId() + "-contentProviderLabel");
+            rm.class("sapUshellAppBoxContentProviderLabel");
+            rm.openEnd(); // div - tag
+
+            rm.openStart("span", oAppBox.getId() + "-contentProviderLabelInner");
+            rm.class("sapUshellAppBoxContentProviderLabelInner");
+            rm.attr("title", oAppBox.getContentProviderLabel().toUpperCase());
+            rm.openEnd(); // div - tag
+            rm.text(oAppBox.getContentProviderLabel());
+            rm.close("span");
+            rm.close("div");
+        }
+
+        rm.renderControl(oAppBox.getPinButton());
+
+        rm.close("div");
+        rm.close("li");
+    };
+
+
+    return AppBoxInternalRenderer;
+
+}, /* bExport= */ true);

package/src/main/js/sap/ushell/ui/appfinder/AppBoxRenderer.js

@@ -1,103 +1,12 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
-
+/**
+ * @fileoverview AppBox renderer
+ * @deprecated As of version 1.120
+ */
 sap.ui.define([
-    "sap/ushell/resources"
-], function (resources) {
+    "sap/ushell/ui/appfinder/AppBoxInternalRenderer"
+], function (AppBoxInternalRenderer) {
     "use strict";
 
-    /**
-     * AppBox renderer.
-     * @namespace
-     */
-    var AppBoxRenderer = {
-        apiVersion: 2
-    };
-
-    /**
-     * Renders the HTML for the given AppBox control, using the provided
-     * {@link sap.ui.core.RenderManager}.
-     *
-     * @param {sap.ui.core.RenderManager} rm
-     *            the RenderManager that can be used for writing to
-     *            the Render-Output-Buffer
-     * @param {sap.ui.core.Control} oAppBox
-     *            the AppBox to be rendered
-     */
-    AppBoxRenderer.render = function (rm, oAppBox) {
-        rm.openStart("li", oAppBox);
-        rm.class("sapUshellAppBox");
-        rm.attr("aria-label", oAppBox._getAriaLabel());
-        rm.attr("aria-roledescription", resources.i18n.getText("tile"));
-        rm.attr("aria-describedby", oAppBox.getId());
-        rm.openEnd(); // li - tag
-
-        rm.openStart("div");
-        rm.class("sapUshellAppBoxInner");
-        rm.openEnd(); // div - tag
-
-        // icon
-        var bHasIcon = oAppBox.getIcon();
-        if (bHasIcon) {
-            rm.renderControl(oAppBox._oIcon);
-        }
-
-        rm.openStart("div");
-        if (bHasIcon) {
-            rm.class("sapUshellAppBoxHeader");
-        } else {
-            rm.class("sapUshellAppBoxHeaderNoIcon");
-        }
-        rm.openEnd(); // div - tag
-
-        // title
-        rm.openStart("div", oAppBox.getId() + "-title");
-        rm.class("sapUshellAppBoxTitle");
-        rm.openEnd(); // div - tag
-        rm.text(oAppBox.getTitle());
-        rm.close("div");
-
-        // subtitle
-        if (oAppBox.getSubtitle()) {
-            rm.openStart("div", oAppBox.getId() + "-subTitle");
-            rm.class("sapUshellAppBoxSubtitle");
-            rm.openEnd(); // div - tag
-            rm.text(oAppBox.getSubtitle());
-            rm.close("div");
-        }
-
-        rm.close("div");
-        rm.close("div");
-
-        rm.openStart("div");
-        rm.class("sapUshellAppBoxActionsArea");
-        if (oAppBox.getTitle) {
-            rm.attr("role", "toolbar");
-            rm.attr("aria-label", oAppBox.getTitle());
-        }
-        rm.openEnd(); // div - tag
-
-        // Content Provider Label
-        if (oAppBox.getShowContentProviderLabel() && oAppBox.getContentProviderLabel() !== "") {
-            rm.openStart("div", oAppBox.getId() + "-contentProviderLabel");
-            rm.class("sapUshellAppBoxContentProviderLabel");
-            rm.openEnd(); // div - tag
-
-            rm.openStart("span", oAppBox.getId() + "-contentProviderLabelInner");
-            rm.class("sapUshellAppBoxContentProviderLabelInner");
-            rm.attr("title", oAppBox.getContentProviderLabel().toUpperCase());
-            rm.openEnd(); // div - tag
-            rm.text(oAppBox.getContentProviderLabel());
-            rm.close("span");
-            rm.close("div");
-        }
-
-        rm.renderControl(oAppBox.getPinButton());
-
-        rm.close("div");
-        rm.close("li");
-    };
-
-
-    return AppBoxRenderer;
-
+    return AppBoxInternalRenderer;
 }, /* bExport= */ true);

package/src/main/js/sap/ushell/ui/cards/RecentActivitiesExtension.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Extension for recent activities card
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ui/integration/Extension",

package/src/main/js/sap/ushell/ui/launchpad/CatalogsContainer.js

@@ -5,13 +5,15 @@ sap.ui.define([
     "sap/ui/core/Control",
     "sap/ui/performance/Measurement",
     "sap/ushell/library", // css style dependency
-    "sap/ushell/ui/launchpad/TileContainerUtils"
+    "sap/ushell/ui/launchpad/TileContainerUtils",
+    "sap/ushell/resources"
 ], function (
     Log,
     Control,
     Measurement,
     ushellLibrary,
-    TileContainerUtils
+    TileContainerUtils,
+    resources
 ) {
     "use strict";
 
@@ -73,7 +75,7 @@ sap.ui.define([
         var aItems = this.getCatalogs();
 
         this.nAllocatedUnits = nAllocatedUnits;
-        if (sCatalog && sCatalog !== "All") {
+        if (sCatalog && sCatalog !== resources.i18n.getText("all")) {
             this.sCatalogTerm = sCatalog;
         } else {
             this.sCatalogTerm = "";

package/src/main/js/sap/ushell/ui/launchpad/ExtendedChangeDetection.js

@@ -7,7 +7,7 @@
  * of recreating them. Items which get removed from the aggregation get destroyed and items which get added to the
  * aggregation get created.
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ui/base/ManagedObject",

package/src/main/js/sap/ushell/ui/launchpad/Section.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Provides control sap.ushell.ui.launchpad.Section
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/ui/launchpad/ViewPortState.js

@@ -1,10 +1,11 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
-sap.ui.define(function() {
+sap.ui.define(function () {
     "use strict";
 
     /**
      * @name sap.ushell.ui.launchpad.ViewPortState
      * @private
+     * @deprecated Since version 1.120.0. The ViewPortState is related to Fiori2 and not used anymore.
      */
 
 }, /* bExport= */ false);

package/src/main/js/sap/ushell/ui/launchpad/section/CompactArea.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Provides control sap.ushell.ui.launchpad.section.CompactArea
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 
 sap.ui.define([

package/src/main/js/sap/ushell/ui/shell/ToolAreaItem.js

@@ -18,7 +18,7 @@ sap.ui.define([
      * A control to be placed in the tool area
      * @extends sap.ui.core.Control
      *
-     * @version 1.122.1
+     * @version 1.123.0
      *
      * @public
      * @since 1.30.5

package/src/main/js/sap/ushell/ui/utils.js

@@ -6,7 +6,7 @@
  * This is a utility module that collects common activities implemented
  * by controllers of different ui components.
  *
- * @version 1.122.1
+ * @version 1.123.0
  * @private
  */
 

package/src/main/js/sap/ushell/ui5service/ShellUIService.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The ShellUIService UI5 service
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ui/core/service/ServiceFactoryRegistry",

package/src/main/js/sap/ushell/ui5service/UserStatus.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The UserStatus UI5 service
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ui/core/service/ServiceFactoryRegistry",

package/src/main/js/sap/ushell/ui5service/_ShellUIService/shelluiservice.class.factory.js

@@ -127,10 +127,35 @@ sap.ui.define([
          * </pre>
          *
          * @public
+         * @hideconstructor
          * @extends sap.ui.core.service.Service
          * @since 1.38.0
          */
         var ShellUIService = Service.extend("sap.ushell.ui5service.ShellUIService", /** @lends sap.ushell.ui5service.ShellUIService.prototype */ {
+
+            /**
+             * Defines essential information about an app.
+             *
+             * Example:
+             * <pre>
+             * {
+             *      title: "App 1",
+             *      icon: "sap-icon://folder",
+             *      subtitle: "go to app 1",
+             *      intent: "#Action-toapp1"
+             * }
+             * </pre>
+             *
+             * @typedef {object} sap.ushell.ui5service.ShellUIService.AppInfo
+             * @property {string} title The title of the app.
+             * @property {string} icon The icon src representing the app.
+             * @property {string} [subtitle] An optional subtitle of the app.
+             * @property {string} intent The navigation intent of the app.
+             *
+             * @since 1.120.0
+             * @public
+             */
+
             init: function () {
                 // Service injection
                 var that = this;
@@ -549,33 +574,13 @@ sap.ui.define([
                     "sap.ushell.ui5service.ShellUIService"
                 );
             },
+
             /**
              * Displays the given hierarchy in the shell header.
              *
-             * @param {object[]} [aHierarchyLevels]
+             * @param {sap.ushell.ui5service.ShellUIService.AppInfo[]} [aHierarchyLevels]
              *    An array representing hierarchies of the currently displayed
-             *    app.  The array should specify title, icon, and
-             *    navigation intent as shown in the following example:
-             *
-             * <pre>
-             * [
-             *     {
-             *         title: "Main View",
-             *         icon: "sap-icon://documents",
-             *         intent: "#Action-sameApp"
-             *     },
-             *     {
-             *         title: "View 2",
-             *         subtitle: "Application view number 2",
-             *         intent: "#Action-sameApp&/View2/"
-             *     },
-             *     {
-             *         title: "View 3",
-             *         subtitle: "Application view number 3",
-             *         intent: "#Action-sameApp&/View3/"
-             *     }
-             * ]
-             * </pre>
+             *    app.
              *
              * The default app hierarchy is applied if no parameter is given.
              *
@@ -682,31 +687,8 @@ sap.ui.define([
              * Used by apps to set related apps.  This setting is propagated
              * towards the Shell Header via corresponding events.
              *
-             * @param {object[]} [aRelatedApps]
-             *    an array of related apps, for example like:
-             *
-             * <pre>
-             * [
-             *       {
-             *           title: "App 1",
-             *           icon: "sap-icon://folder",
-             *           subtitle: "go to app 1",
-             *           intent: "#Action-toapp1"
-             *       },
-             *       {
-             *           title: "App 2",
-             *           icon: "sap-icon://folder",
-             *           subtitle: "go to app 2",
-             *           intent: "#Action-toapp2"
-             *       },
-             *       {
-             *           title: "App 3",
-             *           icon: "sap-icon://folder",
-             *           subtitle: "go to app 3",
-             *           intent: "#Action-toapp3"
-             *       }
-             * ]
-             * </pre>
+             * @param {sap.ushell.ui5service.ShellUIService.AppInfo[]} [aRelatedApps]
+             *    An array of related apps.
              *
              * @since 1.40.0
              * @public

package/src/main/js/sap/ushell/utils/UrlShortening.js

@@ -5,7 +5,7 @@
  *
  * This module is for internal Shell usage only
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
  sap.ui.define(["sap/base/Log", "sap/ushell/utils/UrlParsing"], function (Log, urlParsing) {
     "use strict";