@ui5/webcomponents-base 0.0.0-a3eca7ade → 0.0.0-a7032d86e

package/src/delegate/{ItemNavigation.js → ItemNavigation.ts}

@@ -13,6 +13,24 @@ import getActiveElement from "../util/getActiveElement.js";
 import NavigationMode from "../types/NavigationMode.js";
 import ItemNavigationBehavior from "../types/ItemNavigationBehavior.js";
 
+import type UI5Element from "../UI5Element.js";
+import { instanceOfUI5Element } from "../UI5Element.js";
+
+interface ITabbable {
+	id: string,
+	_tabIndex: string,
+}
+
+type ItemNavigationOptions = {
+	currentIndex?: number,
+	navigationMode?: NavigationMode,
+	rowSize?: number
+	skipItemsSize?: number,
+	behavior?: ItemNavigationBehavior,
+	getItemsCallback: () => Array<ITabbable>,
+	affectedPropertiesNames?: Array<string>,
+};
+
 /**
  * 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.
@@ -47,10 +65,26 @@ import ItemNavigationBehavior from "../types/ItemNavigationBehavior.js";
  * @public
  */
 class ItemNavigation {
+	rootWebComponent: UI5Element;
+
+	_getItems: () => Array<ITabbable>;
+
+	_currentIndex: number;
+
+	_rowSize: number;
+
+	_behavior: ItemNavigationBehavior;
+
+	_navigationMode: NavigationMode;
+
+	_affectedPropertiesNames: Array<string>;
+
+	_skipItemsSize: number | null;
+
 	/**
 	 *
 	 * @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:
+	 * @param {ItemNavigationOptions} 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
@@ -61,23 +95,17 @@ class ItemNavigation {
 	 *  - 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) {
+	constructor(rootWebComponent: UI5Element, options: ItemNavigationOptions) {
 		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");
 		}
@@ -98,7 +126,7 @@ class ItemNavigation {
 	 * @public
 	 * @param current the new selected item
 	 */
-	setCurrentItem(current) {
+	setCurrentItem(current: ITabbable) {
 		const currentItemIndex = this._getItems().indexOf(current);
 
 		if (currentItemIndex === -1) {
@@ -116,7 +144,7 @@ class ItemNavigation {
 	 * @public
 	 * @param newRowSize
 	 */
-	setRowSize(newRowSize) {
+	setRowSize(newRowSize: number) {
 		this._rowSize = newRowSize;
 	}
 
@@ -126,22 +154,27 @@ class ItemNavigation {
 		});
 	}
 
-	_onkeydown(event) {
+	_onkeydown(event: KeyboardEvent) {
 		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 (isUp(event) && verticalNavigationOn) {
-			this._handleUp();
-		} else if (isDown(event) && verticalNavigationOn) {
-			this._handleDown();
+		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)) {
@@ -255,6 +288,7 @@ class ItemNavigation {
 		if (this._skipItemsSize === null) {
 			// Move the focus to the very top (as Home).
 			this._currentIndex -= this._currentIndex;
+			return;
 		}
 
 		if (this._currentIndex + 1 > this._skipItemsSize) {
@@ -274,6 +308,7 @@ class ItemNavigation {
 		if (this._skipItemsSize === null) {
 			// Move the focus to the very bottom (as End).
 			this._currentIndex = this._getItems().length - 1;
+			return;
 		}
 
 		const currentToEndRange = this._getItems().length - this._currentIndex - 1;
@@ -295,15 +330,15 @@ class ItemNavigation {
 		}
 
 		this._affectedPropertiesNames.forEach(propName => {
-			const prop = this.rootWebComponent[propName];
-			this.rootWebComponent[propName] = Array.isArray(prop) ? [...prop] : { ...prop };
+			const prop = (this.rootWebComponent as Record<string, any>)[propName];
+			(this.rootWebComponent as Record<string, any>)[propName] = Array.isArray(prop) ? [...prop] : { ...prop };
 		});
 	}
 
 	_focusCurrentItem() {
 		const currentItem = this._getCurrentItem();
 		if (currentItem) {
-			currentItem.focus();
+			currentItem.focus({ focusVisible: true } as FocusOptions);
 		}
 	}
 
@@ -318,7 +353,7 @@ class ItemNavigation {
 		const items = this._getItems();
 
 		if (!items.length) {
-			return null;
+			return;
 		}
 
 		// normalize the index
@@ -336,16 +371,23 @@ class ItemNavigation {
 			return;
 		}
 
-		if (currentItem.isUI5Element) {
+		if (instanceOfUI5Element(currentItem)) {
 			return currentItem.getFocusDomRef();
 		}
 
-		if (!this.rootWebComponent.getDomRef()) {
+		const currentItemDOMRef = this.rootWebComponent.getDomRef();
+		if (!currentItemDOMRef) {
 			return;
 		}
 
-		return this.rootWebComponent.getDomRef().querySelector(`#${currentItem.id}`);
+		if (currentItem.id) {
+			return currentItemDOMRef.querySelector(`#${currentItem.id}`) as HTMLElement;
+		}
 	}
 }
 
 export default ItemNavigation;
+
+export {
+	ITabbable,
+};

package/src/delegate/{ResizeHandler.js → ResizeHandler.ts}

@@ -1,19 +1,23 @@
-let resizeObserver;
-const observedElements = new Map();
+import { instanceOfUI5Element } from "../UI5Element.js";
+
+type ResizeObserverCallback = () => void;
+
+let resizeObserver: ResizeObserver;
+const observedElements = new Map<HTMLElement, Array<ResizeObserverCallback>>();
 
 const getResizeObserver = () => {
 	if (!resizeObserver) {
 		resizeObserver = new window.ResizeObserver(entries => {
 			entries.forEach(entry => {
-				const callbacks = observedElements.get(entry.target);
-				callbacks.forEach(callback => callback());
+				const callbacks = observedElements.get(entry.target as HTMLElement);
+				callbacks?.forEach((callback: ResizeObserverCallback) => callback());
 			});
 		});
 	}
 	return resizeObserver;
 };
 
-let observe = (element, callback) => {
+const observe = (element: HTMLElement, callback: ResizeObserverCallback) => {
 	const callbacks = observedElements.get(element) || [];
 
 	// if no callbacks have been added for this element - start observing it
@@ -25,13 +29,13 @@ let observe = (element, callback) => {
 	observedElements.set(element, [...callbacks, callback]);
 };
 
-let unobserve = (element, callback) => {
+const unobserve = (element: HTMLElement, callback: ResizeObserverCallback) => {
 	const callbacks = observedElements.get(element) || [];
 	if (callbacks.length === 0) {
 		return;
 	}
 
-	const filteredCallbacks = callbacks.filter(fn => fn !== callback);
+	const filteredCallbacks = callbacks.filter((fn: ResizeObserverCallback) => fn !== callback);
 	if (filteredCallbacks.length === 0) {
 		getResizeObserver().unobserve(element);
 		observedElements.delete(element);
@@ -53,13 +57,15 @@ class ResizeHandler {
 	 * @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();
+	static register(element: HTMLElement, callback: ResizeObserverCallback) {
+		let effectiveElement: HTMLElement | undefined = element;
+
+		if (instanceOfUI5Element(effectiveElement)) {
+			effectiveElement = effectiveElement.getDomRef();
 		}
 
-		if (element instanceof HTMLElement) {
-			observe(element, callback);
+		if (effectiveElement instanceof HTMLElement) {
+			observe(effectiveElement, callback);
 		} else {
 			console.warn("Cannot register ResizeHandler for element", element); // eslint-disable-line
 		}
@@ -71,36 +77,19 @@ class ResizeHandler {
 	 * @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();
+	static deregister(element: HTMLElement, callback: ResizeObserverCallback) {
+		let effectiveElement: HTMLElement | undefined = element;
+
+		if (instanceOfUI5Element(effectiveElement)) {
+			effectiveElement = effectiveElement.getDomRef();
 		}
 
-		if (element instanceof HTMLElement) {
-			unobserve(element, callback);
+		if (effectiveElement instanceof HTMLElement) {
+			unobserve(effectiveElement, 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 };

package/src/delegate/ScrollEnablement.ts

@@ -0,0 +1,221 @@
+import { supportsTouch } from "../Device.js";
+import EventProvider from "../EventProvider.js";
+import scroll from "../animations/scroll.js";
+import type UI5Element from "../UI5Element.js";
+
+const scrollEventName = "scroll";
+const touchEndEventName = supportsTouch() ? "touchend" : "mouseup";
+
+type EventListenerParam = {
+	isLeft: boolean;
+	isRight: boolean
+}
+type EventListenerReturn = void;
+
+class ScrollEnablement extends EventProvider<EventListenerParam, EventListenerReturn> {
+	containerComponent: UI5Element;
+	mouseMove: (event: MouseEvent | TouchEvent) => void;
+	mouseUp: (event: MouseEvent | TouchEvent) => void;
+	touchStart: (event: MouseEvent | TouchEvent) => void;
+	cachedValue: { dragX: number, dragY: number };
+	startX: number;
+	startY: number;
+	_container?: HTMLElement;
+	supportsTouch = supportsTouch();
+	_canScroll?: boolean;
+	_prevDragX?: number;
+	_prevDragY?: number;
+
+	constructor(containerComponent: UI5Element) {
+		super();
+		this.containerComponent = containerComponent;
+		this.mouseMove = this.ontouchmove.bind(this);
+		this.mouseUp = this.ontouchend.bind(this);
+		this.touchStart = this.ontouchstart.bind(this);
+
+		this.supportsTouch = supportsTouch();
+
+		// On Android devices touchmove is thrown one more time than neccessary (together with touchend)
+		// so we have to cache the previus coordinates in order to provide correct parameters in the
+		// event for Android
+		this.cachedValue = { dragX: 0, dragY: 0 };
+
+		// In components like Carousel you need to know if the user has clicked on something or swiped
+		// in order to throw the needed event or not
+		this.startX = 0;
+		this.startY = 0;
+
+		if (this.supportsTouch) {
+			containerComponent.addEventListener("touchstart", this.touchStart, { passive: true });
+			containerComponent.addEventListener("touchmove", this.mouseMove, { passive: true });
+			containerComponent.addEventListener("touchend", this.mouseUp, { passive: true });
+		} else {
+			containerComponent.addEventListener("mousedown", this.touchStart, { passive: true });
+		}
+	}
+
+	set scrollContainer(container: HTMLElement) {
+		this._container = container;
+	}
+
+	get scrollContainer() {
+		return this._container!;
+	}
+
+	/**
+	 * Scrolls the container to the left/top position, retrying retryCount times, if the container is not yet painted
+	 *
+	 * @param left
+	 * @param top
+	 * @param retryCount
+	 * @param retryInterval
+	 * @returns {Promise<void>} resolved when scrolled successfully
+	 */
+	async scrollTo(left: number, top: number, retryCount = 0, retryInterval = 0) {
+		let containerPainted = this.scrollContainer.clientHeight > 0 && this.scrollContainer.clientWidth > 0;
+
+		/* eslint-disable no-loop-func, no-await-in-loop */
+		while (!containerPainted && retryCount > 0) {
+			await new Promise<void>(resolve => {
+				setTimeout(() => {
+					containerPainted = this.scrollContainer.clientHeight > 0 && this.scrollContainer.clientWidth > 0;
+					retryCount--;
+					resolve();
+				}, retryInterval);
+			});
+		}
+		/* eslint-disable no-loop-func, no-await-in-loop */
+
+		this._container!.scrollLeft = left;
+		this._container!.scrollTop = top;
+	}
+
+	move(dx: number, dy: number, disableAnimation: boolean) {
+		if (disableAnimation) {
+			this._container!.scrollLeft += dx;
+			this._container!.scrollTop += dy;
+			return;
+		}
+
+		if (this._container) {
+			return scroll(this._container, dx, dy);
+		}
+	}
+
+	getScrollLeft() {
+		return this._container!.scrollLeft;
+	}
+
+	getScrollTop() {
+		return this._container!.scrollTop;
+	}
+
+	_isTouchInside(event: TouchEvent | MouseEvent) {
+		let touch = null;
+		if (this.supportsTouch && event instanceof TouchEvent) {
+			touch = event.touches[0];
+		}
+
+		const rect = this._container!.getBoundingClientRect();
+		const x = this.supportsTouch ? (touch as TouchInit).clientX : (event as MouseEvent).x;
+		const y = this.supportsTouch ? (touch as TouchInit).clientY : (event as MouseEvent).y;
+
+		return x! >= rect.left && x! <= rect.right
+			&& y! >= rect.top && y! <= rect.bottom;
+	}
+
+	ontouchstart(event: TouchEvent | MouseEvent) {
+		let touch = null;
+		if (this.supportsTouch && event instanceof TouchEvent) {
+			touch = event.touches[0];
+		}
+
+		if (!this.supportsTouch) {
+			document.addEventListener("mouseup", this.mouseUp, { passive: true });
+			document.addEventListener("mousemove", this.mouseMove, { passive: true });
+		} else {
+			// Needed only on mobile
+			this.startX = touch!.pageX;
+			this.startY = touch!.pageY;
+		}
+
+		if (this.supportsTouch && event instanceof TouchEvent) {
+			this._prevDragX = touch!.pageX;
+			this._prevDragY = touch!.pageY;
+		}
+
+		if (event instanceof MouseEvent) {
+			this._prevDragX = event.x;
+			this._prevDragY = event.y;
+		}
+
+		this._canScroll = this._isTouchInside(event);
+	}
+
+	ontouchmove(event: TouchEvent | MouseEvent) {
+		if (!this._canScroll) {
+			return;
+		}
+
+		const container = this._container;
+		const touch = this.supportsTouch ? (event as TouchEvent).touches[0] : null;
+
+		const dragX = this.supportsTouch ? (touch as TouchInit).pageX : (event as MouseEvent).x;
+		const dragY = this.supportsTouch ? (touch as TouchInit).pageY : (event as MouseEvent).y;
+
+		container!.scrollLeft += this._prevDragX! - dragX!;
+		container!.scrollTop += this._prevDragY! - dragY!;
+
+		this.fireEvent(scrollEventName, {
+			isLeft: dragX! > this._prevDragX!,
+			isRight: dragX! < this._prevDragX!,
+		});
+
+		this.cachedValue.dragX = this._prevDragX!;
+		this.cachedValue.dragY = this._prevDragY!;
+
+		this._prevDragX = dragX;
+		this._prevDragY = dragY;
+	}
+
+	ontouchend(event: TouchEvent | MouseEvent) {
+		if (this.supportsTouch) {
+			const deltaX = Math.abs((event as TouchEvent).changedTouches[0].pageX - this.startX);
+			const deltaY = Math.abs((event as TouchEvent).changedTouches[0].pageY - this.startY);
+
+			if (deltaX < 10 && deltaY < 10) {
+				return;
+			}
+		}
+
+		if (!this._canScroll) {
+			return;
+		}
+
+		const container = this._container;
+		const dragX = this.supportsTouch ? (event as TouchEvent).changedTouches[0].pageX : (event as MouseEvent).x;
+		const dragY = this.supportsTouch ? (event as TouchEvent).changedTouches[0].pageY : (event as MouseEvent).y;
+
+		container!.scrollLeft += this._prevDragX! - dragX;
+		container!.scrollTop += this._prevDragY! - dragY;
+
+		const useCachedValues = dragX === this._prevDragX;
+		const _dragX = useCachedValues ? this.cachedValue.dragX : dragX;
+		// const _dragY = useCachedValues ? this.cachedValue.dragY : dragY; add if needed
+
+		this.fireEvent(touchEndEventName, {
+			isLeft: _dragX < this._prevDragX!,
+			isRight: _dragX > this._prevDragX!,
+		});
+
+		this._prevDragX = dragX;
+		this._prevDragY = dragY;
+
+		if (!this.supportsTouch) {
+			document.removeEventListener("mousemove", this.mouseMove);
+			document.removeEventListener("mouseup", this.mouseUp);
+		}
+	}
+}
+
+export default ScrollEnablement;

package/src/features/F6Navigation.ts

@@ -0,0 +1,141 @@
+import { registerFeature } from "../FeaturesRegistry.js";
+import { isF6Next, isF6Previous } from "../Keys.js";
+import { instanceOfUI5Element } from "../UI5Element.js";
+import { getFirstFocusableElement } from "../util/FocusableElements.js";
+import getFastNavigationGroups from "../util/getFastNavigationGroups.js";
+
+class F6Navigation {
+	static _instance: F6Navigation;
+	keydownHandler: (event: KeyboardEvent) => void;
+	selectedGroup: HTMLElement | null = null;
+	groups: Array<HTMLElement> = [];
+
+	constructor() {
+		this.keydownHandler = this._keydownHandler.bind(this) as (event: KeyboardEvent) => void;
+		this.attachEventListeners();
+	}
+
+	attachEventListeners() {
+		document.addEventListener("keydown", this.keydownHandler);
+	}
+
+	async _keydownHandler(event: KeyboardEvent) {
+		if (isF6Next(event)) {
+			this.updateGroups();
+
+			if (this.groups.length < 1) {
+				return;
+			}
+
+			event.preventDefault();
+
+			let nextIndex = -1;
+			let nextElement;
+			if (this.selectedGroup) {
+				nextIndex = this.groups.indexOf(this.selectedGroup);
+			}
+
+			if (nextIndex > -1) {
+				if (nextIndex + 1 >= this.groups.length) {
+					nextElement = this.groups[0];
+				} else {
+					nextElement = this.groups[nextIndex + 1];
+				}
+			} else {
+				nextElement = this.groups[0];
+			}
+
+			const nextElementDomRef = instanceOfUI5Element(nextElement) ? nextElement.getDomRef() : nextElement;
+
+			if (nextElementDomRef) {
+				const elementToFocus = await getFirstFocusableElement(nextElementDomRef, true);
+				elementToFocus?.focus();
+			}
+		}
+
+		if (isF6Previous(event)) {
+			this.updateGroups();
+
+			if (this.groups.length < 1) {
+				return;
+			}
+
+			event.preventDefault();
+
+			let nextIndex = -1;
+			let nextElement;
+			if (this.selectedGroup) {
+				nextIndex = this.groups.indexOf(this.selectedGroup);
+			}
+
+			if (nextIndex > 0) {
+				// Handle the situation where the first focusable element of two neighbor groups is the same
+				// For example:
+				// <ui5-flexible-column-layout>
+				//     <ui5-list>
+				//         <ui5-li>List Item</ui5-li>
+				//     </ui5-list>
+				// </ui5-flexible-column-layout>
+				// Here for both FCL & List the firstFoccusableElement is the same (the ui5-li)
+
+				const firstFocusable = await getFirstFocusableElement(this.groups[nextIndex - 1], true);
+				const shouldSkipParent = firstFocusable === await getFirstFocusableElement(this.groups[nextIndex], true);
+
+				nextElement = this.groups[shouldSkipParent ? nextIndex - 2 : nextIndex - 1];
+			} else {
+				nextElement = this.groups[this.groups.length - 1];
+			}
+
+			const nextElementDomRef = instanceOfUI5Element(nextElement) ? nextElement.getDomRef() : nextElement;
+
+			if (nextElementDomRef) {
+				const elementToFocus = await getFirstFocusableElement(nextElementDomRef, true);
+				elementToFocus?.focus();
+			}
+		}
+	}
+
+	removeEventListeners() {
+		document.removeEventListener("keydown", this.keydownHandler);
+	}
+
+	updateGroups() {
+		this.setSelectedGroup();
+		this.groups = getFastNavigationGroups(document.body);
+	}
+
+	setSelectedGroup(root: DocumentOrShadowRoot = window.document) {
+		const htmlElement = window.document.querySelector("html");
+		let element: Element | null | ParentNode = this.deepActive(root);
+
+		while (element && (element as Element).getAttribute("data-sap-ui-fastnavgroup") !== "true" && element !== htmlElement) {
+		   element = element.parentElement ? element.parentNode : (element.parentNode as ShadowRoot).host;
+		}
+
+		this.selectedGroup = element as HTMLElement;
+	 }
+
+	 deepActive(root: DocumentOrShadowRoot): Element | null {
+		if (root.activeElement && root.activeElement.shadowRoot) {
+		   return this.deepActive(root.activeElement.shadowRoot);
+		}
+
+		return root.activeElement;
+	 }
+
+	destroy() {
+		this.removeEventListeners();
+	}
+
+	static init() {
+		if (!this._instance) {
+			this._instance = new F6Navigation();
+		}
+
+		return this._instance;
+	}
+}
+
+registerFeature("F6Navigation", F6Navigation);
+
+export default F6Navigation;

package/src/features/OpenUI5Element.ts

@@ -0,0 +1,11 @@
+import UI5Element from "../UI5Element.js";
+
+class OpenUI5Element extends UI5Element {
+	__isBusy?: boolean;
+	isOpenUI5Component?: boolean;
+	__suppressFocusIn?: () => void;
+	__suppressFocusBack?: (e: KeyboardEvent) => void;
+	__redirectFocus?: boolean;
+}
+
+export default OpenUI5Element;