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

package/src/Popover.js

@@ -0,0 +1,786 @@
+import Integer from "@ui5/webcomponents-base/dist/types/Integer.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";
+
+// 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;
+
+/**
+ * @public
+ */
+const metadata = {
+	tag: "ui5-popover",
+	properties: /** @lends sap.ui.webcomponents.main.Popover.prototype */ {
+		/**
+		 * Defines the header text.
+		 * <br><br>
+		 * <b>Note:</b> If <code>header</code> slot is provided, the <code>headerText</code> is ignored.
+		 *
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 */
+		headerText: {
+			type: String,
+		},
+
+		/**
+		 * Determines on which side the component is placed at.
+		 * <br><br>
+		 * Available options are:
+		 * <ul>
+		 * <li><code>Left</code></li>
+		 * <li><code>Right</code></li>
+		 * <li><code>Top</code></li>
+		 * <li><code>Bottom</code></li>
+		 * </ul>
+		 *
+		 * @type {PopoverPlacementType}
+		 * @defaultvalue "Right"
+		 * @public
+		 */
+		placementType: {
+			type: PopoverPlacementType,
+			defaultValue: PopoverPlacementType.Right,
+		},
+
+		/**
+		 * Determines the horizontal alignment of the component.
+		 * <br><br>
+		 * Available options are:
+		 * <ul>
+		 * <li><code>Center</code></li>
+		 * <li><code>Left</code></li>
+		 * <li><code>Right</code></li>
+		 * <li><code>Stretch</code></li>
+		 * </ul>
+		 *
+		 * @type {PopoverHorizontalAlign}
+		 * @defaultvalue "Center"
+		 * @public
+		 */
+		horizontalAlign: {
+			type: PopoverHorizontalAlign,
+			defaultValue: PopoverHorizontalAlign.Center,
+		},
+
+		/**
+		 * Determines the vertical alignment of the component.
+		 * <br><br>
+		 * Available options are:
+		 * <ul>
+		 * <li><code>Center</code></li>
+		 * <li><code>Top</code></li>
+		 * <li><code>Bottom</code></li>
+		 * <li><code>Stretch</code></li>
+		 * </ul>
+		 *
+		 * @type {PopoverVerticalAlign}
+		 * @defaultvalue "Center"
+		 * @public
+		 */
+		verticalAlign: {
+			type: PopoverVerticalAlign,
+			defaultValue: PopoverVerticalAlign.Center,
+		},
+
+		/**
+		 * Defines whether the component should close when
+		 * clicking/tapping outside of the popover.
+		 * If enabled, it blocks any interaction with the background.
+		 *
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
+		modal: {
+			type: Boolean,
+		},
+
+		/**
+		 * 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
+		 */
+		hideArrow: {
+			type: Boolean,
+		},
+
+		/**
+		 * Determines if there is no enough space, the component can be placed
+		 * over the target.
+		 *
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
+		allowTargetOverlap: {
+			type: Boolean,
+		},
+
+		/**
+		 * Defines whether the content is scrollable.
+		 *
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @private
+		 */
+		disableScrolling: {
+			type: Boolean,
+		},
+
+		/**
+		 * Sets the X translation of the arrow
+		 *
+		 * @private
+		 */
+		arrowTranslateX: {
+			type: Integer,
+			defaultValue: 0,
+			noAttribute: true,
+		},
+
+		/**
+		 * Sets the Y translation of the arrow
+		 *
+		 * @private
+		 */
+		arrowTranslateY: {
+			type: Integer,
+			defaultValue: 0,
+			noAttribute: true,
+		},
+
+		/**
+		 * Returns the calculated placement depending on the free space
+		 *
+		 * @private
+		 */
+		actualPlacementType: {
+			type: PopoverPlacementType,
+			defaultValue: PopoverPlacementType.Right,
+		},
+
+		_maxContentHeight: {
+			type: Integer,
+			noAttribute: true,
+		},
+		_maxContentWidth: {
+			type: Integer,
+			noAttribute: true,
+		},
+	},
+	managedSlots: true,
+	slots: /** @lends sap.ui.webcomponents.main.Popover.prototype */ {
+		/**
+		 * Defines the header HTML Element.
+		 *
+		 * @type {HTMLElement[]}
+		 * @slot
+		 * @public
+		 */
+		header: {
+			type: HTMLElement,
+		},
+
+		/**
+		 * Defines the footer HTML Element.
+		 *
+		 * @type {HTMLElement[]}
+		 * @slot
+		 * @public
+		 */
+		footer: {
+			type: HTMLElement,
+		},
+	},
+	events: /** @lends sap.ui.webcomponents.main.Popover.prototype */ {
+	},
+};
+
+/**
+ * @class
+ *
+ * <h3 class="comment-api-title">Overview</h3>
+ *
+ * The <code>ui5-popover</code> component displays additional information for an object
+ * in a compact way and without leaving the page.
+ * The Popover can contain various UI elements, such as fields, tables, images, and charts.
+ * It can also include actions in the footer.
+ *
+ * <h3>Structure</h3>
+ *
+ * The popover has three main areas:
+ * <ul>
+ * <li>Header (optional)</li>
+ * <li>Content</li>
+ * <li>Footer (optional)</li>
+ * </ul>
+ *
+ * <b>Note:</b> The <code>ui5-popover</code> is closed when the user clicks
+ * or taps outside the popover
+ * or selects an action within the popover. You can prevent this with the
+ * <code>modal</code> property.
+ *
+ * <h3>ES6 Module Import</h3>
+ *
+ * <code>import "@ui5/webcomponents/dist/Popover.js";</code>
+ *
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webcomponents.main.Popover
+ * @extends Popup
+ * @tagname ui5-popover
+ * @since 1.0.0-rc.6
+ * @public
+ */
+class Popover extends Popup {
+	constructor() {
+		super();
+
+		this._handleResize = this.handleResize.bind(this);
+	}
+
+	static get metadata() {
+		return metadata;
+	}
+
+	static get styles() {
+		return [browserScrollbarCSS, PopupsCommonCss, PopoverCss];
+	}
+
+	static get template() {
+		return PopoverTemplate;
+	}
+
+	static get VIEWPORT_MARGIN() {
+		return 10; // px
+	}
+
+	onEnterDOM() {
+		ResizeHandler.register(this, this._handleResize);
+	}
+
+	onExitDOM() {
+		ResizeHandler.deregister(this, this._handleResize);
+	}
+
+	isOpenerClicked(event) {
+		const target = event.target;
+		return target === this._opener || (target.getFocusDomRef && target.getFocusDomRef() === this._opener) || event.composedPath().indexOf(this._opener) > -1;
+	}
+
+	/**
+	 * 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
+	 */
+	async showAt(opener, preventInitialFocus = false) {
+		if (!opener || this.opened) {
+			return;
+		}
+
+		this._opener = opener;
+		this._openerRect = opener.getBoundingClientRect();
+
+		await super._open(preventInitialFocus);
+	}
+
+	/**
+	 * Override for the _addOpenedPopup hook, which would otherwise just call addOpenedPopup(this)
+	 * @private
+	 */
+	_addOpenedPopup() {
+		addOpenedPopover(this);
+	}
+
+	/**
+	 * Override for the _removeOpenedPopup hook, which would otherwise just call removeOpenedPopup(this)
+	 * @private
+	 */
+	_removeOpenedPopup() {
+		removeOpenedPopover(this);
+	}
+
+	shouldCloseDueToOverflow(placement, openerRect) {
+		const threshold = 32;
+		const limits = {
+			"Right": openerRect.right,
+			"Left": openerRect.left,
+			"Top": openerRect.top,
+			"Bottom": openerRect.bottom,
+		};
+
+		const closedPopupParent = getClosedPopupParent(this._opener);
+		let overflowsBottom = false;
+		let overflowsTop = false;
+
+		if (closedPopupParent.showAt) {
+			const contentRect = closedPopupParent.contentDOM.getBoundingClientRect();
+			overflowsBottom = openerRect.top > (contentRect.top + contentRect.height);
+			overflowsTop = (openerRect.top + openerRect.height) < contentRect.top;
+		}
+
+		return (limits[placement] < 0 || (limits[placement] + threshold > closedPopupParent.innerHeight)) || overflowsBottom || overflowsTop;
+	}
+
+	shouldCloseDueToNoOpener(openerRect) {
+		return openerRect.top === 0
+			&& openerRect.bottom === 0
+			&& openerRect.left === 0
+			&& openerRect.right === 0;
+	}
+
+	handleResize() {
+		if (this.opened) {
+			this.reposition();
+		}
+	}
+
+	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;
+		}
+
+		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;
+
+		let left = clamp(
+			this._left,
+			Popover.VIEWPORT_MARGIN,
+			document.documentElement.clientWidth - popoverSize.width - Popover.VIEWPORT_MARGIN,
+		);
+
+		if (this.actualPlacementType === PopoverPlacementType.Right) {
+			left = Math.max(left, this._left);
+		}
+
+		let top = clamp(
+			this._top,
+			Popover.VIEWPORT_MARGIN,
+			document.documentElement.clientHeight - popoverSize.height - Popover.VIEWPORT_MARGIN,
+		);
+
+		if (this.actualPlacementType === PopoverPlacementType.Bottom) {
+			top = Math.max(top, this._top);
+		}
+
+		let { arrowX, arrowY } = placement;
+		const isVertical = this.actualPlacementType === PopoverPlacementType.Top
+			|| this.actualPlacementType === PopoverPlacementType.Bottom;
+
+		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);
+
+		Object.assign(this.style, {
+			top: `${top}px`,
+			left: `${left}px`,
+		});
+		super._show();
+
+		if (stretching && this._width) {
+			this.style.width = this._width;
+		}
+	}
+
+	getPopoverSize() {
+		if (!this.opened) {
+			Object.assign(this.style, {
+				display: "block",
+				top: "-10000px",
+				left: "-10000px",
+			});
+		}
+
+		const rect = this.getBoundingClientRect(),
+			width = rect.width,
+			height = rect.height;
+
+		return { width, height };
+	}
+
+	get contentDOM() {
+		return this.shadowRoot.querySelector(".ui5-popup-content");
+	}
+
+	get arrowDOM() {
+		return this.shadowRoot.querySelector(".ui5-popover-arrow");
+	}
+
+	calcPlacement(targetRect, popoverSize) {
+		let left = 0;
+		let top = 0;
+		const allowTargetOverlap = this.allowTargetOverlap;
+
+		const clientWidth = document.documentElement.clientWidth;
+		const clientHeight = document.documentElement.clientHeight;
+
+		let maxHeight = clientHeight;
+		let maxWidth = clientWidth;
+
+		let width = "";
+		let height = "";
+
+		const placementType = this.getActualPlacementType(targetRect, popoverSize);
+
+		this._preventRepositionAndClose = this.shouldCloseDueToNoOpener(targetRect) || this.shouldCloseDueToOverflow(placementType, targetRect);
+
+		const isVertical = placementType === PopoverPlacementType.Top
+			|| placementType === PopoverPlacementType.Bottom;
+
+		if (this.horizontalAlign === PopoverHorizontalAlign.Stretch && isVertical) {
+			popoverSize.width = targetRect.width;
+			width = `${targetRect.width}px`;
+		} else if (this.verticalAlign === PopoverVerticalAlign.Stretch && !isVertical) {
+			popoverSize.height = targetRect.height;
+			height = `${targetRect.height}px`;
+		}
+
+		this._width = width;
+		this._height = height;
+
+		const arrowOffset = this.hideArrow ? 0 : arrowSize;
+
+		// calc popover positions
+		switch (placementType) {
+		case PopoverPlacementType.Top:
+			left = this.getVerticalLeft(targetRect, popoverSize);
+			top = Math.max(targetRect.top - popoverSize.height - arrowOffset, 0);
+
+			if (!allowTargetOverlap) {
+				maxHeight = targetRect.top - arrowOffset;
+			}
+			break;
+		case PopoverPlacementType.Bottom:
+			left = this.getVerticalLeft(targetRect, popoverSize);
+
+			if (allowTargetOverlap) {
+				top = Math.max(Math.min(targetRect.bottom + arrowOffset, clientHeight - popoverSize.height), 0);
+			} else {
+				top = targetRect.bottom + arrowOffset;
+				maxHeight = clientHeight - targetRect.bottom - arrowOffset;
+			}
+			break;
+		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);
+			break;
+		}
+
+		// correct popover positions
+		if (isVertical) {
+			if (popoverSize.width > clientWidth || left < 0) {
+				left = 0;
+			} else if (left + popoverSize.width > clientWidth) {
+				left -= left + popoverSize.width - clientWidth;
+			}
+		} else {
+			if (popoverSize.height > clientHeight || top < 0) { // eslint-disable-line
+				top = 0;
+			} else if (top + popoverSize.height > clientHeight) {
+				top -= top + popoverSize.height - clientHeight;
+			}
+		}
+
+		let maxContentHeight = maxHeight;
+
+		if (this._displayHeader) {
+			const headerDomRef = this.shadowRoot.querySelector(".ui5-popup-header-root")
+				|| this.shadowRoot.querySelector(".ui5-popup-header-text");
+
+			if (headerDomRef) {
+				maxContentHeight = maxHeight - headerDomRef.offsetHeight;
+			}
+		}
+
+		this._maxContentHeight = Math.round(maxContentHeight - Popover.VIEWPORT_MARGIN);
+		this._maxContentWidth = Math.round(maxWidth - Popover.VIEWPORT_MARGIN);
+
+		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);
+		}
+
+		if (this._top === undefined || Math.abs(this._top - top) > 1.5) {
+			this._top = Math.round(top);
+		}
+
+		return {
+			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
+	 */
+	fallbackPlacement(clientWidth, clientHeight, targetRect, popoverSize) {
+		if (targetRect.left > popoverSize.width) {
+			return PopoverPlacementType.Left;
+		}
+
+		if (clientWidth - targetRect.right > targetRect.left) {
+			return PopoverPlacementType.Right;
+		}
+
+		if (clientHeight - targetRect.bottom > popoverSize.height) {
+			return PopoverPlacementType.Bottom;
+		}
+
+		if (clientHeight - targetRect.bottom < targetRect.top) {
+			return PopoverPlacementType.Top;
+		}
+	}
+
+	getActualPlacementType(targetRect, popoverSize) {
+		const placementType = this.placementType;
+		let actualPlacementType = placementType;
+
+		const clientWidth = document.documentElement.clientWidth;
+		const clientHeight = document.documentElement.clientHeight;
+
+		switch (placementType) {
+		case PopoverPlacementType.Top:
+			if (targetRect.top < popoverSize.height
+				&& targetRect.top < clientHeight - targetRect.bottom) {
+				actualPlacementType = PopoverPlacementType.Bottom;
+			}
+			break;
+		case PopoverPlacementType.Bottom:
+			if (clientHeight - targetRect.bottom < popoverSize.height
+				&& clientHeight - targetRect.bottom < targetRect.top) {
+				actualPlacementType = PopoverPlacementType.Top;
+			}
+			break;
+		case PopoverPlacementType.Left:
+			if (targetRect.left < popoverSize.width) {
+				actualPlacementType = this.fallbackPlacement(clientWidth, clientHeight, targetRect, popoverSize) || placementType;
+			}
+			break;
+		case PopoverPlacementType.Right:
+			if (clientWidth - targetRect.right < popoverSize.width) {
+				actualPlacementType = this.fallbackPlacement(clientWidth, clientHeight, targetRect, popoverSize) || placementType;
+			}
+			break;
+		}
+
+		return actualPlacementType;
+	}
+
+	getVerticalLeft(targetRect, popoverSize) {
+		let left;
+
+		switch (this.horizontalAlign) {
+		case PopoverHorizontalAlign.Center:
+		case PopoverHorizontalAlign.Stretch:
+
+			left = targetRect.left - (popoverSize.width - targetRect.width) / 2;
+			break;
+		case PopoverHorizontalAlign.Left:
+			left = targetRect.left;
+			break;
+		case PopoverHorizontalAlign.Right:
+			left = targetRect.right - popoverSize.width;
+			break;
+		}
+
+		return left;
+	}
+
+	getHorizontalTop(targetRect, popoverSize) {
+		let top;
+
+		switch (this.verticalAlign) {
+		case PopoverVerticalAlign.Center:
+		case PopoverVerticalAlign.Stretch:
+			top = targetRect.top - (popoverSize.height - targetRect.height) / 2;
+			break;
+		case PopoverVerticalAlign.Top:
+			top = targetRect.top;
+			break;
+		case PopoverVerticalAlign.Bottom:
+			top = targetRect.bottom - popoverSize.height;
+			break;
+		}
+
+		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)`,
+			},
+		};
+	}
+
+	/**
+	 * Hook for descendants to hide header.
+	 */
+	get _displayHeader() {
+		return this.header.length || this.headerText;
+	}
+
+	/**
+	 * Hook for descendants to hide footer.
+	 */
+	get _displayFooter() {
+		return true;
+	}
+}
+
+Popover.define();
+
+export default Popover;