@ui5/webcomponents-base 0.0.0-e818f286e → 0.0.0-ebd9a4db3

package/src/config/Language.js

@@ -1,68 +0,0 @@
-import {
-	getLanguage as getConfiguredLanguage,
-	getFetchDefaultLanguage as getConfiguredFetchDefaultLanguage,
-} from "../InitialConfiguration.js";
-import { fireLanguageChange } from "../locale/languageChange.js";
-import { reRenderAllUI5Elements } from "../Render.js";
-
-let language;
-let fetchDefaultLanguage;
-
-/**
- * Returns the currently configured language, or the browser language as a fallback
- * @returns {String}
- */
-const getLanguage = () => {
-	if (language === undefined) {
-		language = getConfiguredLanguage();
-	}
-	return language;
-};
-
-/**
- * Changes the current language, re-fetches all message bundles, updates all language-aware components
- * and returns a promise that resolves when all rendering is done
- *
- * @param newLanguage
- * @returns {Promise<void>}
- */
-const setLanguage = async newLanguage => {
-	if (language === newLanguage) {
-		return;
-	}
-
-	language = newLanguage;
-
-	await fireLanguageChange(newLanguage);
-	await reRenderAllUI5Elements({ languageAware: true });
-};
-
-/**
- * Defines if the default language, that is inlined, should be
- * fetched over the network instead of using the inlined one.
- * <b>Note:</b> By default the language will not be fetched.
- *
- * @param {Boolean} fetchDefaultLanguage
- */
-const setFetchDefaultLanguage = fetchDefaultLang => {
-	fetchDefaultLanguage = fetchDefaultLang;
-};
-
-/**
- * Returns if the default language, that is inlined, should be fetched over the network.
- * @returns {Boolean}
- */
-const getFetchDefaultLanguage = () => {
-	if (fetchDefaultLanguage === undefined) {
-		setFetchDefaultLanguage(getConfiguredFetchDefaultLanguage());
-	}
-
-	return fetchDefaultLanguage;
-};
-
-export {
-	getLanguage,
-	setLanguage,
-	setFetchDefaultLanguage,
-	getFetchDefaultLanguage,
-};

package/src/config/NoConflict.js

@@ -1,51 +0,0 @@
-import { getNoConflict as getConfiguredNoConflict } from "../InitialConfiguration.js";
-
-// Fire these events even with noConflict: true
-const excludeList = [
-	"value-changed",
-];
-
-const shouldFireOriginalEvent = eventName => {
-	return excludeList.includes(eventName);
-};
-
-let noConflict;
-
-const shouldNotFireOriginalEvent = eventName => {
-	const nc = getNoConflict();
-	return !(nc.events && nc.events.includes && nc.events.includes(eventName));
-};
-
-const getNoConflict = () => {
-	if (noConflict === undefined) {
-		noConflict = getConfiguredNoConflict();
-	}
-
-	return noConflict;
-};
-
-const skipOriginalEvent = eventName => {
-	const nc = getNoConflict();
-
-	// Always fire these events
-	if (shouldFireOriginalEvent(eventName)) {
-		return false;
-	}
-
-	// Read from the configuration
-	if (nc === true) {
-		return true;
-	}
-
-	return !shouldNotFireOriginalEvent(eventName);
-};
-
-const setNoConflict = noConflictData => {
-	noConflict = noConflictData;
-};
-
-export {
-	getNoConflict,
-	setNoConflict,
-	skipOriginalEvent,
-};

package/src/config/RTL.js

@@ -1,31 +0,0 @@
-import { getRTL as getConfiguredRTL } from "../InitialConfiguration.js";
-import { getLanguage } from "./Language.js";
-import getDesigntimePropertyAsArray from "../util/getDesigntimePropertyAsArray.js";
-import detectNavigatorLanguage from "../util/detectNavigatorLanguage.js";
-
-const M_ISO639_OLD_TO_NEW = {
-	"iw": "he",
-	"ji": "yi",
-	"in": "id",
-	"sh": "sr",
-};
-
-const A_RTL_LOCALES = getDesigntimePropertyAsArray("$cldr-rtl-locales:ar,fa,he$") || [];
-
-const impliesRTL = language => {
-	language = (language && M_ISO639_OLD_TO_NEW[language]) || language;
-
-	return A_RTL_LOCALES.indexOf(language) >= 0;
-};
-
-const getRTL = () => {
-	const configurationRTL = getConfiguredRTL();
-
-	if (configurationRTL !== null) {
-		return !!configurationRTL;
-	}
-
-	return impliesRTL(getLanguage() || detectNavigatorLanguage());
-};
-
-export { getRTL }; // eslint-disable-line

package/src/config/Theme.js

@@ -1,53 +0,0 @@
-import { getTheme as getConfiguredTheme } from "../InitialConfiguration.js";
-import { reRenderAllUI5Elements } from "../Render.js";
-import applyTheme from "../theming/applyTheme.js";
-
-let theme;
-
-const getTheme = () => {
-	if (theme === undefined) {
-		theme = getConfiguredTheme();
-	}
-
-	return theme;
-};
-
-const setTheme = async newTheme => {
-	if (theme === newTheme) {
-		return;
-	}
-
-	theme = newTheme;
-
-	// Update CSS Custom Properties
-	await applyTheme(theme);
-	await reRenderAllUI5Elements({ themeAware: true });
-};
-
-/**
- * Returns if the given theme name is the one currently applied.
- * @private
- * @param {String}
- * @returns {boolean}
- */
-const isTheme = _theme => {
-	const currentTheme = getTheme();
-	return currentTheme === _theme || currentTheme === `${_theme}_exp`;
-};
-
-/**
- * Returns if the current theme is part of given theme family
- * @private
- * @param {String} the theme family
- * @returns {boolean}
- */
-const isThemeFamily = _theme => {
-	return getTheme().startsWith(_theme);
-};
-
-export {
-	getTheme,
-	setTheme,
-	isTheme,
-	isThemeFamily,
-};

package/src/delegate/ItemNavigation.js

@@ -1,356 +0,0 @@
-import {
-	isDown,
-	isUp,
-	isLeft,
-	isRight,
-	isHome,
-	isEnd,
-	isPageDown,
-	isPageUp,
-} from "../Keys.js";
-import getActiveElement from "../util/getActiveElement.js";
-
-import NavigationMode from "../types/NavigationMode.js";
-import ItemNavigationBehavior from "../types/ItemNavigationBehavior.js";
-
-/**
- * The ItemNavigation class manages the calculations to determine the correct "tabindex" for a group of related items inside a root component.
- * Important: ItemNavigation only does the calculations and does not change "tabindex" directly, this is a responsibility of the developer.
- *
- * The keys that trigger ItemNavigation are:
- *  - Up/down
- *  - Left/right
- *  - Home/End
- *
- * Usage:
- * 1) Use the "getItemsCallback" constructor property to pass a callback to ItemNavigation, which, whenever called, will return the list of items to navigate among.
- *
- * Each item passed to ItemNavigation via "getItemsCallback" must be:
- *  - A) either a UI5Element with a "_tabIndex" property
- *  - B) or an Object with "id" and "_tabIndex" properties which represents a part of the root component's shadow DOM.
- *    The "id" must be a valid ID within the shadow root of the component ItemNavigation operates on.
- *    This object must not be a DOM object because, as said, ItemNavigation will not set "tabindex" on it. It must be a representation of a DOM object only
- *    and the developer has the responsibility to update the "tabindex" in the component's DOM.
- *  - C) a combination of the above
- *
- * Whenever the user navigates with the keyboard, ItemNavigation will modify the "_tabIndex" properties of the items.
- * It is the items' responsibilities to re-render themselves and apply the correct value of "tabindex" (i.e. to map the "_tabIndex" ItemNavigation set to them to the "tabindex" property).
- * If the items of the ItemNavigation are UI5Elements themselves, this can happen naturally since they will be invalidated by their "_tabIndex" property.
- * If the items are Objects with "id" and "_tabIndex" however, it is the developer's responsibility to apply these and the easiest way is to have the root component invalidated by ItemNavigation.
- * To do so, set the "affectedPropertiesNames" constructor property to point to one or more of the root component's properties that need refreshing when "_tabIndex" is changed deeply.
- *
- * 2) Call the "setCurrentItem" method of ItemNavigation whenever you want to change the current item.
- * This is most commonly required if the user for example clicks on an item and thus selects it directly.
- * Pass as the only argument to "setCurrentItem" the item that becomes current (must be one of the items, returned by "getItemsCallback").
- *
- * @class
- * @public
- */
-class ItemNavigation {
-	/**
-	 *
-	 * @param rootWebComponent the component to operate on (component that slots or contains within its shadow root the items the user navigates among)
-	 * @param options Object with configuration options:
-	 *  - currentIndex: the index of the item that will be initially selected (from which navigation will begin)
-	 *  - navigationMode (Auto|Horizontal|Vertical): whether the items are displayed horizontally (Horizontal), vertically (Vertical) or as a matrix (Auto) meaning the user can navigate in both directions (up/down and left/right)
-	 *  - rowSize: tells how many items per row there are when the items are not rendered as a flat list but rather as a matrix. Relevant for navigationMode=Auto
-	 * 	- skipItemsSize: tells how many items upon PAGE_UP and PAGE_DOWN should be skipped to applying the focus on the next item
-	 *  - behavior (Static|Cycling): tells what to do when trying to navigate beyond the first and last items
-	 *    Static means that nothing happens if the user tries to navigate beyond the first/last item.
-	 *    Cycling means that when the user navigates beyond the last item they go to the first and vice versa.
-	 *  - getItemsCallback: function that, when called, returns an array with all items the user can navigate among
-	 *  - affectedPropertiesNames: a list of metadata properties on the root component which, upon user navigation, will be reassigned by address thus causing the root component to invalidate
-	 */
-	constructor(rootWebComponent, options = {}) {
-		this._setRootComponent(rootWebComponent);
-		this._initOptions(options);
-	}
-
-	_setRootComponent(rootWebComponent) {
-		if (!rootWebComponent.isUI5Element) {
-			throw new Error("The root web component must be a UI5 Element instance");
-		}
-		this.rootWebComponent = rootWebComponent;
-		this.rootWebComponent.addEventListener("keydown", this._onkeydown.bind(this));
-		this.rootWebComponent._onComponentStateFinalized = () => {
-			this._init();
-		};
-	}
-
-	_initOptions(options) {
-		if (typeof options.getItemsCallback !== "function") {
-			throw new Error("getItemsCallback is required");
-		}
-
-		this._getItems = options.getItemsCallback;
-		this._currentIndex = options.currentIndex || 0;
-		this._rowSize = options.rowSize || 1;
-		this._behavior = options.behavior || ItemNavigationBehavior.Static;
-		this._navigationMode = options.navigationMode || NavigationMode.Auto;
-		this._affectedPropertiesNames = options.affectedPropertiesNames || [];
-		this._skipItemsSize = options.skipItemsSize || null;
-	}
-
-	/**
-	 * Call this method to set a new "current" (selected) item in the item navigation
-	 * Note: the item passed to this function must be one of the items, returned by the getItemsCallback function
-	 *
-	 * @public
-	 * @param current the new selected item
-	 */
-	setCurrentItem(current) {
-		const currentItemIndex = this._getItems().indexOf(current);
-
-		if (currentItemIndex === -1) {
-			console.warn(`The provided item is not managed by ItemNavigation`, current); // eslint-disable-line
-			return;
-		}
-
-		this._currentIndex = currentItemIndex;
-		this._applyTabIndex();
-	}
-
-	/**
-	 * Call this method to dynamically change the row size
-	 *
-	 * @public
-	 * @param newRowSize
-	 */
-	setRowSize(newRowSize) {
-		this._rowSize = newRowSize;
-	}
-
-	_init() {
-		this._getItems().forEach((item, idx) => {
-			item._tabIndex = (idx === this._currentIndex) ? "0" : "-1";
-		});
-	}
-
-	_onkeydown(event) {
-		if (!this._canNavigate()) {
-			return;
-		}
-
-		const horizontalNavigationOn = this._navigationMode === NavigationMode.Horizontal || this._navigationMode === NavigationMode.Auto;
-		const verticalNavigationOn = this._navigationMode === NavigationMode.Vertical || this._navigationMode === NavigationMode.Auto;
-		const isRTL = this.rootWebComponent.effectiveDir === "rtl";
-
-		if (isRTL && isLeft(event) && horizontalNavigationOn) {
-			this._handleRight();
-		} else if (isRTL && isRight(event) && horizontalNavigationOn) {
-			this._handleLeft();
-		} else if (isLeft(event) && horizontalNavigationOn) {
-			this._handleLeft();
-		} else if (isRight(event) && horizontalNavigationOn) {
-			this._handleRight();
-		} else if (isUp(event) && verticalNavigationOn) {
-			this._handleUp();
-		} else if (isDown(event) && verticalNavigationOn) {
-			this._handleDown();
-		} else if (isHome(event)) {
-			this._handleHome();
-		} else if (isEnd(event)) {
-			this._handleEnd();
-		} else if (isPageUp(event)) {
-			this._handlePageUp();
-		} else if (isPageDown(event)) {
-			this._handlePageDown();
-		} else {
-			return; // if none of the supported keys is pressed, we don't want to prevent the event or update the item navigation
-		}
-
-		event.preventDefault();
-		this._applyTabIndex();
-		this._focusCurrentItem();
-	}
-
-	_handleUp() {
-		const itemsLength = this._getItems().length;
-		if (this._currentIndex - this._rowSize >= 0) { // no border reached, just decrease the index by a row
-			this._currentIndex -= this._rowSize;
-			return;
-		}
-
-		if (this._behavior === ItemNavigationBehavior.Cyclic) { // if cyclic, go to the **last** item in the **previous** column
-			const firstItemInThisColumnIndex = this._currentIndex % this._rowSize;
-			const firstItemInPreviousColumnIndex = firstItemInThisColumnIndex === 0 ? this._rowSize - 1 : firstItemInThisColumnIndex - 1; // find the first item in the previous column (if the current column is the first column -> move to the last column)
-			const rows = Math.ceil(itemsLength / this._rowSize); // how many rows there are (even if incomplete, f.e. for 14 items and _rowSize=4 -> 4 rows total, although only 2 items on the last row)
-			let lastItemInPreviousColumnIndex = firstItemInPreviousColumnIndex + (rows - 1) * this._rowSize; // multiply rows by columns, and add the column's first item's index
-			if (lastItemInPreviousColumnIndex > itemsLength - 1) { // for incomplete rows, use the previous row's last item, as for them the last item is missing
-				lastItemInPreviousColumnIndex -= this._rowSize;
-			}
-			this._currentIndex = lastItemInPreviousColumnIndex;
-		} else { // not cyclic, so just go to the first item
-			this._currentIndex = 0;
-		}
-	}
-
-	_handleDown() {
-		const itemsLength = this._getItems().length;
-		if (this._currentIndex + this._rowSize < itemsLength) { // no border reached, just increase the index by a row
-			this._currentIndex += this._rowSize;
-			return;
-		}
-
-		if (this._behavior === ItemNavigationBehavior.Cyclic) { // if cyclic, go to the **first** item in the **next** column
-			const firstItemInThisColumnIndex = this._currentIndex % this._rowSize; // find the first item in the current column first
-			const firstItemInNextColumnIndex = (firstItemInThisColumnIndex + 1) % this._rowSize; // to get the first item in the next column, just increase the index by 1. The modulo by rows is for the case when we are at the last column
-			this._currentIndex = firstItemInNextColumnIndex;
-		} else { // not cyclic, so just go to the last item
-			this._currentIndex = itemsLength - 1;
-		}
-	}
-
-	_handleLeft() {
-		const itemsLength = this._getItems().length;
-		if (this._currentIndex > 0) {
-			this._currentIndex -= 1;
-			return;
-		}
-
-		if (this._behavior === ItemNavigationBehavior.Cyclic) { // go to the first item in the next column
-			this._currentIndex = itemsLength - 1;
-		}
-	}
-
-	_handleRight() {
-		const itemsLength = this._getItems().length;
-		if (this._currentIndex < itemsLength - 1) {
-			this._currentIndex += 1;
-			return;
-		}
-
-		if (this._behavior === ItemNavigationBehavior.Cyclic) { // go to the first item in the next column
-			this._currentIndex = 0;
-		}
-	}
-
-	_handleHome() {
-		const homeEndRange = this._rowSize > 1 ? this._rowSize : this._getItems().length;
-		this._currentIndex -= this._currentIndex % homeEndRange;
-	}
-
-	_handleEnd() {
-		const homeEndRange = this._rowSize > 1 ? this._rowSize : this._getItems().length;
-		this._currentIndex += (homeEndRange - 1 - this._currentIndex % homeEndRange); // eslint-disable-line
-	}
-
-	_handlePageUp() {
-		if (this._rowSize > 1) {
-			// eslint-disable-next-line
-			// TODO: handle page up on matrix (grid) layout - ColorPalette, ProductSwitch.
-			return;
-		}
-		this._handlePageUpFlat();
-	}
-
-	_handlePageDown() {
-		if (this._rowSize > 1) {
-			// eslint-disable-next-line
-			// TODO: handle page up on matrix (grid) layout - ColorPalette, ProductSwitch.
-			return;
-		}
-		this._handlePageDownFlat();
-	}
-
-	/**
-	 * Handles PAGE_UP in a flat list-like structure, both vertically and horizontally.
-	 */
-	_handlePageUpFlat() {
-		if (this._skipItemsSize === null) {
-			// Move the focus to the very top (as Home).
-			this._currentIndex -= this._currentIndex;
-		}
-
-		if (this._currentIndex + 1 > this._skipItemsSize) {
-			// When there are more than "skipItemsSize" number of items to the top,
-			// move the focus up/left with the predefined number.
-			this._currentIndex -= this._skipItemsSize;
-		} else {
-			// Otherwise, move the focus to the very top (as Home).
-			this._currentIndex -= this._currentIndex;
-		}
-	}
-
-	/**
-	 * Handles PAGE_DOWN in a flat list-like structure, both vertically and horizontally.
-	 */
-	_handlePageDownFlat() {
-		if (this._skipItemsSize === null) {
-			// Move the focus to the very bottom (as End).
-			this._currentIndex = this._getItems().length - 1;
-		}
-
-		const currentToEndRange = this._getItems().length - this._currentIndex - 1;
-
-		if (currentToEndRange > this._skipItemsSize) {
-			// When there are more than "skipItemsSize" number of items until the bottom,
-			// move the focus down/right with the predefined number.
-			this._currentIndex += this._skipItemsSize;
-		} else {
-			// Otherwise, move the focus to the very bottom (as End).
-			this._currentIndex = this._getItems().length - 1;
-		}
-	}
-
-	_applyTabIndex() {
-		const items = this._getItems();
-		for (let i = 0; i < items.length; i++) {
-			items[i]._tabIndex = i === this._currentIndex ? "0" : "-1";
-		}
-
-		this._affectedPropertiesNames.forEach(propName => {
-			const prop = this.rootWebComponent[propName];
-			this.rootWebComponent[propName] = Array.isArray(prop) ? [...prop] : { ...prop };
-		});
-	}
-
-	_focusCurrentItem() {
-		const currentItem = this._getCurrentItem();
-		if (currentItem) {
-			currentItem.focus();
-		}
-	}
-
-	_canNavigate() {
-		const currentItem = this._getCurrentItem();
-		const activeElement = getActiveElement();
-
-		return currentItem && currentItem === activeElement;
-	}
-
-	_getCurrentItem() {
-		const items = this._getItems();
-
-		if (!items.length) {
-			return null;
-		}
-
-		// normalize the index
-		while (this._currentIndex >= items.length) {
-			this._currentIndex -= this._rowSize;
-		}
-
-		if (this._currentIndex < 0) {
-			this._currentIndex = 0;
-		}
-
-		const currentItem = items[this._currentIndex];
-
-		if (!currentItem) {
-			return;
-		}
-
-		if (currentItem.isUI5Element) {
-			return currentItem.getFocusDomRef();
-		}
-
-		if (!this.rootWebComponent.getDomRef()) {
-			return;
-		}
-
-		return this.rootWebComponent.getDomRef().querySelector(`#${currentItem.id}`);
-	}
-}
-
-export default ItemNavigation;

package/src/delegate/ResizeHandler.js

@@ -1,106 +0,0 @@
-let resizeObserver;
-const observedElements = new Map();
-
-const getResizeObserver = () => {
-	if (!resizeObserver) {
-		resizeObserver = new window.ResizeObserver(entries => {
-			entries.forEach(entry => {
-				const callbacks = observedElements.get(entry.target);
-				callbacks.forEach(callback => callback());
-			});
-		});
-	}
-	return resizeObserver;
-};
-
-let observe = (element, callback) => {
-	const callbacks = observedElements.get(element) || [];
-
-	// if no callbacks have been added for this element - start observing it
-	if (!callbacks.length) {
-		getResizeObserver().observe(element);
-	}
-
-	// save the callbacks in an array
-	observedElements.set(element, [...callbacks, callback]);
-};
-
-let unobserve = (element, callback) => {
-	const callbacks = observedElements.get(element) || [];
-	if (callbacks.length === 0) {
-		return;
-	}
-
-	const filteredCallbacks = callbacks.filter(fn => fn !== callback);
-	if (filteredCallbacks.length === 0) {
-		getResizeObserver().unobserve(element);
-		observedElements.delete(element);
-	} else {
-		observedElements.set(element, filteredCallbacks);
-	}
-};
-
-/**
- * Allows to register/deregister resize observers for a DOM element
- *
- * @public
- * @class
-  */
-class ResizeHandler {
-	/**
-	 * @static
-	 * @public
-	 * @param {*} element UI5 Web Component or DOM Element to be observed
-	 * @param {*} callback Callback to be executed
-	 */
-	static register(element, callback) {
-		if (element.isUI5Element) {
-			element = element.getDomRef();
-		}
-
-		if (element instanceof HTMLElement) {
-			observe(element, callback);
-		} else {
-			console.warn("Cannot register ResizeHandler for element", element); // eslint-disable-line
-		}
-	}
-
-	/**
-	 * @static
-	 * @public
-	 * @param {*} element UI5 Web Component or DOM Element to be unobserved
-	 * @param {*} callback Callback to be removed
-	 */
-	static deregister(element, callback) {
-		if (element.isUI5Element) {
-			element = element.getDomRef();
-		}
-
-		if (element instanceof HTMLElement) {
-			unobserve(element, callback);
-		} else {
-			console.warn("Cannot deregister ResizeHandler for element", element); // eslint-disable-line
-		}
-	}
-}
-
-/**
- * Set a function to be executed whenever a DOM node needs to be observed for size change.
- * @public
- * @param fn
- */
-const setResizeHandlerObserveFn = fn => {
-	observe = fn;
-};
-
-/**
- * Set a function to be executed whenever a DOM node needs to no longer be observed for size changes
- * @public
- * @param fn
- */
-const setResizeHandlerUnobserveFn = fn => {
-	unobserve = fn;
-};
-
-export default ResizeHandler;
-export { setResizeHandlerObserveFn, setResizeHandlerUnobserveFn };