@ui5/webcomponents-base 1.12.0-rc.0 → 1.12.0-rc.2

package/src/delegate/ScrollEnablement.ts

@@ -1,224 +0,0 @@
-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 ScrollEnablementEventListenerParam = {
-	isLeft: boolean;
-	isRight: boolean
-}
-type ScrollEnablementEventListenerReturn = void;
-
-class ScrollEnablement extends EventProvider<ScrollEnablementEventListenerParam, ScrollEnablementEventListenerReturn> {
-	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;
-export type {
-	ScrollEnablementEventListenerParam,
-};

package/src/features/F6Navigation.ts

@@ -1,195 +0,0 @@
-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";
-import isElementClickable from "../util/isElementClickable.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 groupElementToFocus(nextElement: HTMLElement) {
-		const nextElementDomRef = instanceOfUI5Element(nextElement) ? nextElement.getDomRef() : nextElement;
-
-		if (nextElementDomRef) {
-			if (isElementClickable(nextElementDomRef)) {
-				return nextElementDomRef;
-			}
-
-			const elementToFocus = await getFirstFocusableElement(nextElementDomRef);
-
-			if (elementToFocus) {
-				return elementToFocus;
-			}
-		}
-	}
-
-	async findNextFocusableGroupElement(currentIndex: number) {
-		let elementToFocus;
-
-		/* eslint-disable no-await-in-loop */
-		for (let index = 0; index < this.groups.length; index++) {
-			let nextElement;
-
-			if (currentIndex > -1) {
-				if (currentIndex + 1 >= this.groups.length) {
-					currentIndex = 0;
-					nextElement = this.groups[currentIndex];
-				} else {
-					currentIndex += 1;
-					nextElement = this.groups[currentIndex];
-				}
-			} else {
-				currentIndex = 0;
-				nextElement = this.groups[currentIndex];
-			}
-
-			elementToFocus = await this.groupElementToFocus(nextElement);
-
-			if (elementToFocus) {
-				break;
-			}
-		}
-		/* eslint-enable no-await-in-loop */
-
-		return elementToFocus;
-	}
-
-	async findPreviousFocusableGroupElement(currentIndex: number) {
-		let elementToFocus;
-
-		/* eslint-disable no-await-in-loop */
-		for (let index = 0; index < this.groups.length; index++) {
-			let nextElement;
-
-			if (currentIndex > 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 this.groupElementToFocus(this.groups[currentIndex - 1]);
-				const shouldSkipParent = firstFocusable === await this.groupElementToFocus(this.groups[currentIndex]);
-
-				currentIndex = shouldSkipParent ? currentIndex - 2 : currentIndex - 1;
-
-				if (currentIndex < 0) {
-					currentIndex = this.groups.length - 1;
-				}
-
-				nextElement = this.groups[currentIndex];
-			} else {
-				currentIndex = this.groups.length - 1;
-				nextElement = this.groups[currentIndex];
-			}
-
-			elementToFocus = await this.groupElementToFocus(nextElement);
-
-			if (elementToFocus) {
-				break;
-			}
-		}
-		/* eslint-enable no-await-in-loop */
-
-		return elementToFocus;
-	}
-
-	async _keydownHandler(event: KeyboardEvent) {
-		const forward = isF6Next(event);
-		const backward = isF6Previous(event);
-		if (!(forward || backward)) {
-			return;
-		}
-
-		this.updateGroups();
-
-		if (this.groups.length < 1) {
-			return;
-		}
-
-		event.preventDefault();
-
-		let elementToFocus;
-
-		if (this.groups.length === 0) {
-			elementToFocus = await this.groupElementToFocus(this.groups[0]);
-
-			return elementToFocus?.focus();
-		}
-
-		let currentIndex = -1;
-
-		if (this.selectedGroup) {
-			currentIndex = this.groups.indexOf(this.selectedGroup);
-		}
-
-		if (forward) {
-			elementToFocus = await this.findNextFocusableGroupElement(currentIndex);
-		}
-
-		if (backward) {
-			elementToFocus = await this.findPreviousFocusableGroupElement(currentIndex);
-		}
-
-		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/LegacyDateFormats.ts

@@ -1,40 +0,0 @@
-import { getFormatSettings } from "../InitialConfiguration.js";
-import type { FormatSettings } from "../config/FormatSettings.js";
-import { registerFeature } from "../FeaturesRegistry.js";
-
-// Allows specifying the customizing data for Islamic calendar support
-// dateFormat - The date format
-// islamicMonthStart - The Islamic date in string format // 14360101
-// gregDate - Corresponding Gregorian date to the Islamic one in string format // 20141024
-type IslamicToGregorianMapping = {
-	dateFormat: string,
-	islamicMonthStart: string,
-	gregDate: string,
-};
-type LegacyDateCalendarCustomizing = Array<IslamicToGregorianMapping>;
-
-let formatSettings: FormatSettings;
-
-class LegacyDateFormats {
-	/**
-	 * Returns the currently set customizing data for Islamic calendar support
-	 *
-	 * @return {object[]} Returns an array that contains the customizing data.
-	 * @public
-	 */
-	static getLegacyDateCalendarCustomizing(this: void): LegacyDateCalendarCustomizing {
-		if (formatSettings === undefined) {
-			formatSettings = getFormatSettings();
-		}
-
-		return formatSettings.legacyDateCalendarCustomizing || [];
-	}
-}
-
-registerFeature("LegacyDateFormats", LegacyDateFormats);
-
-export default LegacyDateFormats;
-export type {
-	FormatSettings,
-	LegacyDateCalendarCustomizing,
-};

package/src/features/OpenUI5Element.ts

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

package/src/features/OpenUI5Enablement.ts

@@ -1,117 +0,0 @@
-import { TemplateResult } from "lit-html";
-import { registerFeature } from "../FeaturesRegistry.js";
-import BusyIndicatorStyles from "../generated/css/BusyIndicator.css.js";
-import merge from "../thirdparty/merge.js";
-import {
-	isTabPrevious,
-} from "../Keys.js";
-
-import type UI5Element from "../UI5Element.js";
-import type OpenUI5Element from "./OpenUI5Element.js";
-
-const busyIndicatorMetadata = {
-	properties: {
-		__isBusy: {
-			type: Boolean,
-		},
-	},
-};
-
-class OpenUI5Enablement {
-	static wrapTemplateResultInBusyMarkup(html: (strings: TemplateStringsArray, ...values: Array<unknown>) => TemplateResult, host: OpenUI5Element, templateResult: 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;
-	}
-
-	static enrichBusyIndicatorSettings(klass: typeof UI5Element) {
-		OpenUI5Enablement.enrichBusyIndicatorMetadata(klass);
-		OpenUI5Enablement.enrichBusyIndicatorMethods(klass.prototype);
-	}
-
-	static enrichBusyIndicatorMetadata(klass: typeof UI5Element) {
-		klass.metadata = merge(klass.metadata, busyIndicatorMetadata);
-	}
-
-	static enrichBusyIndicatorMethods(UI5ElementPrototype: typeof OpenUI5Element.prototype) {
-		Object.defineProperties(UI5ElementPrototype, {
-			"__redirectFocus": { value: true, writable: true },
-			"__suppressFocusBack": {
-				get() {
-					return {
-						handleEvent: (e: KeyboardEvent) => {
-							if (isTabPrevious(e)) {
-								const beforeElem = this.shadowRoot.querySelector("[busy-indicator-before-span]");
-								this.__redirectFocus = false;
-								beforeElem.focus();
-								this.__redirectFocus = true;
-							}
-						},
-						capture: true,
-						passive: false,
-					};
-				},
-			},
-			"isOpenUI5Component": { get: () => { return true; } },
-		});
-
-		UI5ElementPrototype.__suppressFocusIn = function handleFocusIn() {
-			const busyIndicator = this.shadowRoot?.querySelector("[busy-indicator]") as HTMLElement;
-			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 as typeof UI5Element).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)") as HTMLElement;
-			}
-
-			return children[0] as HTMLElement;
-		};
-	}
-
-	static getBusyIndicatorStyles() {
-		return BusyIndicatorStyles;
-	}
-}
-
-registerFeature("OpenUI5Enablement", OpenUI5Enablement);
-
-export default OpenUI5Enablement;