@ui5/webcomponents-base 0.0.0-b4cbc43ba → 0.0.0-b93bc8b37

package/src/Render.js

@@ -1,174 +0,0 @@
-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({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();
-		if (!filters || (filters.tag === tag) || (filters.rtlAware && rtlAware) || (filters.languageAware && languageAware)) {
-			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/RenderQueue.js

@@ -1,66 +0,0 @@
-const MAX_PROCESS_COUNT = 10;
-
-class RenderQueue {
-	constructor() {
-		this.list = []; // Used to store the web components in order
-		this.lookup = new Set(); // Used for faster search
-	}
-
-	add(webComponent) {
-		if (this.lookup.has(webComponent)) {
-			return;
-		}
-
-		this.list.push(webComponent);
-		this.lookup.add(webComponent);
-	}
-
-	remove(webComponent) {
-		if (!this.lookup.has(webComponent)) {
-			return;
-		}
-
-		this.list = this.list.filter(item => item !== webComponent);
-		this.lookup.delete(webComponent);
-	}
-
-	shift() {
-		const webComponent = this.list.shift();
-		if (webComponent) {
-			this.lookup.delete(webComponent);
-			return webComponent;
-		}
-	}
-
-	isEmpty() {
-		return this.list.length === 0;
-	}
-
-	isAdded(webComponent) {
-		return this.lookup.has(webComponent);
-	}
-
-	/**
-	 * Processes the whole queue by executing the callback on each component,
-	 * while also imposing restrictions on how many times a component may be processed.
-	 *
-	 * @param callback - function with one argument (the web component to be processed)
-	 */
-	process(callback) {
-		let webComponent;
-		const stats = new Map();
-
-		webComponent = this.shift();
-		while (webComponent) {
-			const timesProcessed = stats.get(webComponent) || 0;
-			if (timesProcessed > MAX_PROCESS_COUNT) {
-				throw new Error(`Web component processed too many times this task, max allowed is: ${MAX_PROCESS_COUNT}`);
-			}
-			callback(webComponent);
-			stats.set(webComponent, timesProcessed + 1);
-			webComponent = this.shift();
-		}
-	}
-}
-
-export default RenderQueue;

package/src/RenderScheduler.js

@@ -1,44 +0,0 @@
-import {
-	renderDeferred,
-	renderImmediately,
-	renderFinished,
-} from "./Render.js";
-
-/**
- * @deprecated Use the Render.js module instead
- */
-class RenderScheduler {
-	/**
-	 * 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) {
-		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) {
-		console.log("RenderScheduler.renderImmediately is deprecated, please use renderImmediately, exported by Render.js instead"); // eslint-disable-line
-		return renderImmediately(webComponent);
-	}
-
-	/**
-	 * @deprecated Use renderFinished from the Render.js module instead
-	 * @returns {Promise<void>}
-	 */
-	static async whenFinished() {
-		console.log("RenderScheduler.whenFinished is deprecated, please use renderFinished, exported by Render.js instead"); // eslint-disable-line
-		await renderFinished();
-	}
-}
-
-export default RenderScheduler;

package/src/SVGIconRegistry.js

@@ -1,73 +0,0 @@
-import getSharedResource from "./getSharedResource.js";
-
-const registry = getSharedResource("SVGIcons.registry", new Map());
-const iconCollectionPromises = getSharedResource("SVGIcons.promises", new Map());
-
-const ICON_NOT_FOUND = "ICON_NOT_FOUND";
-const DEFAULT_COLLECTION = "SAP-icons";
-
-const parseName = name => {
-	// silently support ui5-compatible URIs
-	if (name.startsWith("sap-icon://")) {
-		name = name.replace("sap-icon://", "");
-	}
-
-	let collection;
-	[name, collection] = name.split("/").reverse();
-	collection = collection || DEFAULT_COLLECTION;
-	// hardcoded alias in case icon explorer is used, resolve `SAP-icons-TNT` to `tnt`
-	// aliases can be made a feature in the future if more collections need it or more aliases are needed.
-	if (collection === "SAP-icons-TNT") {
-		collection = "tnt";
-	}
-	const registryKey = `${collection}/${name}`;
-	return { name, collection, registryKey };
-};
-
-
-const registerIcon = (name, { pathData, ltr, accData, collection } = {}) => { // eslint-disable-line
-	if (!collection) {
-		collection = DEFAULT_COLLECTION;
-	}
-
-	const key = `${collection}/${name}`;
-	registry.set(key, { pathData, ltr, accData });
-};
-
-const getIconDataSync = nameProp => {
-	const { registryKey } = parseName(nameProp);
-	return registry.get(registryKey);
-};
-
-const getIconData = async nameProp => {
-	const { collection, registryKey } = parseName(nameProp);
-
-	if (!iconCollectionPromises.has(collection)) {
-		iconCollectionPromises.set(collection, Promise.resolve(ICON_NOT_FOUND));
-	}
-
-	const iconData = await iconCollectionPromises.get(collection);
-
-	if (iconData === ICON_NOT_FOUND) {
-		return iconData;
-	}
-
-	return registry.get(registryKey);
-};
-
-const getRegisteredNames = async () => {
-	await Promise.all(Array.from(iconCollectionPromises.values()));
-	return Array.from(registry.keys());
-};
-
-const registerCollectionPromise = (collection, promise) => {
-	iconCollectionPromises.set(collection, promise);
-};
-
-export {
-	getIconData,
-	getIconDataSync,
-	registerIcon,
-	getRegisteredNames,
-	registerCollectionPromise,
-};

package/src/StaticAreaItem.js

@@ -1,80 +0,0 @@
-import updateShadowRoot from "./updateShadowRoot.js";
-import { renderFinished } from "./Render.js";
-import getEffectiveContentDensity from "./util/getEffectiveContentDensity.js";
-
-/**
- *
- * @class
- * @author SAP SE
- * @private
- */
-class StaticAreaItem extends HTMLElement {
-	constructor() {
-		super();
-		this._rendered = false;
-		this.attachShadow({ mode: "open" });
-	}
-
-	/**
-	 * @protected
-	 * @param ownerElement The UI5Element instance that owns this static area item
-	 */
-	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
-	 */
-	update() {
-		if (this._rendered) {
-			this._updateContentDensity();
-			updateShadowRoot(this.ownerElement, true);
-		}
-	}
-
-	/**
-	 * Sets the correct content density based on the owner element's state
-	 * @private
-	 */
-	_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");
-		}
-	}
-
-	/**
-	 * @protected
-	 * Returns reference to the DOM element where the current fragment is added.
-	 */
-	async getDomRef() {
-		this._updateContentDensity();
-		if (!this._rendered) {
-			this._rendered = true;
-			updateShadowRoot(this.ownerElement, true);
-		}
-		await renderFinished(); // Wait for the content of the ui5-static-area-item to be rendered
-		return this.shadowRoot;
-	}
-
-	/**
-	 * @protected
-	 * @param refName
-	 * @returns {Element}
-	 */
-	getStableDomRef(refName) {
-		return this.shadowRoot.querySelector(`[data-ui5-stable=${refName}]`);
-	}
-}
-
-if (!customElements.get("ui5-static-area-item")) {
-	customElements.define("ui5-static-area-item", StaticAreaItem);
-}
-
-export default StaticAreaItem;

package/src/SystemCSSVars.js

@@ -1,31 +0,0 @@
-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;
-	}
-`;
-
-const insertSystemCSSVars = () => {
-	if (document.querySelector(`head>style[data-ui5-system-css-vars]`)) {
-		return;
-	}
-
-	createStyleInHead(systemCSSVars, { "data-ui5-system-css-vars": "" });
-};
-
-export default insertSystemCSSVars;