@watermarkinsights/ripple 3.0.1-0 → 3.0.2-0

package/dist/collection/components/wm-action-menu/wm-action-menu.js

@@ -0,0 +1,392 @@
+import { h, Component, Element, Listen, Prop, State, Event, Host } from "@stencil/core";
+import { generateId, getTextDir, shouldOpenUp, shouldShiftRight } from "../../global/functions";
+export class ActionMenu {
+  constructor() {
+    this.openUp = false;
+    this.isExpanded = false;
+    this.buttonType = "icon";
+    this.disabled = false;
+    this.keysSoFar = "";
+    this.searchIndex = 0;
+    this.keyClear = null;
+  }
+  get horizontalPosition() {
+    return !!this.el && !!this.itemsEl && shouldShiftRight(this.el, this.itemsEl) ? "right" : "left";
+  }
+  get childItems() {
+    return Array.from(this.el.querySelectorAll("wm-menuitem"));
+  }
+  handleClickedItem() {
+    this.close();
+  }
+  handleKeyUp(ev) {
+    this.moveUp(ev.target);
+  }
+  handleKeyDown(ev) {
+    this.moveDown(ev.detail);
+  }
+  handleHomeKey() {
+    this.focusFirstItem();
+  }
+  handleEndKey() {
+    this.focusLastItem();
+  }
+  handleTabKey() {
+    if (this.isExpanded) {
+      this.close();
+    }
+  }
+  handleEscKey() {
+    this.close();
+    this.wmButtonEl.focus();
+  }
+  blurHandler(ev) {
+    const isElOrChild = ev.target === this.el || this.el.contains(ev.target);
+    if (!isElOrChild && this.isExpanded) {
+      this.close();
+    }
+  }
+  handleKey(ev) {
+    switch (ev.key) {
+      case "ArrowDown":
+        if (!this.isExpanded) {
+          ev.preventDefault();
+          this.open();
+          window.requestAnimationFrame(() => this.focusFirstItem());
+        }
+        break;
+      case "ArrowUp":
+        if (!this.isExpanded) {
+          ev.preventDefault();
+          this.open();
+          window.requestAnimationFrame(() => this.focusLastItem());
+        }
+        break;
+    }
+  }
+  componentWillLoad() {
+    this.uid = this.el.id ? this.el.id : generateId();
+    this.el.focus = function () {
+      if (!this.disabled) {
+        const button = this.shadowRoot.querySelector("wm-button");
+        button && button.focus();
+      }
+    };
+  }
+  componentDidLoad() {
+    if (this.childItems.length === 0) {
+      console.error("wm-action-menu should have wm-menuitem elements as children");
+    }
+    else {
+      this.focusFirstItem();
+    }
+    if (this.buttonType !== "icon" && !this.buttonText) {
+      console.error("wm-action-menu should have a valid button-text property when button-type is set to 'text' or 'selector'");
+    }
+    if (this.buttonType === "icon" && !this.tooltip) {
+      console.error("wm-action-menu should have a valid tooltip when button-type is set to 'icon'");
+    }
+    this.menuLoaded.emit();
+  }
+  moveUp(el) {
+    const index = this.childItems.indexOf(el);
+    if (index === 0) {
+      this.focusLastItem();
+    }
+    else {
+      this.focusItem(this.childItems[index - 1]);
+    }
+  }
+  moveDown(el) {
+    const index = this.childItems.indexOf(el);
+    if (index === this.childItems.length - 1) {
+      this.focusFirstItem();
+    }
+    else {
+      this.focusItem(this.childItems[index + 1]);
+    }
+  }
+  open() {
+    if (!this.disabled) {
+      this.openUp = shouldOpenUp(this.el, this.itemsEl);
+      // action menu usually is on the right side of the screen,
+      // so dropdown opens to the left (is anchored on the right corner)
+      // if there is not enough space on the left and enough on the right though,
+      // it will open on the right side
+      this.isExpanded = true;
+      this.itemsEl.classList.remove("hidden");
+      window.requestAnimationFrame(() => this.focusFirstItem());
+    }
+  }
+  close() {
+    this.isExpanded = false;
+    this.childItems.forEach((i) => (i.focused = false));
+    window.setTimeout(() => {
+      this.itemsEl.classList.add("hidden");
+    }, 150);
+    window.setTimeout(() => {
+      // if dev omits to assign focus after an action is triggered,
+      // the component brings the focus back on the button
+      // Focus will only be lost (and go to the body) once the menuitem
+      // is not visible anymore, so we need to wait for the transition to
+      // finish and the hidden class to be applied.
+      // also checking if focus stayed on the menuitem
+      if (document.activeElement.tagName === "BODY" || document.activeElement.tagName === "WM-MENUITEM") {
+        this.wmButtonEl.focus();
+      }
+    }, 250);
+  }
+  focusItem(item) {
+    this.childItems.map((i) => (i.focused = i === item));
+    item.focus && item.focus();
+  }
+  focusFirstItem() {
+    this.focusItem(this.childItems[0]);
+  }
+  focusLastItem() {
+    this.focusItem(this.childItems[this.childItems.length - 1]);
+  }
+  findAndFocusItem(ev) {
+    const character = ev.detail.toUpperCase();
+    this.focusFirstItem();
+    if (!this.keysSoFar) {
+      for (var i = 0; i < this.childItems.length; i++) {
+        if (this.childItems[i] === document.activeElement) {
+          this.searchIndex = i;
+        }
+      }
+    }
+    this.keysSoFar += character;
+    this.clearKeysSoFarAfterDelay();
+    var nextMatch = this.findMatchInRange(this.childItems, this.searchIndex + 1, this.childItems.length);
+    if (!nextMatch) {
+      nextMatch = this.findMatchInRange(this.childItems, 0, this.searchIndex);
+    }
+    if (nextMatch) {
+      this.focusItem(nextMatch);
+    }
+  }
+  clearKeysSoFarAfterDelay() {
+    if (this.keyClear) {
+      window.clearTimeout(this.keyClear);
+      this.keyClear = null;
+    }
+    this.keyClear = window.setTimeout(function () {
+      this.keysSoFar = "";
+      this.keyClear = null;
+    }.bind(this), 500);
+  }
+  findMatchInRange(list, startIndex, endIndex) {
+    // Find the first item starting with the keysSoFar substring, searching in
+    // the specified range of items
+    for (var n = startIndex; n < endIndex; n++) {
+      var label = list[n].innerText;
+      if (label && label.toUpperCase().indexOf(this.keysSoFar) === 0) {
+        return list[n];
+      }
+    }
+    return null;
+  }
+  render() {
+    return (h(Host, null,
+      h("div", { class: getTextDir() },
+        h("wm-button", { "button-style": `${this.buttonType}only`, tooltip: this.tooltip, "label-for-identical-buttons": this.labelForIdenticalButtons, icon: this.buttonType === "icon" ? "f1d9" : "", id: `menubtn-${this.uid}`, onClick: () => (this.isExpanded ? this.close() : this.open()), disabled: this.disabled, ref: (el) => (this.wmButtonEl = el), "tooltip-position": this.tooltipPosition || this.horizontalPosition, "aria-haspopup": "true", "aria-expanded": this.isExpanded ? "true" : "false", "aria-controls": `menu-${this.uid}` }, this.buttonText),
+        h("div", { class: `dropdown ${this.openUp ? "open-up" : ""} ${this.horizontalPosition} ${this.isExpanded ? "open" : ""} hidden`, id: `menu-${this.uid}`, tabindex: -1, role: "menu", ref: (el) => (this.itemsEl = el) },
+          h("slot", null)))));
+  }
+  static get is() { return "wm-action-menu"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() { return {
+    "$": ["wm-action-menu.scss"]
+  }; }
+  static get styleUrls() { return {
+    "$": ["wm-action-menu.css"]
+  }; }
+  static get properties() { return {
+    "tooltipPosition": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "| \"top\"\n    | \"bottom\"\n    | \"left\"\n    | \"right\"\n    | \"bottom-left\"\n    | \"bottom-right\"\n    | \"top-right\"\n    | \"top-left\"",
+        "resolved": "\"bottom\" | \"bottom-left\" | \"bottom-right\" | \"left\" | \"right\" | \"top\" | \"top-left\" | \"top-right\" | undefined",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "tooltip-position",
+      "reflect": false
+    },
+    "buttonType": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "\"icon\" | \"text\" | \"selector\"",
+        "resolved": "\"icon\" | \"selector\" | \"text\"",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "button-type",
+      "reflect": false,
+      "defaultValue": "\"icon\""
+    },
+    "buttonText": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string | undefined",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "button-text",
+      "reflect": false
+    },
+    "disabled": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "disabled",
+      "reflect": true,
+      "defaultValue": "false"
+    },
+    "tooltip": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string | undefined",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "tooltip",
+      "reflect": false
+    },
+    "labelForIdenticalButtons": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string | undefined",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "label-for-identical-buttons",
+      "reflect": false
+    }
+  }; }
+  static get states() { return {
+    "isExpanded": {}
+  }; }
+  static get events() { return [{
+      "method": "menuLoaded",
+      "name": "menuLoaded",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "complexType": {
+        "original": "any",
+        "resolved": "any",
+        "references": {}
+      }
+    }]; }
+  static get elementRef() { return "el"; }
+  static get listeners() { return [{
+      "name": "wmMenuitemClicked",
+      "method": "handleClickedItem",
+      "target": undefined,
+      "capture": false,
+      "passive": false
+    }, {
+      "name": "wmKeyUpPressed",
+      "method": "handleKeyUp",
+      "target": undefined,
+      "capture": false,
+      "passive": false
+    }, {
+      "name": "wmKeyDownPressed",
+      "method": "handleKeyDown",
+      "target": undefined,
+      "capture": false,
+      "passive": false
+    }, {
+      "name": "wmHomeKeyPressed",
+      "method": "handleHomeKey",
+      "target": undefined,
+      "capture": false,
+      "passive": false
+    }, {
+      "name": "wmEndKeyPressed",
+      "method": "handleEndKey",
+      "target": undefined,
+      "capture": false,
+      "passive": false
+    }, {
+      "name": "wmTabKeyPressed",
+      "method": "handleTabKey",
+      "target": undefined,
+      "capture": false,
+      "passive": false
+    }, {
+      "name": "wmEscKeyPressed",
+      "method": "handleEscKey",
+      "target": undefined,
+      "capture": false,
+      "passive": false
+    }, {
+      "name": "click",
+      "method": "blurHandler",
+      "target": "document",
+      "capture": false,
+      "passive": false
+    }, {
+      "name": "keydown",
+      "method": "handleKey",
+      "target": undefined,
+      "capture": false,
+      "passive": false
+    }, {
+      "name": "wmLetterPressed",
+      "method": "findAndFocusItem",
+      "target": undefined,
+      "capture": false,
+      "passive": false
+    }]; }
+}