@zanichelli/albe-web-components 4.0.4 → 4.2.0

package/dist/collection/components/z-popover/index.js

@@ -1,126 +1,332 @@
-import { Component, Prop, h, Host, State, Listen, Event, } from "@stencil/core";
-import classNames from "classnames";
-import { PopoverPosition, PopoverBorderRadius, PopoverShadow, KeyboardKeys, } from "../../beans";
+import { Component, Prop, h, Watch, Listen, Element, State, Event, } from "@stencil/core";
+import { PopoverPositions, KeyboardKeys } from "../../beans";
 import { getElementTree } from "../../utils/utils";
+const documentElement = document.documentElement;
+function getParentElement(element) {
+  if (element.parentNode.host) {
+    return element.parentNode.host;
+  }
+  return element.parentNode;
+}
+/**
+ * Find the closest scrollable parent of a node.
+ *
+ * @param {Element} element The node
+ */
+function findScrollableParent(element) {
+  let parent = getParentElement(element);
+  while (parent && parent !== documentElement) {
+    const { overflow, overflowX, overflowY } = window.getComputedStyle(parent);
+    if (overflow === "hidden" ||
+      overflowY === "hidden" ||
+      overflowX === "hidden") {
+      return parent;
+    }
+    if ((parent.scrollHeight > parent.clientHeight &&
+      overflow !== "visible" &&
+      overflowY !== "visible") ||
+      (parent.scrollWidth > parent.clientWidth &&
+        overflow !== "visible" &&
+        overflowX !== "visible")) {
+      return parent;
+    }
+    parent = getParentElement(parent);
+  }
+  return documentElement;
+}
+/**
+ * Calculate computed offset.
+ * It includes matrix transformations.
+ * @param element The target element.
+ * @param targetParentOffset The relative offset parent.
+ * @return A client rect object.
+ */
+function computeOffset(element, targetParentOffset) {
+  const rect = element.getBoundingClientRect();
+  const width = rect.width;
+  const height = rect.height;
+  let top = 0;
+  let left = 0;
+  let offsetParent = element;
+  while (offsetParent && offsetParent != targetParentOffset) {
+    left += offsetParent.offsetLeft;
+    // document.body sometimes has offsetTop == 0 but still has an
+    // offset because of children margins!
+    if (offsetParent === document.body) {
+      top += offsetParent.getBoundingClientRect().top + window.scrollY;
+    }
+    else {
+      top += offsetParent.offsetTop;
+    }
+    if (window.DOMMatrix) {
+      const style = window.getComputedStyle(offsetParent);
+      const transform = style.transform || style.webkitTransform;
+      const domMatrix = new DOMMatrix(transform);
+      if (domMatrix) {
+        left += domMatrix.m41;
+        if (offsetParent !== document.body) {
+          top += domMatrix.m42;
+        }
+      }
+    }
+    if (!offsetParent.offsetParent) {
+      break;
+    }
+    offsetParent = offsetParent.offsetParent;
+  }
+  let parentWidth;
+  let parentHeight;
+  if (offsetParent === document.body) {
+    parentWidth = window.innerWidth;
+    parentHeight = window.innerHeight;
+  }
+  else {
+    parentWidth = offsetParent.offsetWidth;
+    parentHeight = offsetParent.offsetHeight;
+  }
+  const right = parentWidth - left - rect.width;
+  const bottom = parentHeight - top - rect.height;
+  return { top, right, bottom, left, width, height };
+}
+/**
+ * Popover component.
+ *
+ * @cssprop --z-popover-theme--surface - background color of the popover.
+ * @cssprop --z-popover-theme--text - foreground color of the popover.
+ * @cssprop --z-popover-padding - padding of the popover.
+ * @cssprop --z-popover-shadow-filter - drop-shadow filter of the popover. Defaults to `drop-shadow(0 1px 2px var(--shadow-color-base))`.
+ */
 export class ZPopover {
-  /**
-   * Constructor.
-   */
   constructor() {
-    /** [optional] Popover position */
-    this.position = PopoverPosition["after-up"];
-    /** [optional] Background color token for popover */
-    this.backgroundColor = "color-white";
-    /** [optional] Border radius token for popover */
-    this.borderRadius = PopoverBorderRadius.small;
-    /** [optional] Box shadow token for popover */
-    this.boxShadow = PopoverShadow["shadow-1"];
-    /** [optional] Show or hide arrow */
+    /** Popover position. */
+    this.position = PopoverPositions.AUTO;
+    /**
+     * The open state of the popover.
+     */
+    this.open = false;
+    /**
+     * Whether to show popover's arrow.
+     */
     this.showArrow = false;
-    /** [optional] Sets padding for Popover container */
-    this.padding = "8px";
-    this.isVisible = false;
-    this.popoverPosition = this.position;
-    this.handleKeyDown = this.handleKeyDown.bind(this);
+    /**
+     * Whether to center the popup on the main side (according to "position").
+     */
+    this.center = false;
+    /**
+     * Whether the popover should be closed when the user clicks outside of it or hit "ESC".
+     */
+    this.closable = true;
   }
-  emitTriggerClick() {
-    this.triggerClick.emit({
-      isVisible: this.isVisible,
-    });
+  closePopoverWithKeyboard(e) {
+    if (this.closable && e.key === KeyboardKeys.ESC) {
+      this.open = false;
+    }
   }
-  openPopover() {
-    const width = document.body.clientWidth;
-    const height = window.innerHeight;
-    const rect = this.popoverElem.getBoundingClientRect();
-    const l = rect.left;
-    const r = rect.right;
-    const t = rect.top;
-    const b = rect.bottom;
-    let firstSide = this.position.split("-")[0];
-    let secondSide = this.position.split("-")[1];
-    // If top is outside viewport
-    if (t < 0) {
-      if (this.position.startsWith("above")) {
-        firstSide = "below";
+  handleOutsideClick(e) {
+    if (!this.closable) {
+      return;
+    }
+    const tree = getElementTree(e.target);
+    const parent = tree.find((elem) => elem.nodeName.toLowerCase() === "z-popover");
+    if (!parent) {
+      this.open = false;
+      this.positionChange.emit({ position: this.currentPosition });
+    }
+  }
+  validatePosition(newValue) {
+    if (newValue &&
+      Object.values(PopoverPositions).every((position) => newValue !== position)) {
+      this.position = PopoverPositions.AUTO;
+    }
+    this.currentPosition = this.position;
+    this.positionChange.emit({ position: this.currentPosition });
+  }
+  /**
+   * Setup popover behaviors on opening.
+   */
+  onOpen() {
+    cancelAnimationFrame(this.animationFrameRequestId);
+    if (this.open) {
+      const setPosition = () => {
+        if (this.open) {
+          this.setPosition();
+          this.animationFrameRequestId = requestAnimationFrame(setPosition);
+        }
+      };
+      setPosition();
+    }
+    else if (this.host.hasAttribute('current-position')) {
+      this.host.removeAttribute('current-position');
+      this.currentPosition = undefined;
+    }
+    this.openChange.emit({ open: this.open });
+  }
+  disconnectedCallback() {
+    cancelAnimationFrame(this.animationFrameRequestId);
+  }
+  /**
+   * Set the position of the popover.
+   */
+  setPosition() {
+    let element;
+    if (typeof this.bindTo === "string") {
+      element = this.host.ownerDocument.querySelector(this.bindTo);
+    }
+    else if (this.bindTo) {
+      element = this.bindTo;
+    }
+    else {
+      element = this.host.parentElement;
+    }
+    if (!element) {
+      return;
+    }
+    const scrollContainer = findScrollableParent(element);
+    const scrollingBoundingRect = scrollContainer.getBoundingClientRect();
+    const offsetContainer = this.host.offsetParent;
+    const relativeBoundingRect = offsetContainer
+      ? computeOffset(offsetContainer, scrollContainer)
+      : { top: 0, right: 0, bottom: 0, left: 0 };
+    const boundingRect = computeOffset(element, scrollContainer);
+    const top = boundingRect.top - scrollContainer.scrollTop;
+    const bottom = scrollingBoundingRect.height -
+      (boundingRect.top + boundingRect.height) +
+      scrollContainer.scrollTop;
+    const left = boundingRect.left - scrollContainer.scrollLeft;
+    const right = scrollingBoundingRect.width -
+      (boundingRect.left + boundingRect.width) +
+      scrollContainer.scrollLeft;
+    const overflowBottom = Math.max(0, scrollingBoundingRect.top +
+      scrollingBoundingRect.height -
+      window.innerHeight);
+    const overflowRight = Math.max(0, scrollingBoundingRect.left +
+      scrollingBoundingRect.width -
+      window.innerWidth);
+    const availableTop = Math.min(top, top + scrollingBoundingRect.top);
+    const availableBottom = Math.min(bottom, bottom - overflowBottom);
+    const availableLeft = Math.min(left, left + scrollingBoundingRect.left);
+    const availableRight = Math.min(right, right - overflowRight);
+    const availableHeight = availableTop + availableBottom + boundingRect.height;
+    const availableWidth = availableLeft + availableRight + boundingRect.width;
+    let position = this.currentPosition;
+    const positions = [];
+    if (this.position === PopoverPositions.AUTO) {
+      /**
+       * The `AUTO` position tries to place the popover in the 'safest' area,
+       * where there's more space available.
+       */
+      if (availableLeft / availableWidth > 0.6) {
+        positions.push(PopoverPositions.LEFT);
       }
-      else {
-        secondSide = "down";
+      else if (availableLeft / availableWidth < 0.4) {
+        positions.push(PopoverPositions.RIGHT);
       }
-    }
-    // If bottom is outside viewport
-    if (b > height) {
-      if (this.position.startsWith("below")) {
-        firstSide = "above";
+      if (availableTop / availableHeight > 0.9) {
+        positions.unshift(PopoverPositions.TOP);
       }
-      else {
-        secondSide = "up";
+      else if (availableTop / availableHeight > 0.6) {
+        positions.push(PopoverPositions.TOP);
       }
-    }
-    // If right is outside viewport
-    if (r > width) {
-      if (this.position.startsWith("above") ||
-        this.position.startsWith("below")) {
-        secondSide = "left";
+      else if (availableTop / availableHeight < 0.1) {
+        positions.unshift(PopoverPositions.BOTTOM);
       }
       else {
-        firstSide = "before";
+        positions.push(PopoverPositions.BOTTOM);
       }
+      position = positions.join("_");
     }
-    // If left is outside viewport
-    if (l < 0) {
-      if (this.position.startsWith("above") ||
-        this.position.startsWith("below")) {
-        secondSide = "right";
+    const style = this.host.style;
+    style.position = "absolute";
+    const offsetTop = boundingRect.top - relativeBoundingRect.top;
+    const offsetRight = boundingRect.right - relativeBoundingRect.right;
+    const offsetBottom = boundingRect.bottom - relativeBoundingRect.bottom;
+    const offsetLeft = boundingRect.left - relativeBoundingRect.left;
+    const offsetModifier = this.center ? 0.5 : 0;
+    const sizeModifier = this.center ? 0.5 : 0;
+    if (position === PopoverPositions.TOP ||
+      position === PopoverPositions.TOP_RIGHT) {
+      style.top = "auto";
+      style.right = "auto";
+      style.bottom = `${offsetBottom + boundingRect.height}px`;
+      style.left = `${offsetLeft + boundingRect.width * offsetModifier}px`;
+      style.maxHeight = `${availableTop}px`;
+      if (position === PopoverPositions.TOP_RIGHT) {
+        style.maxWidth = `${availableRight + boundingRect.width * sizeModifier}px`;
       }
-      else {
-        firstSide = "after";
+    }
+    else if (position === PopoverPositions.TOP_LEFT) {
+      style.top = "auto";
+      style.right = `${offsetRight + boundingRect.width * offsetModifier}px`;
+      style.bottom = `${offsetBottom + boundingRect.height}px`;
+      style.left = "auto";
+      style.maxWidth = `${availableLeft}px`;
+      style.maxHeight = `${availableTop}px`;
+    }
+    else if (position === PopoverPositions.BOTTOM ||
+      position === PopoverPositions.BOTTOM_RIGHT) {
+      style.top = `${offsetTop + boundingRect.height}px`;
+      style.right = "auto";
+      style.bottom = "auto";
+      style.left = `${offsetLeft + boundingRect.width * offsetModifier}px`;
+      style.maxHeight = `${availableBottom}px`;
+      if (position === PopoverPositions.BOTTOM_RIGHT) {
+        style.maxWidth = `${availableRight + boundingRect.width * sizeModifier}px`;
       }
     }
-    this.popoverPosition = PopoverPosition[`${firstSide}-${secondSide}`];
-    this.isVisible = true;
-  }
-  closePopover() {
-    this.popoverPosition = this.position;
-    this.isVisible = false;
-  }
-  closePopoverWithKeyboard(e) {
-    if (e.key === KeyboardKeys.ESC) {
-      this.closePopover();
+    else if (position === PopoverPositions.BOTTOM_LEFT) {
+      style.top = `${offsetTop + boundingRect.height}px`;
+      style.right = `${offsetRight + boundingRect.width * offsetModifier}px`;
+      style.bottom = "auto";
+      style.left = "auto";
+      style.maxWidth = `${availableLeft}px`;
+      style.maxHeight = `${availableBottom}px`;
     }
-  }
-  handleClick(event) {
-    this.isVisible ? this.closePopover() : this.openPopover();
-    this.emitTriggerClick();
-    event.stopPropagation();
-  }
-  handleKeyDown(event) {
-    if (event.code === KeyboardKeys.ENTER) {
-      this.isVisible ? this.closePopover() : this.openPopover();
+    else if (position === PopoverPositions.RIGHT ||
+      position === PopoverPositions.RIGHT_BOTTOM) {
+      style.top = `${offsetTop + boundingRect.height * offsetModifier}px`;
+      style.right = "auto";
+      style.bottom = "auto";
+      style.left = `${offsetLeft + boundingRect.width}px`;
+      style.maxWidth = `${availableRight}px`;
+      style.maxHeight = `${availableBottom + boundingRect.height * sizeModifier}px`;
     }
-  }
-  handleOutsideClick(e) {
-    const tree = getElementTree(e.target);
-    const parent = tree.find((elem) => elem.nodeName.toLowerCase() === "z-popover");
-    if (!parent) {
-      this.closePopover();
+    else if (position === PopoverPositions.RIGHT_TOP) {
+      style.top = "auto";
+      style.right = "auto";
+      style.bottom = `${offsetBottom + boundingRect.height * offsetModifier}px`;
+      style.left = `${offsetLeft + boundingRect.width}px`;
+      style.maxWidth = `${availableRight}px`;
+      style.maxHeight = `${availableTop + boundingRect.height * sizeModifier}px`;
     }
+    else if (position === PopoverPositions.LEFT ||
+      position === PopoverPositions.LEFT_BOTTOM) {
+      style.top = `${offsetTop + boundingRect.height * offsetModifier}px`;
+      style.right = `${offsetRight + boundingRect.width}px`;
+      style.bottom = "auto";
+      style.left = "auto";
+      style.maxWidth = `${availableLeft}px`;
+      style.maxHeight = `${availableBottom + boundingRect.height * sizeModifier}px`;
+    }
+    else if (position === PopoverPositions.LEFT_TOP) {
+      style.top = "auto";
+      style.right = `${offsetRight + boundingRect.width}px`;
+      style.bottom = `${offsetBottom + boundingRect.height * offsetModifier}px`;
+      style.left = "auto";
+      style.maxWidth = `${availableLeft}px`;
+      style.maxHeight = `${availableTop + boundingRect.height * sizeModifier}px`;
+    }
+    this.currentPosition = position || this.position;
+    this.host.setAttribute('current-position', this.currentPosition);
+  }
+  componentWillLoad() {
+    this.validatePosition(this.position);
+    this.onOpen();
   }
   render() {
-    return (h(Host, { onKeyDown: this.handleKeyDown },
-      h("div", { tabindex: "0", onClick: (event) => this.handleClick(event), onKeyDown: (event) => {
-          if (event.key === KeyboardKeys.ENTER) {
-            this.handleClick(event);
-          }
-        } },
-        h("slot", { name: "trigger" })),
-      h("div", { ref: (e) => (this.popoverElem = e), class: classNames("popover-content-container", this.popoverPosition, `border-radius-${this.borderRadius}`, this.boxShadow, { "show-arrow": this.showArrow }, { visible: this.isVisible }), style: {
-          backgroundColor: `var(--${this.backgroundColor})`,
-          padding: this.padding,
-        } },
-        h("slot", { name: "popover" }))));
+    return h("slot", null);
   }
   static get is() { return "z-popover"; }
-  static get encapsulation() { return "scoped"; }
+  static get encapsulation() { return "shadow"; }
   static get originalStyleUrls() { return {
     "$": ["styles.css"]
   }; }
@@ -130,55 +336,54 @@ export class ZPopover {
   static get properties() { return {
     "position": {
       "type": "string",
-      "mutable": false,
+      "mutable": true,
       "complexType": {
-        "original": "PopoverPosition",
-        "resolved": "typeof PopoverPosition[\"above-center\"] | typeof PopoverPosition[\"above-left\"] | typeof PopoverPosition[\"above-right\"] | typeof PopoverPosition[\"after-center\"] | typeof PopoverPosition[\"after-down\"] | typeof PopoverPosition[\"after-up\"] | typeof PopoverPosition[\"before-center\"] | typeof PopoverPosition[\"before-down\"] | typeof PopoverPosition[\"before-up\"] | typeof PopoverPosition[\"below-center\"] | typeof PopoverPosition[\"below-left\"] | typeof PopoverPosition[\"below-right\"]",
+        "original": "PopoverPositions",
+        "resolved": "PopoverPositions.AUTO | PopoverPositions.BOTTOM | PopoverPositions.BOTTOM_LEFT | PopoverPositions.BOTTOM_RIGHT | PopoverPositions.LEFT | PopoverPositions.LEFT_BOTTOM | PopoverPositions.LEFT_TOP | PopoverPositions.RIGHT | PopoverPositions.RIGHT_BOTTOM | PopoverPositions.RIGHT_TOP | PopoverPositions.TOP | PopoverPositions.TOP_LEFT | PopoverPositions.TOP_RIGHT",
         "references": {
-          "PopoverPosition": {
+          "PopoverPositions": {
             "location": "import",
             "path": "../../beans"
           }
         }
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
-        "text": "[optional] Popover position"
+        "text": "Popover position."
       },
       "attribute": "position",
-      "reflect": false,
-      "defaultValue": "PopoverPosition[\"after-up\"]"
+      "reflect": true,
+      "defaultValue": "PopoverPositions.AUTO"
     },
-    "backgroundColor": {
-      "type": "string",
-      "mutable": false,
+    "open": {
+      "type": "boolean",
+      "mutable": true,
       "complexType": {
-        "original": "string",
-        "resolved": "string",
+        "original": "boolean",
+        "resolved": "boolean",
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
-        "text": "[optional] Background color token for popover"
+        "text": "The open state of the popover."
       },
-      "attribute": "background-color",
-      "reflect": false,
-      "defaultValue": "\"color-white\""
+      "attribute": "open",
+      "reflect": true,
+      "defaultValue": "false"
     },
-    "borderRadius": {
+    "bindTo": {
       "type": "string",
       "mutable": false,
       "complexType": {
-        "original": "PopoverBorderRadius",
-        "resolved": "PopoverBorderRadius.medium | PopoverBorderRadius.none | PopoverBorderRadius.small",
+        "original": "string | HTMLElement",
+        "resolved": "HTMLElement | string",
         "references": {
-          "PopoverBorderRadius": {
-            "location": "import",
-            "path": "../../beans"
+          "HTMLElement": {
+            "location": "global"
           }
         }
       },
@@ -186,36 +391,30 @@ export class ZPopover {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "[optional] Border radius token for popover"
+        "text": "The selector or the element bound with the popover."
       },
-      "attribute": "border-radius",
-      "reflect": false,
-      "defaultValue": "PopoverBorderRadius.small"
+      "attribute": "bind-to",
+      "reflect": false
     },
-    "boxShadow": {
-      "type": "string",
+    "showArrow": {
+      "type": "boolean",
       "mutable": false,
       "complexType": {
-        "original": "PopoverShadow",
-        "resolved": "typeof PopoverShadow[\"shadow-1\"] | typeof PopoverShadow[\"shadow-12\"] | typeof PopoverShadow[\"shadow-16\"] | typeof PopoverShadow[\"shadow-2\"] | typeof PopoverShadow[\"shadow-24\"] | typeof PopoverShadow[\"shadow-3\"] | typeof PopoverShadow[\"shadow-4\"] | typeof PopoverShadow[\"shadow-6\"] | typeof PopoverShadow[\"shadow-8\"]",
-        "references": {
-          "PopoverShadow": {
-            "location": "import",
-            "path": "../../beans"
-          }
-        }
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
-        "text": "[optional] Box shadow token for popover"
+        "text": "Whether to show popover's arrow."
       },
-      "attribute": "box-shadow",
-      "reflect": false,
-      "defaultValue": "PopoverShadow[\"shadow-1\"]"
+      "attribute": "show-arrow",
+      "reflect": true,
+      "defaultValue": "false"
     },
-    "showArrow": {
+    "center": {
       "type": "boolean",
       "mutable": false,
       "complexType": {
@@ -224,47 +423,61 @@ export class ZPopover {
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
-        "text": "[optional] Show or hide arrow"
+        "text": "Whether to center the popup on the main side (according to \"position\")."
       },
-      "attribute": "show-arrow",
-      "reflect": false,
+      "attribute": "center",
+      "reflect": true,
       "defaultValue": "false"
     },
-    "padding": {
-      "type": "string",
+    "closable": {
+      "type": "boolean",
       "mutable": false,
       "complexType": {
-        "original": "string",
-        "resolved": "string",
+        "original": "boolean",
+        "resolved": "boolean",
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
-        "text": "[optional] Sets padding for Popover container"
+        "text": "Whether the popover should be closed when the user clicks outside of it or hit \"ESC\"."
       },
-      "attribute": "padding",
+      "attribute": "closable",
       "reflect": false,
-      "defaultValue": "\"8px\""
+      "defaultValue": "true"
     }
   }; }
   static get states() { return {
-    "isVisible": {},
-    "popoverPosition": {}
+    "currentPosition": {}
   }; }
   static get events() { return [{
-      "method": "triggerClick",
-      "name": "triggerClick",
+      "method": "positionChange",
+      "name": "positionChange",
       "bubbles": true,
       "cancelable": true,
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Emitted on popover click, returns isVisible state"
+        "text": "Position change event."
+      },
+      "complexType": {
+        "original": "any",
+        "resolved": "any",
+        "references": {}
+      }
+    }, {
+      "method": "openChange",
+      "name": "openChange",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [],
+        "text": "Open change event."
       },
       "complexType": {
         "original": "any",
@@ -272,13 +485,15 @@ export class ZPopover {
         "references": {}
       }
     }]; }
-  static get listeners() { return [{
-      "name": "closePopover",
-      "method": "closePopover",
-      "target": undefined,
-      "capture": false,
-      "passive": false
+  static get elementRef() { return "host"; }
+  static get watchers() { return [{
+      "propName": "position",
+      "methodName": "validatePosition"
     }, {
+      "propName": "open",
+      "methodName": "onOpen"
+    }]; }
+  static get listeners() { return [{
       "name": "keyup",
       "method": "closePopoverWithKeyboard",
       "target": "window",