feat: busy indicator enablement (#4832)

Author: nnaydenow

packages/base/hash.txt

@@ -1 +1 @@
-AXnXP+HNJ449c6TcmXLSNTrc9EU=
+1E1MO0DdDCKt3QOSKoxy/b3JIQE=

packages/base/src/UI5Element.js

@@ -46,6 +46,8 @@ function _invalidate(changeInfo) {
 	this._eventProvider.fireEvent("invalidate", { ...changeInfo, target: this });
 }
 
+let metadata = {};
+
 /**
  * Base class for all UI5 Web Components
  *
@@ -896,7 +898,15 @@ class UI5Element extends HTMLElement {
 	 * @protected
 	 */
 	static get metadata() {
-		return {};
+		return metadata;
+	}
+
+	/**
+	 * Sets a new metadata object for this UI5 Web Component Class
+	 * @protected
+	 */
+	static set metadata(newMetadata) {
+		metadata = newMetadata;
 	}
 
 	/**

packages/base/src/css/BusyIndicator.css

@@ -0,0 +1,76 @@
+.busy-indicator-wrapper {
+    position: relative;
+    height: 100%;
+    width: 100%;
+}
+
+.busy-indicator-overlay {
+    display: var(--ui5_web_components_busy_indicator_display);
+    position: absolute;
+    inset: 0;
+    background: var(--ui5_web_components_busy_indicator_background-color);
+    z-index: 99;
+}
+
+.busy-indicator-busy-area {
+    display: var(--ui5_web_components_busy_indicator_display);
+    position: absolute;
+    z-index: 99;
+    inset: 0;
+    justify-content: center;
+    align-items: center;
+    background-color: inherit;
+    flex-direction: column;
+    color: var(--_ui5_busy_indicator_color);
+}
+
+:host([__is-busy]) .busy-indicator-wrapper > :not(.busy-indicator-busy-area):not(.busy-indicator-overlay):not([busy-indicator-before-span]) {
+    --ui5_web_components_busy_indicator_display: none;
+}
+
+.busy-indicator-busy-area:focus {
+    outline: var(--_ui5_busy_indicator_focus_outline);
+    outline-offset: -.125rem;
+}
+
+.busy-indicator-circle {
+    width: 1rem;
+    height: 1rem;
+    display: inline-block;
+    background-color: currentColor;
+    border-radius: 50%;
+}
+
+.circle-animation-0 {
+    animation: grow 1.6s infinite cubic-bezier(0.32, 0.06, 0.85, 1.11);
+}
+
+.circle-animation-1 {
+    animation: grow 1.6s infinite cubic-bezier(0.32, 0.06, 0.85, 1.11);
+    animation-delay: 200ms;
+}
+
+.circle-animation-2 {
+    animation: grow 1.6s infinite cubic-bezier(0.32, 0.06, 0.85, 1.11);
+    animation-delay: 400ms;
+}
+
+.sapUiLocalBusy {
+	--ui5_web_components_busy_indicator_display: none;
+}
+
+@keyframes grow {
+    0%, 50%, 100% {
+        -webkit-transform: scale(0.5);
+        -moz-transform: scale(0.5);
+        -ms-transform: scale(0.5);
+        transform: scale(0.5);
+    }
+
+    25% {
+        -webkit-transform: scale(1);
+        -moz-transform: scale(1);
+        -ms-transform: scale(1);
+        transform: scale(1);
+    }
+}

packages/base/src/features/OpenUI5Enablement.js

@@ -0,0 +1,119 @@
+import { registerFeature } from "../FeaturesRegistry.js";
+import BusyIndicatorStyles from "../generated/css/BusyIndicator.css.js";
+import merge from "../thirdparty/merge.js";
+import {
+	isTabPrevious,
+} from "../Keys.js";
+
+const busyIndicatorMetadata = {
+	properties: {
+		__isBusy: {
+			type: Boolean,
+		},
+	},
+};
+
+const getBusyIndicatorStyles = () => {
+	return BusyIndicatorStyles;
+};
+
+const wrapTemplateResultInBusyMarkup = (html, host, templateResult) => {
+	if (host.isOpenUI5Component && host.__isBusy) {
+		templateResult = html`
+		<div class="busy-indicator-wrapper">
+			<span tabindex="0" busy-indicator-before-span @focusin=${host.__suppressFocusIn}></span>
+			${templateResult}
+			<div class="busy-indicator-overlay"></div>
+			<div busy-indicator
+				class="busy-indicator-busy-area"
+				tabindex="0"
+				role="progressbar"
+				@keydown=${host.__suppressFocusBack}
+				aria-valuemin="0"
+				aria-valuemax="100"
+				aria-valuetext="Busy">
+				<div>
+					<div class="busy-indicator-circle circle-animation-0"></div>
+					<div class="busy-indicator-circle circle-animation-1"></div>
+					<div class="busy-indicator-circle circle-animation-2"></div>
+				</div>
+			</div>
+		</div>`;
+	}
+
+	return templateResult;
+};
+
+const enrichBusyIndicatorMetadata = UI5Element => {
+	UI5Element.metadata = merge(UI5Element.metadata, busyIndicatorMetadata);
+};
+
+const enrichBusyIndicatorMethods = UI5ElementPrototype => {
+	Object.defineProperties(UI5ElementPrototype, {
+		"__redirectFocus": { value: true, writable: true },
+		"__suppressFocusBack": {
+			get() {
+				const that = this;
+
+				return {
+					handleEvent: e => {
+						if (isTabPrevious(e)) {
+							const beforeElem = that.shadowRoot.querySelector("[busy-indicator-before-span]");
+							that.__redirectFocus = false;
+							beforeElem.focus();
+							that.__redirectFocus = true;
+						}
+					},
+					capture: true,
+					passive: false,
+				};
+			},
+		},
+		"isOpenUI5Component": { get: () => { return true; } },
+	});
+
+	UI5ElementPrototype.__suppressFocusIn = function handleFocusIn() {
+		const busyIndicator = this.shadowRoot.querySelector("[busy-indicator]");
+		if (busyIndicator && this.__redirectFocus) {
+			busyIndicator.focus();
+		}
+	};
+
+	UI5ElementPrototype.getDomRef = function getDomRef() {
+		// If a component set _getRealDomRef to its children, use the return value of this function
+		if (typeof this._getRealDomRef === "function") {
+			return this._getRealDomRef();
+		}
+
+		if (!this.shadowRoot || this.shadowRoot.children.length === 0) {
+			return;
+		}
+
+		const children = [...this.shadowRoot.children].filter(child => !["link", "style"].includes(child.localName));
+
+		if (children.length !== 1) {
+			console.warn(`The shadow DOM for ${this.constructor.getMetadata().getTag()} does not have a top level element, the getDomRef() method might not work as expected`); // eslint-disable-line
+		}
+
+		if (this.__isBusy) {
+			return children[0].querySelector(".busy-indicator-wrapper > :not([busy-indicator-before-span]):not(.busy-indicator-overlay):not(.busy-indicator-busy-area)");
+		}
+
+		return children[0];
+	};
+};
+
+const enrichBusyIndicatorSettings = UI5Element => {
+	enrichBusyIndicatorMetadata(UI5Element);
+	enrichBusyIndicatorMethods(UI5Element.prototype);
+};
+
+const OpenUI5Enablement = {
+	enrichBusyIndicatorSettings,
+	wrapTemplateResultInBusyMarkup,
+	getBusyIndicatorStyles,
+};
+
+export default OpenUI5Enablement;
+
+registerFeature("OpenUI5Enablement", OpenUI5Enablement);

packages/base/src/renderer/LitRenderer.js

@@ -17,7 +17,12 @@ const effectiveSvg = (...args) => {
 	return fn(...args);
 };
 
-const litRender = (templateResult, domNode, styleStrOrHrefsArr, { host } = {}) => {
+const litRender = (templateResult, domNode, styleStrOrHrefsArr, forStaticArea, { host } = {}) => {
+	const OpenUI5Enablement = getFeature("OpenUI5Enablement");
+	if (OpenUI5Enablement && !forStaticArea) {
+		templateResult = OpenUI5Enablement.wrapTemplateResultInBusyMarkup(effectiveHtml, host, templateResult);
+	}
+
 	if (typeof styleStrOrHrefsArr === "string") {
 		templateResult = effectiveHtml`<style>${styleStrOrHrefsArr}</style>${templateResult}`;
 	} else if (Array.isArray(styleStrOrHrefsArr) && styleStrOrHrefsArr.length) {

packages/base/src/theming/getEffectiveLinksHrefs.js

@@ -1,11 +1,14 @@
 import { getUrl } from "../CSP.js";
+import { getFeature } from "../FeaturesRegistry.js";
 
 const flatten = arr => {
 	return arr.reduce((acc, val) => acc.concat(Array.isArray(val) ? flatten(val) : val), []);
 };
 
 const getEffectiveLinksHrefs = (ElementClass, forStaticArea = false) => {
 	let stylesData = ElementClass[forStaticArea ? "staticAreaStyles" : "styles"];
+	const OpenUI5Enablement = getFeature("OpenUI5Enablement");
+
 	if (!stylesData) {
 		return;
 	}
@@ -14,6 +17,10 @@ const getEffectiveLinksHrefs = (ElementClass, forStaticArea = false) => {
 		stylesData = [stylesData];
 	}
 
+	if (OpenUI5Enablement) {
+		stylesData.push(OpenUI5Enablement.getBusyIndicatorStyles());
+	}
+
 	return flatten(stylesData).filter(data => !!data).map(data => getUrl(data.packageName, data.fileName));
 };
 

packages/base/src/theming/getEffectiveStyle.js

@@ -1,5 +1,6 @@
 import { getCustomCSS, attachCustomCSSChange } from "./CustomStyle.js";
 import getStylesString from "./getStylesString.js";
+import { getFeature } from "../FeaturesRegistry.js";
 
 const effectiveStyleMap = new Map();
 
@@ -10,9 +11,15 @@ attachCustomCSSChange(tag => {
 const getEffectiveStyle = (ElementClass, forStaticArea = false) => {
 	const tag = ElementClass.getMetadata().getTag();
 	const key = `${tag}_${forStaticArea ? "static" : "normal"}`;
+	const OpenUI5Enablement = getFeature("OpenUI5Enablement");
 
 	if (!effectiveStyleMap.has(key)) {
 		let effectiveStyle;
+		let busyIndicatorStyles = "";
+
+		if (OpenUI5Enablement) {
+			busyIndicatorStyles = getStylesString(OpenUI5Enablement.getBusyIndicatorStyles());
+		}
 
 		if (forStaticArea) {
 			effectiveStyle = getStylesString(ElementClass.staticAreaStyles);
@@ -21,6 +28,8 @@ const getEffectiveStyle = (ElementClass, forStaticArea = false) => {
 			const builtInStyles = getStylesString(ElementClass.styles);
 			effectiveStyle = `${builtInStyles} ${customStyle}`;
 		}
+
+		effectiveStyle = `${effectiveStyle} ${busyIndicatorStyles}`;
 		effectiveStyleMap.set(key, effectiveStyle);
 	}
 

packages/base/src/updateShadowRoot.js

@@ -24,7 +24,7 @@ const updateShadowRoot = (element, forStaticArea = false) => {
 		styleStrOrHrefsArr = getEffectiveStyle(element.constructor, forStaticArea);
 	}
 
-	element.constructor.render(renderResult, shadowRoot, styleStrOrHrefsArr, { host: element });
+	element.constructor.render(renderResult, shadowRoot, styleStrOrHrefsArr, forStaticArea, { host: element });
 };
 
 export default updateShadowRoot;