@ui5/webcomponents 0.0.0-39bd3067f → 0.0.0-4180fe799

package/dist/Popover.js

@@ -1,16 +1,18 @@
-import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
-import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
-import { getFirstFocusableElement, getLastFocusableElement } from "@ui5/webcomponents-base/dist/util/FocusableElements.js";
 import Integer from "@ui5/webcomponents-base/dist/types/Integer.js";
-import PopoverTemplate from "./generated/templates/PopoverTemplate.lit.js";
+import ResizeHandler from "@ui5/webcomponents-base/dist/delegate/ResizeHandler.js";
+import { getClosedPopupParent } from "@ui5/webcomponents-base/dist/util/PopupUtils.js";
+import clamp from "@ui5/webcomponents-base/dist/util/clamp.js";
+import Popup from "./Popup.js";
 import PopoverPlacementType from "./types/PopoverPlacementType.js";
 import PopoverVerticalAlign from "./types/PopoverVerticalAlign.js";
 import PopoverHorizontalAlign from "./types/PopoverHorizontalAlign.js";
-
 import { addOpenedPopover, removeOpenedPopover } from "./popup-utils/PopoverRegistry.js";
-import { getFocusedElement, getClosedPopupParent, getNextZIndex } from "./popup-utils/PopupUtils.js";
 
+// Template
+import PopoverTemplate from "./generated/templates/PopoverTemplate.lit.js";
 // Styles
+import browserScrollbarCSS from "./generated/themes/BrowserScrollbar.css.js";
+import PopupsCommonCss from "./generated/themes/PopupsCommon.css.js";
 import PopoverCss from "./generated/themes/Popover.css.js";
 
 const arrowSize = 8;
@@ -21,17 +23,6 @@ const arrowSize = 8;
 const metadata = {
 	tag: "ui5-popover",
 	properties: /** @lends sap.ui.webcomponents.main.Popover.prototype */ {
-		/**
-		 * Defines the ID of the HTML Element, which will get the initial focus.
-		 *
-		 * @type {string}
-		 * @defaultvalue ""
-		 * @public
-		 */
-		initialFocus: {
-			type: String,
-		},
-
 		/**
 		 * Defines the header text.
 		 * <br><br>
@@ -46,7 +37,7 @@ const metadata = {
 		},
 
 		/**
-		 * Determines on which side the <code>ui5-popover</code> is placed at.
+		 * Determines on which side the component is placed at.
 		 * <br><br>
 		 * Available options are:
 		 * <ul>
@@ -66,7 +57,7 @@ const metadata = {
 		},
 
 		/**
-		 * Determines the horizontal alignment of the <code>ui5-popover</code>.
+		 * Determines the horizontal alignment of the component.
 		 * <br><br>
 		 * Available options are:
 		 * <ul>
@@ -86,7 +77,7 @@ const metadata = {
 		},
 
 		/**
-		 * Determines the vertical alignment of the <code>ui5-popover</code>.
+		 * Determines the vertical alignment of the component.
 		 * <br><br>
 		 * Available options are:
 		 * <ul>
@@ -106,7 +97,7 @@ const metadata = {
 		},
 
 		/**
-		 * Defines whether the <code>ui5-popover</code> should close when
+		 * Defines whether the component should close when
 		 * clicking/tapping outside of the popover.
 		 * If enabled, it blocks any interaction with the background.
 		 *
@@ -119,18 +110,30 @@ const metadata = {
 		},
 
 		/**
-		 * Determines whether the <code>ui5-popover</code> arrow is hidden.
+		 * Defines whether the block layer will be shown if modal property is set to true.
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 * @since 1.0.0-rc.10
+		 */
+		hideBackdrop: {
+			type: Boolean,
+		},
+
+		/**
+		 * Determines whether the component arrow is hidden.
 		 *
 		 * @type {boolean}
 		 * @defaultvalue false
 		 * @public
+		 * @since 1.0.0-rc.15
 		 */
-		noArrow: {
+		hideArrow: {
 			type: Boolean,
 		},
 
 		/**
-		 * Determines if there is no enough space, the <code>ui5-popover</code> can be placed
+		 * Determines if there is no enough space, the component can be placed
 		 * over the target.
 		 *
 		 * @type {boolean}
@@ -141,6 +144,17 @@ const metadata = {
 			type: Boolean,
 		},
 
+		/**
+		 * Defines whether the content is scrollable.
+		 *
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @private
+		 */
+		disableScrolling: {
+			type: Boolean,
+		},
+
 		/**
 		 * Sets the X translation of the arrow
 		 *
@@ -173,34 +187,17 @@ const metadata = {
 			defaultValue: PopoverPlacementType.Right,
 		},
 
-		/**
-		 * Defines whether the <code>ui5-popover</code> is open
-		 *
-		 * @private
-		 */
-		opened: { type: Boolean },
-
-		_maxContentHeight: { type: Integer },
-
-		/**
-		 * @private
-		 */
-		_disableInitialFocus: {
-			type: Boolean,
+		_maxContentHeight: {
+			type: Integer,
+			noAttribute: true,
+		},
+		_maxContentWidth: {
+			type: Integer,
+			noAttribute: true,
 		},
 	},
 	managedSlots: true,
 	slots: /** @lends sap.ui.webcomponents.main.Popover.prototype */ {
-		/**
-		 * Defines the content of the Web Component.
-		 * @type {Node[]}
-		 * @slot
-		 * @public
-		 */
-		"default": {
-			type: HTMLElement,
-		},
-
 		/**
 		 * Defines the header HTML Element.
 		 *
@@ -224,40 +221,6 @@ const metadata = {
 		},
 	},
 	events: /** @lends sap.ui.webcomponents.main.Popover.prototype */ {
-		/**
-		 * Fired before the component is opened.
-		 *
-		 * @public
-		 * @event
-		 */
-		beforeOpen: {},
-
-		/**
-		 * Fired after the component is opened.
-		 *
-		 * @public
-		 * @event
-		 */
-		afterOpen: {},
-
-		/**
-		 * Fired before the component is closed.
-		 *
-		 * @public
-		 * @event
-		 * @param {Boolean} escPressed Indicates that <code>ESC</code> key has triggered the event.
-		 */
-		beforeClose: {
-			escPressed: { type: Boolean },
-		},
-
-		/**
-		 * Fired after the component is closed.
-		 *
-		 * @public
-		 * @event
-		 */
-		afterClose: {},
 	},
 };
 
@@ -292,135 +255,84 @@ const metadata = {
  * @constructor
  * @author SAP SE
  * @alias sap.ui.webcomponents.main.Popover
- * @extends UI5Element
+ * @extends Popup
  * @tagname ui5-popover
  * @since 1.0.0-rc.6
  * @public
  */
-class Popover extends UI5Element {
-	static get metadata() {
-		return metadata;
+class Popover extends Popup {
+	constructor() {
+		super();
+
+		this._handleResize = this.handleResize.bind(this);
 	}
 
-	static get render() {
-		return litRender;
+	static get metadata() {
+		return metadata;
 	}
 
 	static get styles() {
-		return PopoverCss;
+		return [browserScrollbarCSS, PopupsCommonCss, PopoverCss];
 	}
 
 	static get template() {
 		return PopoverTemplate;
 	}
 
-	forwardToFirst() {
-		const firstFocusable = getFirstFocusableElement(this.contentDOM);
-
-		if (firstFocusable) {
-			firstFocusable.focus();
-		}
+	static get VIEWPORT_MARGIN() {
+		return 10; // px
 	}
 
-	forwardToLast() {
-		const lastFocusable = getLastFocusableElement(this.contentDOM);
+	onEnterDOM() {
+		ResizeHandler.register(this, this._handleResize);
+	}
 
-		if (lastFocusable) {
-			lastFocusable.focus();
-		}
+	onExitDOM() {
+		ResizeHandler.deregister(this, this._handleResize);
 	}
 
 	isOpenerClicked(event) {
 		const target = event.target;
-		return target === this._opener || (target.getFocusDomRef && target.getFocusDomRef() === this._opener);
+		return target === this._opener || (target.getFocusDomRef && target.getFocusDomRef() === this._opener) || event.composedPath().indexOf(this._opener) > -1;
 	}
 
 	/**
-	 * Opens the popover.
-	 * @param {HTMLElement} opener the element that the popover is opened by
+	 * Shows the popover.
+	 * @param {HTMLElement} opener the element that the popover is shown at
+	 * @param {boolean} preventInitialFocus prevents applying the focus inside the popover
 	 * @public
+	 * @async
+	 * @returns {Promise} Resolved when the popover is open
 	 */
-	openBy(opener) {
+	async showAt(opener, preventInitialFocus = false) {
 		if (!opener || this.opened) {
 			return;
 		}
 
 		this._opener = opener;
-		this._focusedElementBeforeOpen = getFocusedElement();
-		this.style.zIndex = getNextZIndex();
-
-		this.fireEvent("beforeOpen", {});
-		this.reposition();
-		this.applyInitialFocus();
+		this._openerRect = opener.getBoundingClientRect();
 
-		addOpenedPopover(this);
-
-		this.opened = true;
-		this.fireEvent("afterOpen", {});
+		await super._open(preventInitialFocus);
 	}
 
 	/**
-	 * Closes the popover.
-	 * @public
+	 * Override for the _addOpenedPopup hook, which would otherwise just call addOpenedPopup(this)
+	 * @private
 	 */
-	close(escPressed = false, preventRegitryUpdate = false, preventFocusRestore = false) {
-		if (!this.opened) {
-			return;
-		}
-
-		this.fireEvent("beforeClose", {
-			escPressed,
-		}, true);
-
-
-		this.opened = false;
-
-		if (!preventRegitryUpdate) {
-			removeOpenedPopover(this);
-		}
-
-		if (!preventFocusRestore) {
-			this.resetFocus();
-		}
-
-		this.hide();
-		this.fireEvent("afterClose", {});
-	}
-
-	get focusedElement() {
-		let element = document.activeElement;
-
-		while (element.shadowRoot && element.shadowRoot.activeElement) {
-			element = element.shadowRoot.activeElement;
-		}
-
-		return (element && typeof element.focus === "function") ? element : null;
-	}
-
-	applyInitialFocus() {
-		if (this._disableInitialFocus) {
-			return;
-		}
-
-		const element = this.getRootNode().getElementById(this.initialFocus) || document.getElementById(this.initialFocus) || getFirstFocusableElement(this.contentDOM);
-
-		if (element) {
-			element.focus();
-		}
+	_addOpenedPopup() {
+		addOpenedPopover(this);
 	}
 
-	resetFocus() {
-		if (!this._focusedElementBeforeOpen) {
-			return;
-		}
-
-		this._focusedElementBeforeOpen.focus();
-		this._focusedElementBeforeOpen = null;
+	/**
+	 * Override for the _removeOpenedPopup hook, which would otherwise just call removeOpenedPopup(this)
+	 * @private
+	 */
+	_removeOpenedPopup() {
+		removeOpenedPopover(this);
 	}
 
-	shouldCloseDueOverflow(placement, openerRect) {
+	shouldCloseDueToOverflow(placement, openerRect) {
 		const threshold = 32;
-
 		const limits = {
 			"Right": openerRect.right,
 			"Left": openerRect.left,
@@ -432,7 +344,7 @@ class Popover extends UI5Element {
 		let overflowsBottom = false;
 		let overflowsTop = false;
 
-		if (closedPopupParent.openBy) {
+		if (closedPopupParent.showAt) {
 			const contentRect = closedPopupParent.contentDOM.getBoundingClientRect();
 			overflowsBottom = openerRect.top > (contentRect.top + contentRect.height);
 			overflowsTop = (openerRect.top + openerRect.height) < contentRect.top;
@@ -441,73 +353,133 @@ class Popover extends UI5Element {
 		return (limits[placement] < 0 || (limits[placement] + threshold > closedPopupParent.innerHeight)) || overflowsBottom || overflowsTop;
 	}
 
-	reposition() {
-		const popoverSize = this.popoverSize;
-		const openerRect = this._opener.getBoundingClientRect();
-		const placement = this.calcPlacement(openerRect, popoverSize);
-		const streching = this.horizontalAlign === PopoverHorizontalAlign.Stretch;
+	shouldCloseDueToNoOpener(openerRect) {
+		return openerRect.top === 0
+			&& openerRect.bottom === 0
+			&& openerRect.left === 0
+			&& openerRect.right === 0;
+	}
 
-		if (this._preventRepositionAndClose) {
-			return this.close();
+	handleResize() {
+		if (this.opened) {
+			this.reposition();
 		}
+	}
 
-		if (this._oldPlacement && (this._oldPlacement.left === placement.left) && (this._oldPlacement.top === placement.top) && streching) {
-			this.style.display = "inline-block";
-			this.style.width = this._width;
+	reposition() {
+		this._show();
+	}
+
+	_show() {
+		let placement;
+		const popoverSize = this.getPopoverSize();
+
+		if (popoverSize.width === 0 || popoverSize.height === 0) {
+			// size can not be determined properly at this point, popover will be shown with the next reposition
 			return;
 		}
 
-		this._oldPlacement = placement;
+		if (this.isOpen()) {
+			// update opener rect if it was changed during the popover being opened
+			this._openerRect = this._opener.getBoundingClientRect();
+		}
+
+		if (this.shouldCloseDueToNoOpener(this._openerRect) && this.isFocusWithin()) {
+			// reuse the old placement as the opener is not available,
+			// but keep the popover open as the focus is within
+			placement = this._oldPlacement;
+		} else {
+			placement = this.calcPlacement(this._openerRect, popoverSize);
+		}
+
+		const stretching = this.horizontalAlign === PopoverHorizontalAlign.Stretch;
 
+		if (this._preventRepositionAndClose) {
+			return this.close();
+		}
+
+		this._oldPlacement = placement;
 		this.actualPlacementType = placement.placementType;
-		this.arrowTranslateX = placement.arrowX;
-		this.arrowTranslateY = placement.arrowY;
 
-		this.style.left = `${this._left}px`;
-		this.style.top = `${this._top}px`;
-		this.style.display = "inline-block";
+		let left = clamp(
+			this._left,
+			Popover.VIEWPORT_MARGIN,
+			document.documentElement.clientWidth - popoverSize.width - Popover.VIEWPORT_MARGIN,
+		);
 
-		if (streching && this._width) {
-			this.style.width = this._width;
+		if (this.actualPlacementType === PopoverPlacementType.Right) {
+			left = Math.max(left, this._left);
 		}
-	}
 
-	hide() {
-		this.style.display = "none";
-	}
+		let top = clamp(
+			this._top,
+			Popover.VIEWPORT_MARGIN,
+			document.documentElement.clientHeight - popoverSize.height - Popover.VIEWPORT_MARGIN,
+		);
 
-	get popoverSize() {
-		let width,
-			height;
-		let rect = this.getBoundingClientRect();
+		if (this.actualPlacementType === PopoverPlacementType.Bottom) {
+			top = Math.max(top, this._top);
+		}
 
-		if (this.opened) {
-			width = rect.width;
-			height = rect.height;
+		let { arrowX, arrowY } = placement;
+		const isVertical = this.actualPlacementType === PopoverPlacementType.Top
+			|| this.actualPlacementType === PopoverPlacementType.Bottom;
 
-			return { width, height };
+		if (isVertical) {
+			const popoverOnLeftBorderOffset = Popover.VIEWPORT_MARGIN - this._left;
+			const popoverOnRightBorderOffset = this._left + popoverSize.width + Popover.VIEWPORT_MARGIN - document.documentElement.clientWidth;
+			if (popoverOnLeftBorderOffset > 0) {
+				arrowX -= popoverOnLeftBorderOffset;
+			} else if (popoverOnRightBorderOffset > 0) {
+				arrowX += popoverOnRightBorderOffset;
+			}
+		}
+		this.arrowTranslateX = Math.round(arrowX);
+
+		if (!isVertical) {
+			const popoverOnTopBorderOffset = Popover.VIEWPORT_MARGIN - this._top;
+			const popoverOnBottomBorderOffset = this._top + popoverSize.height + Popover.VIEWPORT_MARGIN - document.documentElement.clientHeight;
+			if (popoverOnTopBorderOffset > 0) {
+				arrowY -= popoverOnTopBorderOffset;
+			} else if (popoverOnBottomBorderOffset > 0) {
+				arrowY += popoverOnBottomBorderOffset;
+			}
 		}
+		this.arrowTranslateY = Math.round(arrowY);
 
-		this.style.visibility = "hidden";
-		this.style.display = "inline-block";
+		Object.assign(this.style, {
+			top: `${top}px`,
+			left: `${left}px`,
+		});
+		super._show();
 
-		rect = this.getBoundingClientRect();
+		if (stretching && this._width) {
+			this.style.width = this._width;
+		}
+	}
 
-		width = rect.width;
-		height = rect.height;
+	getPopoverSize() {
+		if (!this.opened) {
+			Object.assign(this.style, {
+				display: "block",
+				top: "-10000px",
+				left: "-10000px",
+			});
+		}
 
-		this.style.display = "none";
-		this.style.visibility = "visible";
+		const rect = this.getBoundingClientRect(),
+			width = rect.width,
+			height = rect.height;
 
 		return { width, height };
 	}
 
 	get contentDOM() {
-		return this.shadowRoot.querySelector(".ui5-popover-content");
+		return this.shadowRoot.querySelector(".ui5-popup-content");
 	}
 
 	get arrowDOM() {
-		return this.shadowRoot.querySelector(".ui5-popover-arr");
+		return this.shadowRoot.querySelector(".ui5-popover-arrow");
 	}
 
 	calcPlacement(targetRect, popoverSize) {
@@ -519,13 +491,14 @@ class Popover extends UI5Element {
 		const clientHeight = document.documentElement.clientHeight;
 
 		let maxHeight = clientHeight;
+		let maxWidth = clientWidth;
 
 		let width = "";
 		let height = "";
 
 		const placementType = this.getActualPlacementType(targetRect, popoverSize);
 
-		this._preventRepositionAndClose = this.shouldCloseDueOverflow(placementType, targetRect);
+		this._preventRepositionAndClose = this.shouldCloseDueToNoOpener(targetRect) || this.shouldCloseDueToOverflow(placementType, targetRect);
 
 		const isVertical = placementType === PopoverPlacementType.Top
 			|| placementType === PopoverPlacementType.Bottom;
@@ -541,7 +514,7 @@ class Popover extends UI5Element {
 		this._width = width;
 		this._height = height;
 
-		const arrowOffset = this.noArrow ? 0 : arrowSize;
+		const arrowOffset = this.hideArrow ? 0 : arrowSize;
 
 		// calc popover positions
 		switch (placementType) {
@@ -566,12 +539,17 @@ class Popover extends UI5Element {
 		case PopoverPlacementType.Left:
 			left = Math.max(targetRect.left - popoverSize.width - arrowOffset, 0);
 			top = this.getHorizontalTop(targetRect, popoverSize);
+
+			if (!allowTargetOverlap) {
+				maxWidth = targetRect.left - arrowOffset;
+			}
 			break;
 		case PopoverPlacementType.Right:
 			if (allowTargetOverlap) {
 				left = Math.max(Math.min(targetRect.left + targetRect.width + arrowOffset, clientWidth - popoverSize.width), 0);
 			} else {
 				left = targetRect.left + targetRect.width + arrowOffset;
+				maxWidth = clientWidth - targetRect.right - arrowOffset;
 			}
 
 			top = this.getHorizontalTop(targetRect, popoverSize);
@@ -593,23 +571,21 @@ class Popover extends UI5Element {
 			}
 		}
 
-		let maxContentHeight = Math.round(maxHeight);
+		let maxContentHeight = maxHeight;
 
-		const hasHeader = this.header.length || this.headerText;
-
-		if (hasHeader) {
-			const headerDomRef = this.shadowRoot.querySelector(".ui5-popover-header-root")
+		if (this._displayHeader) {
+			const headerDomRef = this.shadowRoot.querySelector(".ui5-popup-header-root")
 				|| this.shadowRoot.querySelector(".ui5-popup-header-text");
 
 			if (headerDomRef) {
-				maxContentHeight = Math.round(maxHeight - headerDomRef.offsetHeight);
+				maxContentHeight = maxHeight - headerDomRef.offsetHeight;
 			}
 		}
 
-		this._maxContentHeight = maxContentHeight;
+		this._maxContentHeight = Math.round(maxContentHeight - Popover.VIEWPORT_MARGIN);
+		this._maxContentWidth = Math.round(maxWidth - Popover.VIEWPORT_MARGIN);
 
-		const arrowTranslateX = isVertical ? targetRect.left + targetRect.width / 2 - left - popoverSize.width / 2 : 0;
-		const arrowTranslateY = !isVertical ? targetRect.top + targetRect.height / 2 - top - popoverSize.height / 2 : 0;
+		const arrowPos = this.getArrowPosition(targetRect, popoverSize, left, top, isVertical);
 
 		if (this._left === undefined || Math.abs(this._left - left) > 1.5) {
 			this._left = Math.round(left);
@@ -620,14 +596,51 @@ class Popover extends UI5Element {
 		}
 
 		return {
-			arrowX: Math.round(arrowTranslateX),
-			arrowY: Math.round(arrowTranslateY),
+			arrowX: arrowPos.x,
+			arrowY: arrowPos.y,
 			top: this._top,
 			left: this._left,
 			placementType,
 		};
 	}
 
+	/**
+	 * Calculates the position for the arrow.
+	 * @private
+	 * @param targetRect BoundingClientRect of the target element
+	 * @param popoverSize Width and height of the popover
+	 * @param left Left offset of the popover
+	 * @param top Top offset of the popover
+	 * @param isVertical if the popover is positioned vertically to the target element
+	 * @returns {{x: number, y: number}} Arrow's coordinates
+	 */
+	getArrowPosition(targetRect, popoverSize, left, top, isVertical) {
+		let arrowXCentered = this.horizontalAlign === PopoverHorizontalAlign.Center || this.horizontalAlign === PopoverHorizontalAlign.Stretch;
+
+		if (this.horizontalAlign === PopoverHorizontalAlign.Right && left <= targetRect.left) {
+			arrowXCentered = true;
+		}
+
+		if (this.horizontalAlign === PopoverHorizontalAlign.Left && left + popoverSize.width >= targetRect.left + targetRect.width) {
+			arrowXCentered = true;
+		}
+
+		let arrowTranslateX = 0;
+		if (isVertical && arrowXCentered) {
+			arrowTranslateX = targetRect.left + targetRect.width / 2 - left - popoverSize.width / 2;
+		}
+
+		let arrowTranslateY = 0;
+		if (!isVertical) {
+			arrowTranslateY = targetRect.top + targetRect.height / 2 - top - popoverSize.height / 2;
+		}
+
+		return {
+			x: Math.round(arrowTranslateX),
+			y: Math.round(arrowTranslateY),
+		};
+	}
+
 	/**
 	 * Fallbacks to new placement, prioritizing <code>Left</code> and <code>Right</code> placements.
 	 * @private
@@ -691,6 +704,7 @@ class Popover extends UI5Element {
 		switch (this.horizontalAlign) {
 		case PopoverHorizontalAlign.Center:
 		case PopoverHorizontalAlign.Stretch:
+
 			left = targetRect.left - (popoverSize.width - targetRect.width) / 2;
 			break;
 		case PopoverHorizontalAlign.Left:
@@ -723,15 +737,32 @@ class Popover extends UI5Element {
 		return top;
 	}
 
+	get isModal() { // Required by Popup.js
+		return this.modal;
+	}
+
+	get shouldHideBackdrop() { // Required by Popup.js
+		return this.hideBackdrop;
+	}
+
+	get _ariaLabelledBy() { // Required by Popup.js
+		return this.accessibleName ? undefined : "ui5-popup-header";
+	}
+
+	get _ariaModal() { // Required by Popup.js
+		return true;
+	}
+
 	get styles() {
 		return {
+			...super.styles,
 			content: {
 				"max-height": `${this._maxContentHeight}px`,
+				"max-width": `${this._maxContentWidth}px`,
 			},
 			arrow: {
 				transform: `translate(${this.arrowTranslateX}px, ${this.arrowTranslateY}px)`,
 			},
-			root: { },
 		};
 	}
 
@@ -739,7 +770,7 @@ class Popover extends UI5Element {
 	 * Hook for descendants to hide header.
 	 */
 	get _displayHeader() {
-		return true;
+		return this.header.length || this.headerText;
 	}
 
 	/**