@openui5/sap.ui.documentation 1.101.0 → 1.102.2

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

@@ -47,6 +47,11 @@ sap.ui.define([
 		// shortcut for sap.m.URLHelper
 		var URLHelper = mobileLibrary.URLHelper;
 
+		var ALLOWLIST_SAMPLES_SEARCH_PARAMS = [
+			"sap-ui-rtl",
+			"sap-ui-language"
+		];
+
 		return SampleBaseController.extend("sap.ui.documentation.sdk.controller.Sample", {
 			/* =========================================================== */
 			/* lifecycle methods										   */
@@ -408,71 +413,78 @@ sap.ui.define([
 					this.fResolve = resolve;
 					this.fReject = reject;
 					var sSampleOrigin = (window['sap-ui-documentation-config'] && window['sap-ui-documentation-config'].demoKitResourceOrigin) || "",
-						sSampleVersion = ResourcesUtil.getResourcesVersion();
-
-					this.sIFrameUrl = ResourcesUtil.getResourceOrigin() +
-						"/resources/sap/ui/documentation/sdk/index.html" +
-						(new URL(document.location.href).search ? new URL(document.location.href).search + "&" : "?") +
-						"sap-ui-xx-sample-id=" + sSampleId
-						+ "&sap-ui-xx-sample-origin=" + sSampleOrigin + sSampleVersion
-						+ "&sap-ui-xx-dk-origin=" + window.location.origin;
-
-					if (!this._oHtmlControl) {
-
-						var fnMessage =  function (eMessage) {
-							if (eMessage.data.type === "INIT") {
-								var oConfiguration = sap.ui.getCore().getConfiguration();
-								if (eMessage.data.config && eMessage.data.config.sample && eMessage.data.config.sample.iframe) {
-									sSampleId = this._sId;
-									vIframe = eMessage.data.config.sample.iframe;
-									sIframePath = this._resolveIframePath(sSampleId, vIframe);
-
-									//vlaid only for samples that contains own index.html
-									// strip the file extension to be able to use jQuery.sap.getModulePath
-									aFileNameMatches = rExtractFilename.exec(vIframe);
-									sFileName = (aFileNameMatches && aFileNameMatches.length > 1 ? aFileNameMatches[1] : vIframe);
-									sFileEnding = rStripUI5Ending.exec(sFileName)[0];
-									var sIframeWithoutUI5Ending = sFileName.replace(rStripUI5Ending, "");
-
-									// combine namespace with the file name again
-									this.sIFrameUrl = (sap.ui.require.toUrl((sIframePath + "/" + sIframeWithoutUI5Ending).replace(/\./g, "/")) + sFileEnding || ".html")
-									+ "?sap-ui-theme=" + sap.ui.getCore().getConfiguration().getTheme();
-									this._oHtmlControl.getDomRef().src = this.sIFrameUrl;
-								}
-								this._oHtmlControl.getDomRef().contentWindow.postMessage({
-									type: "SETTINGS",
-									reason: "set",
-									data: {
-										"density": this.getOwnerComponent().getContentDensityClass(),
-										"RTL": oConfiguration.getRTL(),
-										"theme": oConfiguration.getTheme()
-									}
-								}, this.getOwnerComponent()._sSampleIframeOrigin);
-								this.fResolve(eMessage.data.config.sample);
-							} else if (eMessage.data.type === "ERR") {
-								this.fReject(eMessage.data.data.msg);
-							} else if (eMessage.data.type === "RTA") {
-								this._loadRTA.call(this);
-							}
-						}.bind(this);
-
-						this._oHtmlControl = new HTML({
-							id : "sampleFrame",
-							content : '<iframe src="' + this.sIFrameUrl + '" id="sampleFrame" frameBorder="0"></iframe>'
-						}).addEventDelegate({
-							onBeforeRendering: function () {
-								window.removeEventListener("message", fnMessage);
-							}
-						})
-						.addEventDelegate({
-							onAfterRendering: function () {
-								window.addEventListener("message", fnMessage);
-							}
-						});
-					} else {
-						// If we already have the control just navigate to the new URL
-						this._oHtmlControl.getDomRef().src = this.sIFrameUrl;
+						sSampleVersion = ResourcesUtil.getResourcesVersion(),
+						sSampleSearchParams = "";
+
+					// 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);
+						}
+					});
+
+					sSampleSearchParams = (sSampleSearchParams === "" ? "?" : sSampleSearchParams + "&") +
+					"sap-ui-xx-sample-id=" + sSampleId
+					+ "&sap-ui-xx-sample-origin=" + sSampleOrigin + sSampleVersion
+					+ "&sap-ui-xx-dk-origin=" + window.location.origin;
+
+					this.sIFrameUrl = ResourcesUtil.getResourceOrigin() + "/resources/sap/ui/documentation/sdk/index.html" + sSampleSearchParams;
+
+					if (this._oHtmlControl) {
+						this._oHtmlControl.destroy();
 					}
+
+					var fnMessage =  function (eMessage) {
+						if (eMessage.data.type === "INIT") {
+							var oConfiguration = sap.ui.getCore().getConfiguration();
+							if (eMessage.data.config && eMessage.data.config.sample && eMessage.data.config.sample.iframe) {
+								sSampleId = this._sId;
+								vIframe = eMessage.data.config.sample.iframe;
+								sIframePath = this._resolveIframePath(sSampleId, vIframe);
+
+								//vlaid only for samples that contains own index.html
+								// strip the file extension to be able to use jQuery.sap.getModulePath
+								aFileNameMatches = rExtractFilename.exec(vIframe);
+								sFileName = (aFileNameMatches && aFileNameMatches.length > 1 ? aFileNameMatches[1] : vIframe);
+								sFileEnding = rStripUI5Ending.exec(sFileName)[0];
+								var sIframeWithoutUI5Ending = sFileName.replace(rStripUI5Ending, "");
+
+								// combine namespace with the file name again
+								this.sIFrameUrl = (sap.ui.require.toUrl((sIframePath + "/" + sIframeWithoutUI5Ending).replace(/\./g, "/")) + sFileEnding || ".html")
+								+ "?sap-ui-theme=" + sap.ui.getCore().getConfiguration().getTheme();
+								this._oHtmlControl.getDomRef().src = this.sIFrameUrl;
+							}
+							this._oHtmlControl.getDomRef().contentWindow.postMessage({
+								type: "SETTINGS",
+								reason: "set",
+								data: {
+									"density": this.getOwnerComponent().getContentDensityClass(),
+									"RTL": oConfiguration.getRTL(),
+									"theme": oConfiguration.getTheme()
+								}
+							}, this.getOwnerComponent()._sSampleIframeOrigin);
+							this.fResolve(eMessage.data.config.sample);
+						} else if (eMessage.data.type === "ERR") {
+							this.fReject(eMessage.data.data.msg);
+						} else if (eMessage.data.type === "RTA") {
+							this._loadRTA.call(this);
+						}
+					}.bind(this);
+
+					this._oHtmlControl = new HTML({
+						id : "sampleFrame",
+						content : '<iframe src="' + this.sIFrameUrl + '" id="sampleFrame" frameBorder="0"></iframe>'
+					}).addEventDelegate({
+						onBeforeRendering: function () {
+							window.removeEventListener("message", fnMessage);
+						}
+					})
+					.addEventDelegate({
+						onAfterRendering: function () {
+							window.addEventListener("message", fnMessage);
+						}
+					});
+
 					this.byId("page").removeAllContent();
 					this.byId("page").addContent(this._oHtmlControl);
 

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

@@ -69,6 +69,11 @@ sap.ui.define([],
 				"id": "flexibleProgrammingModelExplorer",
 				"text": "Flexible Programming Model Explorer",
 				"href": "https://sapui5.hana.ondemand.com/test-resources/sap/fe/core/fpmExplorer/index.html#/overview/introduction"
+			},
+			{
+				"id": "accessibilityGuide",
+				"text": "Accessibility Guide",
+				"href": "test-resources/sap/m/demokit/accessibilityGuide/webapp/index.html"
 			}
 		];
 

package/src/sap/ui/documentation/sdk/index.html

@@ -3,6 +3,7 @@
 <head>
 	<meta charset="utf-8">
 	<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+	<meta http-equiv="Content-Security-Policy" content="script-src 'self' 'unsafe-inline' 'unsafe-eval';"/>
 	<title>SAPUI5 Navigation</title>
 	<script>
 
@@ -10,32 +11,42 @@
 			return new window.URLSearchParams(window.location.search).get(sParamName);
 		};
 
-		var encodeOrigin = function (sResourceOrigin) {
-			return sResourceOrigin
-					.replaceAll("&", "&amp;")
-					.replaceAll("<", "&lt;")
-					.replaceAll(">", "&gt;")
-					.replaceAll("\"", "&quot;")
-					.replaceAll("’", "&#x27;");
-		};
-
 		var sSampleId = getUrlParam('sap-ui-xx-sample-id'),
 				sOrigin = getUrlParam('sap-ui-xx-sample-origin'),
 				sPresetTheme = getUrlParam('sap-ui-theme') || 'sap_fiori_3',
 				sPresetRTL = getUrlParam('sap-ui-rtl') || false,
-				oPath = {};
+				oPath = {},
+				sOriginEncoded,
+				oBaseTag,
+				oScriptTag;
 
 		if (sOrigin === "" || sOrigin === ".") {
 			var sHref = document.location.href;
 			sOrigin = sHref.substring(0, sHref.lastIndexOf('resources/sap/ui/documentation/sdk/') - 1);
+		} else {
+			sOrigin = new URL(sOrigin, document.baseURI).pathname;
 		}
 
-		oPath["sap/ui/demo/mock"] = sOrigin + "/test-resources/sap/ui/documentation/sdk";
+		sOriginEncoded = encodeURI(sOrigin);
+
+		oPath["sap/ui/demo/mock"] = sOriginEncoded + "/test-resources/sap/ui/documentation/sdk";
 		oPath["test-resources/sap/ui/documentation/sdk"] = ".";
 
-		document.write("<script src=" + encodeOrigin(sOrigin)  + '/resources/sap-ui-core.js' + " id='sap-ui-bootstrap' " +
-				"data-sap-ui-libs='sap.m' data-sap-ui-bindingSyntax='complex' data-sap-ui-rtl=" + sPresetRTL + " data-sap-ui-theme=" + sPresetTheme + " data-sap-ui-compatVersion='edge' data-sap-ui-resourceroots=" + JSON.stringify(oPath) + "></scr" + "ipt>");
-		document.write("<base href=" + encodeOrigin(sOrigin) + "/>");
+		oBaseTag = document.createElement("base");
+		oBaseTag.setAttribute("href", sOriginEncoded + "/");
+		document.head.appendChild(oBaseTag);
+
+		oScriptTag = document.createElement("script");
+		oScriptTag.setAttribute("src", sOriginEncoded + "/resources/sap-ui-core.js");
+		oScriptTag.setAttribute("id", "sap-ui-bootstrap");
+		oScriptTag.setAttribute("data-sap-ui-compatVersion", "edge");
+		oScriptTag.dataset.sapUiAsync = true;
+		oScriptTag.dataset.sapUiLibs = "sap.m";
+		oScriptTag.dataset.sapUiRtl = sPresetRTL;
+		oScriptTag.dataset.sapUiResourceroots = JSON.stringify(oPath);
+		oScriptTag.dataset.sapUiTheme = sPresetTheme;
+
+		document.write(oScriptTag.outerHTML);
 	</script>
 </head>
 <body class="sapUiBody sapUiSizeCompact" id="content">
@@ -49,6 +60,9 @@
 			"sap/base/Log"
 		], function (ComponentContainer, Component, library, ControlsInfo, Log) {
 
+			var oLibraryInfoSingleton = library._getLibraryInfoSingleton();
+			oLibraryInfoSingleton.getResourceUrl = undefined;
+
 			var loadInfo = function() {
 				return new Promise(function (resolve) {
 					var fnCallback = function(oAppInfo) {
@@ -56,7 +70,7 @@
 							var aLibPromises = [];
 							oAppInfo.libraries.forEach(function(oLib) {
 								var oLibPromise = new Promise(function(innResolve) {
-									library._getLibraryInfoSingleton()._getDocuIndex(oLib.name, function(oDoc) {
+									oLibraryInfoSingleton._getDocuIndex(oLib.name, function(oDoc) {
 									if (!oDoc.explored) {
 										innResolve();
 										return;

package/src/sap/ui/documentation/sdk/model/libraryData.js

@@ -12,6 +12,10 @@ sap.ui.define([
 ],function(library, Log, extend, isPlainObject) {
 	"use strict";
 
+	var IGNORED_GATEGORIES = {
+		Template: "Template"
+	};
+
 	// function to compute the app objects for a demo object
 	function createDemoAppData(oDemoAppMetadata, sLibUrl, sLibNamespace) {
 		// transform simple demo app link to a configuration object
@@ -91,6 +95,11 @@ sap.ui.define([
 			if (oDemo.links && oDemo.links.length > 0) {
 				for (var j = 0; j < oDemo.links.length; j++) {
 					var oDemoAppData = createDemoAppData(oDemo.links[j], oDocIndicies[aLibs[i]].libraryUrl, oDemo.text);
+
+					if (IGNORED_GATEGORIES[oDemoAppData.category]) {
+						continue;
+					}
+
 					oData.demoApps.push(oDemoAppData);
 
 					// push demo app into helper structure

package/src/sap/ui/documentation/sdk/view/Tools.view.xml

@@ -427,6 +427,25 @@
 					</VBox>
 				</f:content>
 			</f:Card>
+			<!-- Accessibility Guide -->
+			<f:Card class="threeColumnLayoutCard" visible="{=! (${device>/system/phone} || ${device>/browser/msie}) }">
+				<f:content>
+					<VBox justifyContent="SpaceBetween">
+						<VBox class="sapUiSmallMargin toolspageCardInfo">
+							<html:div class="sapUIDisclaimerLink sapUiSmallMarginBottom">
+								<custom:TitleLink
+										level="H1"
+										titleStyle="H1"
+										text="{/accessibilityGuide/text}"
+										href="{/accessibilityGuide/href}"
+										target="_blank"/>
+							</html:div>
+							<Text class="sapUiSmallMarginBottom" text="{i18n>TOOLS_CARD_15_TEXT}" />
+						</VBox>
+						<Image src="./resources/sap/ui/documentation/sdk/images/tools/AccessibilityGuide.png" class="toolsPageImage" alt="{i18n>TOOLS_CARD_15_IMG_ALT}"/>
+					</VBox>
+				</f:content>
+			</f:Card>
 		</l:Grid>
 		<l:BlockLayout>
 			<l:BlockLayoutRow>