@openui5/sap.ui.documentation 1.150.0 → 1.152.0

package/src/sap/ui/documentation/sdk/controller/Code.controller.js

@@ -102,7 +102,7 @@ sap.ui.define(
 			},
 
 			onClearButtonPressed: function (oEvent) {
-				var oFrame = document.getElementById("sampleFrameEdit"),
+				var oFrame = this._getIFrameDomRef(),
 					sLocalStorageDKSamples = this._getChangedSamplesLocalStorage(),
 					oModelData = this.oModel.getData(),
 					sRef = sap.ui.require.toUrl((this._sId).replace(/\./g, "/"));
@@ -321,10 +321,14 @@ sap.ui.define(
 			_createHTMLControl: function () {
 				return new HTML({
 					id : "sampleFrameEdit",
-					content : '<iframe src="' + this.sIFrameUrl + '" frameBorder="0" width="100%" height="100%"></iframe>'
+					content : '<iframe frameBorder="0" width="100%" height="100%"></iframe>'
 				});
 			},
 
+			_getIFrameDomRef: function () {
+				return this._oHtmlControl && this._oHtmlControl.getDomRef();
+			},
+
 			_getPage: function () {
 				return this.byId("samplePageEdit");
 			},
@@ -388,9 +392,9 @@ sap.ui.define(
 			 * @param {string} sValue The value of the manifest.json file.
 			 */
 			_updateSample: function () {
-				var oFrame = document.getElementById("sampleFrameEdit");
+				var oFrame = this._getIFrameDomRef();
 
-				if (oFrame.contentWindow && oFrame.contentWindow.sap) {
+				if (oFrame && oFrame.contentWindow && oFrame.contentWindow.sap) {
 					oFrame.contentWindow.location.reload();
 				}
 			},

package/src/sap/ui/documentation/sdk/controller/Sample.controller.js

@@ -320,8 +320,9 @@ sap.ui.define([
 
 				// Assigning allowed query parameters from Demo Kit URL
 				ALLOWLIST_SAMPLES_SEARCH_PARAMS.forEach(function (oParam, index) {
-					if (new URL(document.location.href).searchParams.get(oParam)) {
-						sSampleSearchParams += (sSampleSearchParams === "" ? "?" : "&") + oParam + "=" + new URL(document.location.href).searchParams.get(oParam);
+					var sValue = new URL(document.location.href).searchParams.get(oParam);
+					if (sValue) {
+						sSampleSearchParams += (sSampleSearchParams === "" ? "?" : "&") + oParam + "=" + encodeURIComponent(sValue);
 					}
 				});
 
@@ -662,6 +663,11 @@ sap.ui.define([
 			_onAfterIframeRendering: function() {
 				var oModelData = this.oModel.getData();
 
+				var oIframeDomRef = this._oHtmlControl && this._oHtmlControl.getDomRef();
+				if (oIframeDomRef) {
+					oIframeDomRef.src = this.sIFrameUrl;
+				}
+
 				// For external samples, resolve immediately after rendering since they don't use our messaging protocol
 				if (this._isExternalSample(oModelData)) {
 					setTimeout(function() {
@@ -675,7 +681,7 @@ sap.ui.define([
 			_createHTMLControl: function () {
 				return new HTML({
 					id : "sampleFrame",
-					content : '<iframe src="' + this.sIFrameUrl + '" id="sampleFrame" frameBorder="0"></iframe>'
+					content : '<iframe id="sampleFrame" frameBorder="0"></iframe>'
 				});
 			},
 

package/src/sap/ui/documentation/sdk/controller/SubApiDetail.controller.js

@@ -34,11 +34,13 @@ sap.ui.define([
 		"sap/uxap/ObjectPageSection",
 		"sap/ui/documentation/ObjectPageSubSection",
 		"sap/ui/core/HTML",
-		"sap/ui/core/Core"
+		"sap/ui/core/Core",
+		"sap/m/MessageStrip",
+		"sap/ui/layout/VerticalLayout"
 	], function (jQuery, Log, Fragment, APIInfo, BaseController, ToggleFullScreenHandler,
 			formatter, Row, ParamText, JSDocType, JSDocText, Image, Label, Link, Text, HBox, ObjectAttribute, ObjectStatus, Popover,
 			library, MessageToast, coreLibrary, CustomListItem, List, includeStylesheet, includeScript,
-			ObjectPageSection, ObjectPageSubSection, HTML, Core) {
+			ObjectPageSection, ObjectPageSubSection, HTML, Core, MessageStrip, VerticalLayout) {
 		"use strict";
 
 		// shortcut for sap.m.FlexWrap
@@ -1034,9 +1036,33 @@ sap.ui.define([
 								text: this.formatter.escapeSettingsValue(sDefault),
 								wrapping: true
 							}),
-							new JSDocText({
-								sanitizeContent: false,
-								text: this.formatter.escapeSettingsValue(oProperty.description)
+							new VerticalLayout({
+								content: [
+									new JSDocText({
+										sanitizeContent: false,
+										text: this.formatter.escapeSettingsValue(oProperty.description)
+									}),
+									new MessageStrip({
+										visible: oProperty.deprecatedText !== undefined,
+										text: oProperty.deprecatedText || "",
+										type: "Error",
+										showIcon: true,
+										showCloseButton: false,
+										enableFormattedText: true
+									}).addStyleClass("sapUiTinyMarginBottom sapUiTinyMarginTop"),
+									new MessageStrip({
+										visible: oProperty.experimentalText !== undefined,
+										text: oProperty.experimentalText || "",
+										type: "Warning",
+										showIcon: true,
+										showCloseButton: false,
+										enableFormattedText: true
+									}).addStyleClass("sapUiTinyMarginBottom sapUiTinyMarginTop"),
+									new ObjectStatus({
+										visible: oProperty.since !== undefined,
+										text: oProperty.since ? "Since: " + oProperty.since : ""
+									})
+								]
 							})
 						]
 					}).addStyleClass("subrow");

package/src/sap/ui/documentation/sdk/controller/Welcome.controller.js

@@ -79,7 +79,7 @@ sap.ui.define([
 			 * Navigates to the tutorial overview
 			 */
 			onGetStarted: function () {
-				this.getRouter().parse("topic/8b49fc198bf04b2d9800fc37fecbb218");
+				this.getRouter().navTo("topicId", {id: "8b49fc198bf04b2d9800fc37fecbb218"});
 			},
 
 			/**

package/src/sap/ui/documentation/sdk/controller/util/SearchRenderer.js

@@ -0,0 +1,167 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2026 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+	"sap/f/gen/ui5/webcomponents_fiori/dist/SearchItem",
+	"sap/f/gen/ui5/webcomponents_fiori/dist/SearchItemGroup"
+], function (SearchItem, SearchItemGroup) {
+	"use strict";
+
+	/**
+	 * Renders search results into a ShellBarSearch control (sap.f wrapper).
+	 *
+	 * The controller passes an already-resolved control and a resolved i18n bundle;
+	 * this module owns the item-tree construction and population of the suggestions.
+	 */
+
+	var CATEGORY_DEFS = [
+		{ key: "apiref",   labelKey: "SEARCH_SUGGESTIONS_API_SECTION_TITLE",           countKey: "APILength" },
+		{ key: "topics",   labelKey: "SEARCH_SUGGESTIONS_DOCUMENTATION_SECTION_TITLE", countKey: "DocLength" },
+		{ key: "entity",   labelKey: "SEARCH_SUGGESTIONS_SAMPLES_SECTION_TITLE",       countKey: "SamplesLength" },
+		{ key: "external", labelKey: "SEARCH_SUGGESTIONS_EXTERNAL_SECTION_TITLE",      countKey: "ExternalLength" }
+	];
+
+	/**
+	 * Creates a SearchItem whose matched query text is highlighted.
+	 *
+	 * The sap.f SearchItem wrapper does not expose the underlying web component's
+	 * `highlightText` property, so it is applied directly to the custom element after
+	 * each rendering. The delegate re-applies it on every render (the suggestions
+	 * popover renders lazily and can re-render), keeping highlighting robust.
+	 *
+	 * The delegate is bound to the item instance and is released together with the item
+	 * when it is destroyed via `destroyAggregation("items")`, so no explicit cleanup is
+	 * needed. If the item is destroyed or invalidated before rendering completes,
+	 * highlighting is silently skipped (no error thrown).
+	 *
+	 * @param {object} mSettings - SearchItem constructor settings
+	 * @param {string} [sQuery]  - The query text to highlight within the item text (cleared when falsy)
+	 * @returns {sap.f.gen.ui5.webcomponents_fiori.dist.SearchItem} The created search item
+	 */
+	function createHighlightedItem(mSettings, sQuery) {
+		var oSearchItem = new SearchItem(mSettings);
+		oSearchItem.addEventDelegate({
+			onAfterRendering: function () {
+				var oDomRef = oSearchItem.getDomRef();
+				if (oDomRef) {
+					oDomRef.highlightText = sQuery || "";
+				}
+			}
+		});
+		return oSearchItem;
+	}
+
+	return {
+		/**
+		 * Populates the ShellBarSearch control with result items and opens it.
+		 *
+		 * @param {object} oCtrl          - The fiori:ShellBarSearch UI5 control
+		 * @param {Array}  aItems         - Top-N result items from SearchUtil
+		 * @param {object} oCounts        - { AllLength, APILength, DocLength, SamplesLength, ExternalLength }
+		 * @param {object} oBundle        - Resolved i18n resource bundle
+		 * @param {boolean} bPhone        - Whether the current viewport is phone-sized
+		 * @param {object} [oSearchModel] - Optional searchData JSONModel
+		 */
+		render: function (oCtrl, aItems, oCounts, oBundle, bPhone, oSearchModel) {
+			// The i18n bundle loads asynchronously; if a search is rendered before it
+			// resolves (App startup race), skip this render — a later keystroke/open
+			// re-renders once the bundle is ready.
+			if (!oBundle) { return; }
+
+			oCtrl.destroyAggregation("items");
+
+			var sQuery = oSearchModel ? (oSearchModel.getProperty("/query") || "") : "";
+
+			var sResultsHeader = aItems.length > 0
+				? oBundle.getText("SEARCH_SUGGESTIONS_TITLE_ALL")
+				: oBundle.getText("SEARCH_SUGGESTIONS_NO_RESULTS");
+
+			// Section 1: top results (or no-data placeholder)
+			var oResultsGroup = new SearchItemGroup(bPhone ? { headerText: sResultsHeader } : {});
+
+			if (aItems.length > 0) {
+				aItems.forEach(function (oDataItem) {
+					var oSearchItem = createHighlightedItem({
+						text: oDataItem.summary ? oDataItem.title + ": " + oDataItem.summary : (oDataItem.title || "")
+					}, sQuery);
+					oSearchItem.data("_payload", { type: "result", item: oDataItem });
+					oResultsGroup.addItem(oSearchItem);
+				});
+
+				// "All" entry at the bottom of the results, navigating to the full search results page.
+				var oAllItem = createHighlightedItem({
+					text: oBundle.getText("SEARCH_SUGGESTIONS_ALL_SECTION_TITLE") + " (" + (oCounts.AllLength || 0) + ")"
+				});
+				oAllItem.data("_payload", { type: "allResults" });
+				oResultsGroup.addItem(oAllItem);
+			} else {
+				var oNoDataItem = createHighlightedItem({ text: oBundle.getText("SEARCH_SUGGESTIONS_NO_RESULTS") });
+				oNoDataItem.data("_payload", { type: "noData" });
+				oResultsGroup.addItem(oNoDataItem);
+			}
+
+			oCtrl.addAggregation("items", oResultsGroup);
+
+			// Section 2: per-category counts
+			var aCategoryDefs = CATEGORY_DEFS
+				.map(function (o) { return { key: o.key, labelKey: o.labelKey, count: oCounts[o.countKey] || 0 }; })
+				.filter(function (o) { return o.count > 0; });
+
+			if (aCategoryDefs.length > 0) {
+				var oCategoryGroup = new SearchItemGroup({
+					headerText: oBundle.getText("SEARCH_SUGGESTIONS_BY_CATEGORY_TITLE")
+				});
+				oCategoryGroup.addStyleClass("sapUiDemokitSearchCategoryGroup");
+				aCategoryDefs.forEach(function (oDef) {
+					var oCatItem = createHighlightedItem({
+						text: oBundle.getText(oDef.labelKey) + " (" + oDef.count + ")"
+					});
+					oCatItem.data("_payload", { type: "category", key: oDef.key });
+					oCategoryGroup.addItem(oCatItem);
+				});
+				oCtrl.addAggregation("items", oCategoryGroup);
+			}
+
+			if (oSearchModel && !bPhone) {
+				oSearchModel.setProperty("/messageAreaText", sResultsHeader);
+			}
+		},
+
+		/**
+		 * Populates the ShellBarSearch with the category list only (all counts zero).
+		 * Used on phone when the popup opens before any search has been performed,
+		 * matching the old GlobalSearchPicker's initial state.
+		 *
+		 * @param {object} oCtrl   - The fiori:ShellBarSearch UI5 control
+		 * @param {object} oBundle - Resolved i18n resource bundle
+		 */
+		renderEmptyState: function (oCtrl, oBundle) {
+			if (!oBundle) { return; }
+
+			oCtrl.destroyAggregation("items");
+
+			var oCategoryGroup = new SearchItemGroup({
+				headerText: oBundle.getText("SEARCH_SUGGESTIONS_BY_CATEGORY_TITLE")
+			});
+			CATEGORY_DEFS.forEach(function (oDef) {
+				var oItem = createHighlightedItem({
+					text: oBundle.getText(oDef.labelKey) + " (0)"
+				});
+				oItem.data("_payload", { type: "category", key: oDef.key });
+				oCategoryGroup.addItem(oItem);
+			});
+			oCtrl.addAggregation("items", oCategoryGroup);
+		},
+
+		/**
+		 * Removes all items from the ShellBarSearch control.
+		 *
+		 * @param {object} oCtrl - The fiori:ShellBarSearch UI5 control
+		 */
+		clear: function (oCtrl) {
+			oCtrl.destroyAggregation("items");
+		}
+	};
+});

package/src/sap/ui/documentation/sdk/controller/util/UsageTracker.js

@@ -20,22 +20,20 @@ sap.ui.define(
 
         const aNotFoundViews = ["sap.ui.documentation.sdk.view.NotFound", "sap.ui.documentation.sdk.view.SampleNotFound"];
 
-        var PageInfo = function(oRouteConfig, oRouter, sURL, referrer) {
+        var PageInfo = function(oRouteConfig, oRouter, sURL, sReferrer) {
             sURL = sURL || window.location.href;
-            referrer = referrer || document.referrer;
+            sReferrer = sReferrer || document.referrer;
             const oURL = new URL(sURL),
                 sSectionTitle = oRouter.getRouteTopLevelTitle(oRouteConfig);
 
-            var sHash = oURL.hash.replace(/\.html/, '');
-
             this.url = sURL;
-            this.name = oURL.pathname + sHash;
+            this.name = composePageName(oURL);
             this.section = sSectionTitle || "/";
             this.title = undefined;
             this.language = oUserLanguageTag.language;
             this.locale = oUserLanguageTag.toString();
             this.country = "glo";
-            this.referrer = document.referrer;
+            this.referrer = sReferrer;
         };
 
         PageInfo.prototype.toObject = function() {
@@ -74,6 +72,7 @@ sap.ui.define(
                     this._oRouter = oComponent.getRouter();
                     this._oConfig = oComponent.getConfig();
                     this._oLastRouteParameters = null;
+                    this._sLastLoggedPageUrl = null;
                     this._isStarted = false;
                 },
                 start: function(sVersionName, aRouterEventsToLog) {
@@ -98,6 +97,7 @@ sap.ui.define(
                     Localization.detachChange(this._updateLanguageTag);
                     this._isStarted = false;
                     this._oLastRouteParameters = null;
+                    this._sLastLoggedPageUrl = null;
                 },
                 _initRemoteServiceConnector: function(sVersionName) {
                     window.adobeDataLayer = window.adobeDataLayer || [];
@@ -142,6 +142,7 @@ sap.ui.define(
                     this._oLastRouteParameters = oEventParameters;
                     this._getPageInfoFromRoute(oEventParameters, function(oPageInfo) {
                         this._logPageVisit(oPageInfo);
+                        this._sLastLoggedPageUrl = oPageInfo.url;
                         this._publishLoggedInfo(true);
                     }.bind(this));
                 },
@@ -171,7 +172,7 @@ sap.ui.define(
                 },
                 _getPageInfoFromRoute: function(oEventParameters, fnCallback) {
                     var oRouteConfig = oEventParameters.config,
-                        oPageInfo = new PageInfo(oRouteConfig, this._oRouter);
+                        oPageInfo = new PageInfo(oRouteConfig, this._oRouter, window.location.href, this._sLastLoggedPageUrl);
                     this._getPageTitleFromRoute(oEventParameters, function(sPageTitle) {
                         oPageInfo.title = sPageTitle;
                         fnCallback(oPageInfo);
@@ -253,7 +254,7 @@ sap.ui.define(
                  * Triggered when router does not find the route
                  */
                 _logPageNotFound: function (sHash) {
-                    sHash = sHash.replace(/\.html/, '');
+                    const sNormalized = normalizeHash(sHash) || "/";
                     this._addToLogs({
                         event: "errorPage",
                         page: {
@@ -263,7 +264,7 @@ sap.ui.define(
                         error: {
                             type: 404,
                             pageUrl: window.location.href,
-                            pageName: sHash,
+                            pageName: sNormalized,
                             description: "page not found"
                         }
                     });
@@ -274,14 +275,13 @@ sap.ui.define(
                 _logPageDataNotFound: function () {
                     var oPageInfo;
                     if (this._oLastRouteParameters) {
-                        var oRouteConfig = this._oRouter.getRouteConfig(this._oLastRouteParameters.name);
+                        const oRouteConfig = this._oRouter.getRouteConfig(this._oLastRouteParameters.name);
                         oPageInfo = new PageInfo(oRouteConfig, this._oRouter);
                     } else {
-                        var oURL = new URL(window.location.href);
-                        var sHash = oURL.hash.replace(/\.html/, '');
+                        const oURL = new URL(window.location.href);
                         oPageInfo = {
-                            url: window.location.href,
-                            name: oURL.pathname + sHash,
+                            url: oURL.href,
+                            name: composePageName(oURL),
                             section: "/"
                         };
                     }
@@ -358,6 +358,19 @@ sap.ui.define(
             }
         );
 
+        function normalizeHash(sHash) {
+            sHash = sHash.replace(/\.html/, '');
+            return sHash === "/" ? "" : sHash;
+        }
+
+        function composePageName(oURL) {
+            const sHash = normalizeHash(oURL.hash.replace(/^#/, ''));
+            if (sHash) {
+                return oURL.pathname + "#" + sHash;
+            }
+            return oURL.pathname;
+        }
+
         return UsageTracker;
     }
 );

package/src/sap/ui/documentation/sdk/cookieSettingsDialog/i18n/i18n_en_US_saptrc.properties

@@ -3,6 +3,9 @@ COOKIE_SETTINGS_DIALOG_TITLE=VSiHf/ID+8Qa6LMSy2qeOA_Your Cookie Settings
 COOKIE_SETTINGS_DIALOG_REQUIRED_COOKIES_TITLE=1QXuYN58UnmqoK7UtwpzHg_Required Cookies
 COOKIE_SETTINGS_DIALOG_REQUIRED_COOKIES_SUMMARY=1mlj9qCqW87sOdOuAR2C4w_These cookies are required to enable core site functionality.
 COOKIE_SETTINGS_DIALOG_REQUIRED_COOKIES_TEXT=zEB+717Bx2XbQHiornUX5g_We use cookies to improve your experience on our site. By continuing to use this site, you consent to use our cookies.
+COOKIE_SETTINGS_DIALOG_FUNCTIONAL_COOKIES_TITLE=ZXlj7cSXT6P/Ps82CAsL8w_Functional Cookies
+COOKIE_SETTINGS_DIALOG_FUNCTIONAL_COOKIES_SUMMARY=1H7LvCVhIoMq/dePe1FukA_These cookies are used to keep your preferences for site appearance and display language.
+COOKIE_SETTINGS_DIALOG_FUNCTIONAL_COOKIES_TEXT=NHRZgyI642RKfviuT6QZtw_To enhance your browsing experience, we use cookies to remember your preferences for the site's appearance (light or dark theme) and display language. These cookies ensure that your chosen settings are applied every time you visit or refresh the page, providing a consistent and personalized experience.
 COOKIE_SETTINGS_DIALOG_FUNCTIONAL_COOKIES_MORE_INFO=Qpa+hooIo7y9TfuBB8qI3Q_More Info
 COOKIE_SETTINGS_DIALOG_FUNCTIONAL_COOKIES_ACCEPT_ALL=1fDIhkWCDHFw/wvL6LOsrQ_Accept All
 COOKIE_SETTINGS_DIALOG_FUNCTIONAL_COOKIES_REJECT_ALL=WQb3PnaP15zVcqEmlUYfLQ_Reject All

package/src/sap/ui/documentation/sdk/thirdparty/highlight.js/highlight.js

@@ -998,10 +998,10 @@ var hljs = (function () {
    * @param {string} message
    */
   const deprecated = (version, message) => {
-    if (seenDeprecations[`1.150.0/${message}`]) return;
+    if (seenDeprecations[`1.152.0/${message}`]) return;
 
-    console.log(`Deprecated as of 1.150.0. ${message}`);
-    seenDeprecations[`1.150.0/${message}`] = true;
+    console.log(`Deprecated as of 1.152.0. ${message}`);
+    seenDeprecations[`1.152.0/${message}`] = true;
   };
 
   /* eslint-disable no-throw-literal */