@watermarkinsights/ripple 5.16.0-alpha.2 → 5.16.0-alpha.5

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

@@ -0,0 +1,435 @@
+import { h, Host } from "@stencil/core";
+import { debounce, getTextDir, shouldOpenUp, shouldShiftRight } from "../../global/functions";
+export class ActionMenu {
+    constructor() {
+        this.openUp = false;
+        this.keysSoFar = "";
+        this.searchIndex = 0;
+        this.debouncedClearKeysSoFar = debounce(() => {
+            this.keysSoFar = "";
+        }, 500);
+        this.isExpanded = false;
+        this.tooltipPosition = undefined;
+        this.actionMenuType = "icon";
+        this.buttonText = undefined;
+        this.disabled = false;
+        this.tooltip = undefined;
+        this.labelForIdenticalButtons = undefined;
+        this.darkMode = undefined;
+    }
+    get horizontalPosition() {
+        return !!this.el && !!this.itemsEl && shouldShiftRight(this.el, this.itemsEl.clientWidth) ? "right" : "left";
+    }
+    get childItems() {
+        return Array.from(this.el.querySelectorAll("wm-menuitem"));
+    }
+    get internalButtonType() {
+        return this.actionMenuType === "icon" || this.actionMenuType === "text"
+            ? this.actionMenuType + "only"
+            : this.actionMenuType;
+    }
+    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();
+    }
+    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;
+        }
+    }
+    handleMenuitemBlur(ev) {
+        const toElOrChild = ev.detail.relatedTarget === this.el || this.el.contains(ev.detail.relatedTarget);
+        // if the Menuitem is blurred to something other than the component, emit a blur event with the appropriate relatedTarget
+        // keeps our component's blur events accurate, and closes when focusing browser address bar
+        if (!toElOrChild) {
+            const event = new CustomEvent("blur");
+            // @ts-ignore
+            event.relatedTarget = ev.detail.relatedTarget;
+            this.el.dispatchEvent(event);
+        }
+    }
+    handleButtonBlur(ev) {
+        const toElOrChild = ev.relatedTarget === this.el || this.el.contains(ev.relatedTarget);
+        if (toElOrChild) {
+            // do not emit a blur event when opening the dropdown and focusing the Menuitems
+            ev.stopPropagation();
+        }
+    }
+    componentDidLoad() {
+        if (this.actionMenuType !== "icon" && !this.buttonText) {
+            console.error("wm-action-menu should have a valid button-text property when action-menu-type is set to 'text' or 'selector'");
+        }
+        if (this.actionMenuType === "icon" && !this.tooltip) {
+            console.error("wm-action-menu should have a valid tooltip when action-menu-type is set to 'icon'");
+        }
+        this.wmActionMenuLoaded.emit();
+        this.menuLoaded.emit(); // deprecated
+    }
+    moveUp(el) {
+        const index = this.childItems.indexOf(el);
+        if (index === 0) {
+            this.focusLastItem();
+        }
+        else {
+            this.childItems[index - 1].focus();
+        }
+    }
+    moveDown(el) {
+        const index = this.childItems.indexOf(el);
+        if (index === this.childItems.length - 1) {
+            this.focusFirstItem();
+        }
+        else {
+            this.childItems[index + 1].focus();
+        }
+    }
+    open() {
+        if (!this.disabled) {
+            this.openUp = shouldOpenUp(this.el, this.itemsEl.clientHeight);
+            // 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(returnFocus = true) {
+        this.isExpanded = 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 (returnFocus &&
+                (document.activeElement.tagName === "BODY" || document.activeElement.tagName === "WM-MENUITEM")) {
+                this.wmButtonEl.focus();
+            }
+        }, 250);
+    }
+    focusFirstItem() {
+        this.childItems[0].focus();
+    }
+    focusLastItem() {
+        this.childItems[this.childItems.length - 1].focus();
+    }
+    findAndFocusItem(ev) {
+        if (!this.keysSoFar && ev.detail == " ") {
+            // if the first key entered is space, treat as a click. Otherwise include in
+            ev.target.click();
+        }
+        else {
+            const character = ev.detail.toLowerCase();
+            this.focusFirstItem();
+            if (!this.keysSoFar) {
+                this.childItems.forEach((item, idx) => {
+                    if (item === document.activeElement) {
+                        this.searchIndex = idx;
+                    }
+                });
+            }
+            this.keysSoFar += character;
+            let nextMatch = this.findMatchInRange(this.childItems, this.searchIndex + 1, this.childItems.length);
+            if (!nextMatch) {
+                nextMatch = this.findMatchInRange(this.childItems, 0, this.searchIndex);
+            }
+            if (nextMatch) {
+                nextMatch.focus();
+            }
+            this.debouncedClearKeysSoFar();
+        }
+    }
+    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].textContent;
+            if (label && label.toLowerCase().indexOf(this.keysSoFar) === 0) {
+                return list[n];
+            }
+        }
+        return null;
+    }
+    render() {
+        return (h(Host, { key: 'c6dfb14c3fe2e1a65238554ca585e94c7a5e8ed8', onBlur: () => this.close(false) }, h("div", { key: 'ae43b9b2e4da167c035ab018620f55f06cfdf17d', class: getTextDir() }, h("wm-button", { key: '22fbc47fb5e2430e2607bce4e820066906959ab7', "button-type": this.internalButtonType, tooltip: this.tooltip, "custom-background": this.darkMode ? "dark" : undefined, "label-for-identical-buttons": this.labelForIdenticalButtons, icon: this.actionMenuType === "icon" ? "#more-options" : "", iconSize: this.actionMenuType === "icon" ? "24px" : undefined, id: "menubtn", onClick: () => (this.isExpanded ? this.close() : this.open()), onBlur: (ev) => this.handleButtonBlur(ev), 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.buttonText), h("div", { key: '90dd3b0691b50a06eb8cc4c27d2f7febdc6a00a4', class: `dropdown ${this.openUp ? "open-up" : ""} ${this.horizontalPosition} ${this.isExpanded ? "open" : ""} hidden`, id: "menu", tabindex: -1, role: "menu", ref: (el) => (this.itemsEl = el) }, h("slot", { key: '5c6eeb1aa8b90c2b679d593d81f90cde7d10ff79' })))));
+    }
+    static get is() { return "wm-action-menu"; }
+    static get encapsulation() { return "shadow"; }
+    static get delegatesFocus() { return true; }
+    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
+            },
+            "actionMenuType": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "\"icon\" | \"text\" | \"selector\" | \"selector-primary\"",
+                    "resolved": "\"icon\" | \"selector\" | \"selector-primary\" | \"text\"",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "action-menu-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
+            },
+            "darkMode": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "dark-mode",
+                "reflect": false
+            }
+        };
+    }
+    static get states() {
+        return {
+            "isExpanded": {}
+        };
+    }
+    static get events() {
+        return [{
+                "method": "wmActionMenuLoaded",
+                "name": "wmActionMenuLoaded",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "complexType": {
+                    "original": "any",
+                    "resolved": "any",
+                    "references": {}
+                }
+            }, {
+                "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": "keydown",
+                "method": "handleKey",
+                "target": undefined,
+                "capture": false,
+                "passive": false
+            }, {
+                "name": "wmMenuitemBlurred",
+                "method": "handleMenuitemBlur",
+                "target": undefined,
+                "capture": false,
+                "passive": false
+            }, {
+                "name": "wmLetterPressed",
+                "method": "findAndFocusItem",
+                "target": undefined,
+                "capture": false,
+                "passive": false
+            }];
+    }
+}