@ui5/webcomponents-base 0.0.0-aeb93167c → 0.0.0-b053ad005

package/src/Render.js

@@ -0,0 +1,175 @@
+import EventProvider from "./EventProvider.js";
+import RenderQueue from "./RenderQueue.js";
+import { getAllRegisteredTags } from "./CustomElementsRegistry.js";
+import { isRtlAware } from "./locale/RTLAwareRegistry.js";
+
+const registeredElements = new Set();
+const eventProvider = new EventProvider();
+
+const invalidatedWebComponents = new RenderQueue(); // Queue for invalidated web components
+
+let renderTaskPromise,
+	renderTaskPromiseResolve;
+
+let mutationObserverTimer;
+
+let queuePromise;
+
+/**
+ * Schedules a render task (if not already scheduled) to render the component
+ *
+ * @param webComponent
+ * @returns {Promise}
+ */
+const renderDeferred = async webComponent => {
+	// Enqueue the web component
+	invalidatedWebComponents.add(webComponent);
+
+	// Schedule a rendering task
+	await scheduleRenderTask();
+};
+
+/**
+ * Renders a component synchronously and adds it to the registry of rendered components
+ *
+ * @param webComponent
+ */
+const renderImmediately = webComponent => {
+	eventProvider.fireEvent("beforeComponentRender", webComponent);
+	registeredElements.add(webComponent);
+	webComponent._render();
+};
+
+/**
+ * Cancels the rendering of a component, if awaiting to be rendered, and removes it from the registry of rendered components
+ *
+ * @param webComponent
+ */
+const cancelRender = webComponent => {
+	invalidatedWebComponents.remove(webComponent);
+	registeredElements.delete(webComponent);
+};
+
+/**
+ * Schedules a rendering task, if not scheduled already
+ */
+const scheduleRenderTask = async () => {
+	if (!queuePromise) {
+		queuePromise = new Promise(resolve => {
+			window.requestAnimationFrame(() => {
+				// Render all components in the queue
+
+				// console.log(`--------------------RENDER TASK START------------------------------`); // eslint-disable-line
+				invalidatedWebComponents.process(renderImmediately);
+				// console.log(`--------------------RENDER TASK END------------------------------`); // eslint-disable-line
+
+				// Resolve the promise so that callers of renderDeferred can continue
+				queuePromise = null;
+				resolve();
+
+				// Wait for Mutation observer before the render task is considered finished
+				if (!mutationObserverTimer) {
+					mutationObserverTimer = setTimeout(() => {
+						mutationObserverTimer = undefined;
+						if (invalidatedWebComponents.isEmpty()) {
+							_resolveTaskPromise();
+						}
+					}, 200);
+				}
+			});
+		});
+	}
+
+	await queuePromise;
+};
+
+/**
+ * return a promise that will be resolved once all invalidated web components are rendered
+ */
+const whenDOMUpdated = () => {
+	if (renderTaskPromise) {
+		return renderTaskPromise;
+	}
+
+	renderTaskPromise = new Promise(resolve => {
+		renderTaskPromiseResolve = resolve;
+		window.requestAnimationFrame(() => {
+			if (invalidatedWebComponents.isEmpty()) {
+				renderTaskPromise = undefined;
+				resolve();
+			}
+		});
+	});
+
+	return renderTaskPromise;
+};
+
+const whenAllCustomElementsAreDefined = () => {
+	const definedPromises = getAllRegisteredTags().map(tag => customElements.whenDefined(tag));
+	return Promise.all(definedPromises);
+};
+
+const renderFinished = async () => {
+	await whenAllCustomElementsAreDefined();
+	await whenDOMUpdated();
+};
+
+const _resolveTaskPromise = () => {
+	if (!invalidatedWebComponents.isEmpty()) {
+		// More updates are pending. Resolve will be called again
+		return;
+	}
+
+	if (renderTaskPromiseResolve) {
+		renderTaskPromiseResolve();
+		renderTaskPromiseResolve = undefined;
+		renderTaskPromise = undefined;
+	}
+};
+
+/**
+ * Re-renders all UI5 Elements on the page, with the option to specify filters to rerender only some components.
+ *
+ * Usage:
+ * reRenderAllUI5Elements() -> re-renders all components
+ * reRenderAllUI5Elements({tag: "ui5-button"}) -> re-renders only instances of ui5-button
+ * reRenderAllUI5Elements({rtlAware: true}) -> re-renders only rtlAware components
+ * reRenderAllUI5Elements({languageAware: true}) -> re-renders only languageAware components
+ * reRenderAllUI5Elements({themeAware: true}) -> re-renders only themeAware components
+ * reRenderAllUI5Elements({rtlAware: true, languageAware: true}) -> re-renders components that are rtlAware or languageAware
+ * etc...
+ *
+ * @public
+ * @param {Object|undefined} filters - Object with keys that can be "rtlAware" or "languageAware"
+ * @returns {Promise<void>}
+ */
+const reRenderAllUI5Elements = async filters => {
+	registeredElements.forEach(element => {
+		const tag = element.constructor.getMetadata().getTag();
+		const rtlAware = isRtlAware(element.constructor);
+		const languageAware = element.constructor.getMetadata().isLanguageAware();
+		const themeAware = element.constructor.getMetadata().isThemeAware();
+		if (!filters || (filters.tag === tag) || (filters.rtlAware && rtlAware) || (filters.languageAware && languageAware) || (filters.themeAware && themeAware)) {
+			renderDeferred(element);
+		}
+	});
+	await renderFinished();
+};
+
+const attachBeforeComponentRender = listener => {
+	eventProvider.attachEvent("beforeComponentRender", listener);
+};
+
+const detachBeforeComponentRender = listener => {
+	eventProvider.detachEvent("beforeComponentRender", listener);
+};
+
+export {
+	renderDeferred,
+	renderImmediately,
+	cancelRender,
+	renderFinished,
+	reRenderAllUI5Elements,
+	attachBeforeComponentRender,
+	detachBeforeComponentRender,
+};

package/src/RenderScheduler.js

@@ -1,165 +1,43 @@
-import RenderQueue from "./RenderQueue.js";
-import { getAllRegisteredTags } from "./CustomElementsRegistry.js";
-import { isRtlAware } from "./locale/RTLAwareRegistry.js";
-
-const registeredElements = new Set();
-
-// Queue for invalidated web components
-const invalidatedWebComponents = new RenderQueue();
-
-let renderTaskPromise,
-	renderTaskPromiseResolve;
-
-let mutationObserverTimer;
-
-let queuePromise;
+import {
+	renderDeferred,
+	renderImmediately,
+	renderFinished,
+} from "./Render.js";
 
 /**
- * Class that manages the rendering/re-rendering of web components
- * This is always asynchronous
+ * @deprecated Use the Render.js module instead
  */
 class RenderScheduler {
-	constructor() {
-		throw new Error("Static class");
-	}
-
 	/**
 	 * Schedules a render task (if not already scheduled) to render the component
 	 *
 	 * @param webComponent
 	 * @returns {Promise}
+	 * @deprecated Use renderDeferred from the Render.js module instead
 	 */
 	static async renderDeferred(webComponent) {
-		// Enqueue the web component
-		invalidatedWebComponents.add(webComponent);
-
-		// Schedule a rendering task
-		await RenderScheduler.scheduleRenderTask();
+		console.log("RenderScheduler.renderDeferred is deprecated, please use renderDeferred, exported by Render.js instead"); // eslint-disable-line
+		await renderDeferred(webComponent);
 	}
 
 	/**
 	 * Renders a component synchronously
 	 *
 	 * @param webComponent
+	 * @deprecated Use renderImmediately from the Render.js module instead
 	 */
 	static renderImmediately(webComponent) {
-		webComponent._render();
-	}
-
-	/**
-	 * Cancels the rendering of a component, added to the queue with renderDeferred
-	 *
-	 * @param webComponent
-	 */
-	static cancelRender(webComponent) {
-		invalidatedWebComponents.remove(webComponent);
-	}
-
-	/**
-	 * Schedules a rendering task, if not scheduled already
-	 */
-	static async scheduleRenderTask() {
-		if (!queuePromise) {
-			queuePromise = new Promise(resolve => {
-				window.requestAnimationFrame(() => {
-					// Render all components in the queue
-					invalidatedWebComponents.process(component => component._render());
-
-					// Resolve the promise so that callers of renderDeferred can continue
-					queuePromise = null;
-					resolve();
-
-					// Wait for Mutation observer before the render task is considered finished
-					if (!mutationObserverTimer) {
-						mutationObserverTimer = setTimeout(() => {
-							mutationObserverTimer = undefined;
-							if (invalidatedWebComponents.isEmpty()) {
-								RenderScheduler._resolveTaskPromise();
-							}
-						}, 200);
-					}
-				});
-			});
-		}
-
-		await queuePromise;
+		console.log("RenderScheduler.renderImmediately is deprecated, please use renderImmediately, exported by Render.js instead"); // eslint-disable-line
+		return renderImmediately(webComponent);
 	}
 
 	/**
-	 * return a promise that will be resolved once all invalidated web components are rendered
+	 * @deprecated Use renderFinished from the Render.js module instead
+	 * @returns {Promise<void>}
 	 */
-	static whenDOMUpdated() {
-		if (renderTaskPromise) {
-			return renderTaskPromise;
-		}
-
-		renderTaskPromise = new Promise(resolve => {
-			renderTaskPromiseResolve = resolve;
-			window.requestAnimationFrame(() => {
-				if (invalidatedWebComponents.isEmpty()) {
-					renderTaskPromise = undefined;
-					resolve();
-				}
-			});
-		});
-
-		return renderTaskPromise;
-	}
-
-	static whenAllCustomElementsAreDefined() {
-		const definedPromises = getAllRegisteredTags().map(tag => customElements.whenDefined(tag));
-		return Promise.all(definedPromises);
-	}
-
 	static async whenFinished() {
-		await RenderScheduler.whenAllCustomElementsAreDefined();
-		await RenderScheduler.whenDOMUpdated();
-	}
-
-	static _resolveTaskPromise() {
-		if (!invalidatedWebComponents.isEmpty()) {
-			// More updates are pending. Resolve will be called again
-			return;
-		}
-
-		if (renderTaskPromiseResolve) {
-			renderTaskPromiseResolve.call(this);
-			renderTaskPromiseResolve = undefined;
-			renderTaskPromise = undefined;
-		}
-	}
-
-	static register(element) {
-		registeredElements.add(element);
-	}
-
-	static deregister(element) {
-		registeredElements.delete(element);
-	}
-
-	/**
-	 * Re-renders all UI5 Elements on the page, with the option to specify filters to rerender only some components.
-	 *
-	 * Usage:
-	 * reRenderAllUI5Elements() -> rerenders all components
-	 * reRenderAllUI5Elements({tag: "ui5-button"}) -> re-renders only instances of ui5-button
-	 * reRenderAllUI5Elements({rtlAware: true}) -> re-renders only rtlAware components
-	 * reRenderAllUI5Elements({languageAware: true}) -> re-renders only languageAware components
-	 * reRenderAllUI5Elements({rtlAware: true, languageAware: true}) -> re-renders components that are rtlAware or languageAware
-	 * etc...
-	 *
-	 * @public
-	 * @param {Object|undefined} filters - Object with keys that can be "rtlAware" or "languageAware"
-	 */
-	static reRenderAllUI5Elements(filters) {
-		registeredElements.forEach(element => {
-			const tag = element.constructor.getMetadata().getTag();
-			const rtlAware = isRtlAware(element.constructor);
-			const languageAware = element.constructor.getMetadata().isLanguageAware();
-			if (!filters || (filters.tag === tag) || (filters.rtlAware && rtlAware) || (filters.languageAware && languageAware)) {
-				RenderScheduler.renderDeferred(element);
-			}
-		});
+		console.log("RenderScheduler.whenFinished is deprecated, please use renderFinished, exported by Render.js instead"); // eslint-disable-line
+		await renderFinished();
 	}
 }
 

package/src/StaticArea.js

@@ -1,31 +1,3 @@
-import getSingletonElementInstance from "./util/getSingletonElementInstance.js";
-
-const getStaticAreaInstance = () => getSingletonElementInstance("ui5-static-area");
-
-const removeStaticArea = () => {
-	getStaticAreaInstance().destroy();
-};
-
-class StaticAreaElement extends HTMLElement {
-	constructor() {
-		super();
-	}
-
-	get isUI5Element() {
-		return true;
-	}
-
-	destroy() {
-		const staticAreaDomRef = document.querySelector(this.tagName.toLowerCase());
-		staticAreaDomRef.parentElement.removeChild(staticAreaDomRef);
-	}
-}
-
 if (!customElements.get("ui5-static-area")) {
-	customElements.define("ui5-static-area", StaticAreaElement);
+	customElements.define("ui5-static-area", class extends HTMLElement {});
 }
-
-export {
-	getStaticAreaInstance,
-	removeStaticArea,
-};

package/src/StaticAreaItem.js

@@ -1,80 +1,64 @@
-import { getStaticAreaInstance, removeStaticArea } from "./StaticArea.js";
-import RenderScheduler from "./RenderScheduler.js";
-import getStylesString from "./theming/getStylesString.js";
-import executeTemplate from "./renderer/executeTemplate.js";
+import "./StaticArea.js";
+import updateShadowRoot from "./updateShadowRoot.js";
+import { renderFinished } from "./Render.js";
+import getEffectiveContentDensity from "./util/getEffectiveContentDensity.js";
+import { getEffectiveScopingSuffixForTag } from "./CustomElementsScope.js";
+import getEffectiveDir from "./locale/getEffectiveDir.js";
 
 /**
+ *
  * @class
  * @author SAP SE
  * @private
- * Defines and takes care of ui5-static-are-item items
  */
-class StaticAreaItem {
-	constructor(_ui5ElementContext) {
-		this.ui5ElementContext = _ui5ElementContext;
+class StaticAreaItem extends HTMLElement {
+	constructor() {
+		super();
 		this._rendered = false;
-	}
-
-	isRendered() {
-		return this._rendered;
+		this.attachShadow({ mode: "open" });
 	}
 
 	/**
 	 * @protected
+	 * @param ownerElement The UI5Element instance that owns this static area item
 	 */
-	_updateFragment() {
-		const renderResult = executeTemplate(this.ui5ElementContext.constructor.staticAreaTemplate, this.ui5ElementContext),
-			stylesToAdd = window.ShadyDOM ? false : getStylesString(this.ui5ElementContext.constructor.staticAreaStyles);
-
-		if (!this.staticAreaItemDomRef) {
-			// Initial rendering of fragment
-
-			this.staticAreaItemDomRef = document.createElement("ui5-static-area-item");
-			this.staticAreaItemDomRef.attachShadow({ mode: "open" });
-			this.staticAreaItemDomRef.classList.add(this.ui5ElementContext._id); // used for getting the popover in the tests
-
-			getStaticAreaInstance().appendChild(this.staticAreaItemDomRef);
-			this._rendered = true;
-		}
-
-		this._updateContentDensity(this.ui5ElementContext.isCompact);
-		this.ui5ElementContext.constructor.render(renderResult, this.staticAreaItemDomRef.shadowRoot, stylesToAdd, { eventContext: this.ui5ElementContext });
+	setOwnerElement(ownerElement) {
+		this.ownerElement = ownerElement;
+		this.classList.add(this.ownerElement._id); // used for getting the popover in the tests
 	}
 
 	/**
+	 * Updates the shadow root of the static area item with the latest state, if rendered
 	 * @protected
 	 */
-	_removeFragmentFromStaticArea() {
-		if (!this.staticAreaItemDomRef) {
-			return;
-		}
-
-		const staticArea = getStaticAreaInstance();
-
-		staticArea.removeChild(this.staticAreaItemDomRef);
-
-		this.staticAreaItemDomRef = null;
-
-		// remove static area
-		if (staticArea.childElementCount < 1) {
-			removeStaticArea();
+	update() {
+		if (this._rendered) {
+			this._updateContentDensity();
+			this._updateDirection();
+			updateShadowRoot(this.ownerElement, true);
 		}
 	}
 
 	/**
-	 * @protected
+	 * Sets the correct content density based on the owner element's state
+	 * @private
 	 */
-	_updateContentDensity(isCompact) {
-		if (!this.staticAreaItemDomRef) {
-			return;
+	_updateContentDensity() {
+		if (getEffectiveContentDensity(this.ownerElement) === "compact") {
+			this.classList.add("sapUiSizeCompact");
+			this.classList.add("ui5-content-density-compact");
+		} else {
+			this.classList.remove("sapUiSizeCompact");
+			this.classList.remove("ui5-content-density-compact");
 		}
+	}
 
-		if (isCompact) {
-			this.staticAreaItemDomRef.classList.add("sapUiSizeCompact");
-			this.staticAreaItemDomRef.classList.add("ui5-content-density-compact");
+	_updateDirection() {
+		const dir = getEffectiveDir(this.ownerElement);
+		if (dir) {
+			this.setAttribute("dir", dir);
 		} else {
-			this.staticAreaItemDomRef.classList.remove("sapUiSizeCompact");
-			this.staticAreaItemDomRef.classList.remove("ui5-content-density-compact");
+			this.removeAttribute("dir");
 		}
 	}
 
@@ -83,26 +67,32 @@ class StaticAreaItem {
 	 * Returns reference to the DOM element where the current fragment is added.
 	 */
 	async getDomRef() {
-		if (!this._rendered || !this.staticAreaItemDomRef) {
-			this._updateFragment();
+		this._updateContentDensity();
+		if (!this._rendered) {
+			this._rendered = true;
+			updateShadowRoot(this.ownerElement, true);
 		}
-		await RenderScheduler.whenDOMUpdated(); // Wait for the content of the ui5-static-area-item to be rendered
-		return this.staticAreaItemDomRef && this.staticAreaItemDomRef.shadowRoot;
+		await renderFinished(); // Wait for the content of the ui5-static-area-item to be rendered
+		return this.shadowRoot;
 	}
-}
 
-class StaticAreaItemElement extends HTMLElement {
-	constructor() {
-		super();
-	}
+	static getTag() {
+		const pureTag = "ui5-static-area-item";
+		const suffix = getEffectiveScopingSuffixForTag(pureTag);
+		if (!suffix) {
+			return pureTag;
+		}
 
-	get isUI5Element() {
-		return true;
+		return `${pureTag}-${suffix}`;
 	}
-}
 
-if (!customElements.get("ui5-static-area-item")) {
-	customElements.define("ui5-static-area-item", StaticAreaItemElement);
+	static createInstance() {
+		if (!customElements.get(StaticAreaItem.getTag())) {
+			customElements.define(StaticAreaItem.getTag(), StaticAreaItem);
+		}
+
+		return document.createElement(this.getTag());
+	}
 }
 
 export default StaticAreaItem;

package/src/SystemCSSVars.js

@@ -1,31 +1,10 @@
-import createStyleInHead from "./util/createStyleInHead.js";
-
-const systemCSSVars = `
-	:root {
-		--_ui5_content_density:cozy;
-	}
-	
-	[data-ui5-compact-size],
-	.ui5-content-density-compact,
-	.sapUiSizeCompact {
-		--_ui5_content_density:compact;
-	}
-	
-	[dir="rtl"] {
-		--_ui5_dir:rtl;
-	}
-	
-	[dir="ltr"] {
-		--_ui5_dir:ltr;
-	}
-`;
+import { hasStyle, createStyle } from "./ManagedStyles.js";
+import systemCSSVars from "./generated/css/SystemCSSVars.css.js";
 
 const insertSystemCSSVars = () => {
-	if (document.querySelector(`head>style[data-ui5-system-css-vars]`)) {
-		return;
+	if (!hasStyle("data-ui5-system-css-vars")) {
+		createStyle(systemCSSVars, "data-ui5-system-css-vars");
 	}
-
-	createStyleInHead(systemCSSVars, { "data-ui5-system-css-vars": "" });
 };
 
 export default insertSystemCSSVars;