@watermarkinsights/ripple 5.14.0-alpha.0 → 5.14.0-alpha.3

package/dist/collection/components/wm-button/wm-button.js

@@ -0,0 +1,489 @@
+import { h, Host } from "@stencil/core";
+import { getIconCodeFromName } from "../../global/interfaces";
+import { generateId, hideTooltip, handleDisabledAttribute, showTooltip, toBool, triggerFormSubmit, } from "../../global/functions";
+export class Button {
+    constructor() {
+        this.id = generateId();
+        this.ariaPopup = false;
+        this.disabled = false;
+        this.buttonType = "secondary";
+        this.icon = undefined;
+        this.iconSize = undefined;
+        this.iconRotate = undefined;
+        this.iconFlip = undefined;
+        this.tooltip = undefined;
+        this.labelForIdenticalButtons = undefined;
+        this.tooltipPosition = "bottom-right";
+        this.permanentlyDelete = false;
+        this.textWrap = true;
+        this.customBackground = undefined;
+        this.isSubmit = false;
+        this.isTabbing = false;
+    }
+    get isDisabled() {
+        // string "false" needs to be treated as bool False because react wrappers convert bool to string.
+        return toBool(this.disabled);
+    }
+    get isTruncated() {
+        return !!this.buttonEl && this.buttonType === "textonly" && this.buttonEl.offsetWidth < this.buttonEl.scrollWidth;
+    }
+    get hasTooltip() {
+        // tooltip is only rendered for icononly and navigational types, or if the button text is truncated
+        return ["icononly", "navigational"].includes(this.buttonType) || this.isTruncated;
+    }
+    get buttonClasses() {
+        let classes = "wm-button";
+        classes += this.permanentlyDelete ? " -permanentlydelete" : "";
+        classes += this.buttonType ? " -" + this.buttonType : " -secondary";
+        classes += this.textWrap ? "" : " nowrap";
+        classes += this.isTabbing ? " user-is-tabbing" : "";
+        classes += this.isTruncated ? " -truncated" : "";
+        classes += this.customBackground === "dark" ? " dark" : "";
+        return classes;
+    }
+    toggleTabbingOn() {
+        this.isTabbing = true;
+    }
+    toggleTabbingOff() {
+        this.isTabbing = false;
+    }
+    // we need to listen for scroll events during the capture phase because they do not bubble up
+    // there can be layouts where the main content has 100vh and overflows
+    // in these cases window will register no scroll events unless we catch on they way down
+    handleScroll() {
+        hideTooltip();
+    }
+    validateType(newValue) {
+        const valid = [
+            "primary",
+            "secondary",
+            "textonly",
+            "icononly",
+            "navigational",
+            "selector",
+            "selector-primary",
+            "pairpositive",
+            "pairnegative",
+        ].includes(newValue);
+        if (!valid) {
+            this.buttonType = "secondary";
+        }
+        this.validateIcon();
+    }
+    updateIcon() {
+        this.icon = getIconCodeFromName(this.icon);
+    }
+    handleDisabledChange() {
+        handleDisabledAttribute(this.el, this.isDisabled);
+    }
+    validateIcon() {
+        switch (this.buttonType) {
+            case "icononly":
+            case "navigational":
+                // if the style is icononly or navigational...
+                // - an icon must be provided
+                if (!this.icon) {
+                    console.error("wm-button should have a valid 'icon' property when button-type is set to 'icononly' or 'navigational'.");
+                }
+                // - if no tooltip text was passed and we couldn't generate one, throw an error
+                if (!this.tooltip) {
+                    console.error("wm-button should have a valid 'tooltip' property when button-type is set to 'icononly' or 'navigational'.");
+                }
+                break;
+            case "pairpositive":
+                this.icon = "f12c";
+                break;
+            case "pairnegative":
+                this.icon = "f739";
+                break;
+        }
+    }
+    handleKeydown(ev) {
+        switch (ev.key) {
+            case "Enter":
+                ev.preventDefault();
+                if (!this.isDisabled) {
+                    this.el.click();
+                }
+                break;
+        }
+    }
+    handleMouseEnter(ev) {
+        if (this.hasTooltip) {
+            let tooltipText = "";
+            if (this.isTruncated && this.el.textContent) {
+                // when truncated, tooltip text is the button's content
+                tooltipText = this.el.textContent;
+            }
+            else if (this.tooltip) {
+                // otherwise it is the tooltip property if present
+                tooltipText = this.tooltip;
+            }
+            showTooltip(this.tooltipPosition, ev.target, tooltipText);
+        }
+    }
+    handleFocus(ev) {
+        if (this.hasTooltip && this.isTabbing) {
+            let tooltipText = "";
+            if (this.isTruncated && this.el.textContent) {
+                // when truncated, tooltip text is the button's content
+                tooltipText = this.el.textContent;
+            }
+            else if (this.tooltip) {
+                // otherwise it is the tooltip property if present
+                tooltipText = this.tooltip;
+            }
+            showTooltip(this.tooltipPosition, ev.target, tooltipText);
+        }
+    }
+    componentWillLoad() {
+        this.validateType(this.buttonType);
+        if (this.icon) {
+            this.icon = this.icon = getIconCodeFromName(this.icon);
+        }
+        handleDisabledAttribute(this.el, this.isDisabled);
+    }
+    componentDidLoad() {
+        if (document.body.classList.contains("wmcl-user-is-tabbing")) {
+            this.toggleTabbingOn();
+        }
+        this.isSubmit && this.el.addEventListener("click", () => triggerFormSubmit(this.el.closest("form")));
+        this.ariaPopup = !!this.el.getAttribute("aria-haspopup");
+    }
+    getAriaLabel() {
+        if (this.buttonType === "icononly" || this.buttonType === "navigational") {
+            return this.labelForIdenticalButtons || this.tooltip;
+        }
+        if (this.labelForIdenticalButtons) {
+            return this.labelForIdenticalButtons;
+        }
+    }
+    renderIcon() {
+        const defaultIconSize = this.buttonType == "navigational" || this.buttonType == "icononly" ? "1.125rem" : "0.875rem";
+        let transformStyle = "";
+        transformStyle += this.iconRotate ? `rotate(${this.iconRotate}deg)` : "";
+        transformStyle += this.iconFlip === "horizontal" ? `scaleX(-1)` : "";
+        transformStyle += this.iconFlip === "vertical" ? `scaleY(-1)` : "";
+        const iconStyles = Object.assign({
+            fontSize: this.iconSize ? this.iconSize : defaultIconSize,
+            "--icon-size": this.iconSize ? this.iconSize : defaultIconSize,
+        }, ((this.iconRotate || this.iconFlip) && { transform: transformStyle }));
+        if (this.icon.match(/^#/)) {
+            // Icon ID
+            return h("span", { class: `svg-icon svg-${this.icon.slice(1)}`, style: iconStyles });
+        }
+        else if (this.icon.match(/^\/\S*[#]\S*/)) {
+            // starts with /, any number of non-whitespace characters, followed by #, followed by any non-whitespace characters
+            // Relative Path & Symbol
+            return (h("svg", { xmlns: "http://www.w3.org/2000/svg", class: "svg-icon", style: Object.assign(Object.assign({}, iconStyles), { "--icon-fill": "currentColor" }), fill: "currentColor" }, h("use", { href: this.icon })));
+        }
+        else {
+            // MDI
+            return (h("span", { class: "mdi", style: iconStyles, "aria-hidden": "true" }, String.fromCodePoint(parseInt(`0x${this.icon}`))));
+        }
+    }
+    render() {
+        return (h(Host, { key: 'ae038ae6dddcd3220b1c3d027390d743e85ff3bc', class: `${this.isDisabled ? "button-disabled" : ""} -${this.buttonType}` }, h("button", { key: 'e10a7276c46e73fc93b2e26b6f2f81b37625d08e', id: this.id, class: `${this.buttonClasses}`, disabled: this.isDisabled, ref: (el) => (this.buttonEl = el), "aria-label": this.getAriaLabel(), "aria-hasPopup": this.ariaPopup ? "menu" : null, onMouseEnter: (ev) => this.handleMouseEnter(ev), onMouseLeave: () => hideTooltip(), onFocus: (ev) => this.handleFocus(ev), onBlur: () => hideTooltip(), onClick: () => hideTooltip() }, this.icon && this.renderIcon(), h("span", { key: '3dbdd426484b9265107fe994c160af6f2bbd6958', class: "button-text" }, h("slot", { key: 'f5e28ec3acb64b330185f9b65d0f221fd95f1399' })), (this.buttonType == "selector" || this.buttonType == "selector-primary") && (h("div", { key: 'c2b16a69daf975cf6996aa365756574d1f74920f', class: "selector-icon svg-icon svg-expand-more" })))));
+    }
+    static get is() { return "wm-button"; }
+    static get encapsulation() { return "shadow"; }
+    static get delegatesFocus() { return true; }
+    static get originalStyleUrls() {
+        return {
+            "$": ["wm-button.scss"]
+        };
+    }
+    static get styleUrls() {
+        return {
+            "$": ["wm-button.css"]
+        };
+    }
+    static get properties() {
+        return {
+            "disabled": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "disabled",
+                "reflect": true,
+                "defaultValue": "false"
+            },
+            "buttonType": {
+                "type": "string",
+                "mutable": true,
+                "complexType": {
+                    "original": "validButtonTypes",
+                    "resolved": "\"icononly\" | \"navigational\" | \"pairnegative\" | \"pairpositive\" | \"primary\" | \"secondary\" | \"selector\" | \"selector-primary\" | \"textonly\"",
+                    "references": {
+                        "validButtonTypes": {
+                            "location": "import",
+                            "path": "../../global/interfaces",
+                            "id": "src/global/interfaces.ts::validButtonTypes"
+                        }
+                    }
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "button-type",
+                "reflect": false,
+                "defaultValue": "\"secondary\""
+            },
+            "icon": {
+                "type": "string",
+                "mutable": true,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "icon",
+                "reflect": true
+            },
+            "iconSize": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "icon-size",
+                "reflect": false
+            },
+            "iconRotate": {
+                "type": "number",
+                "mutable": false,
+                "complexType": {
+                    "original": "number",
+                    "resolved": "number | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "icon-rotate",
+                "reflect": false
+            },
+            "iconFlip": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "\"horizontal\" | \"vertical\"",
+                    "resolved": "\"horizontal\" | \"vertical\" | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "icon-flip",
+                "reflect": false
+            },
+            "tooltip": {
+                "type": "string",
+                "mutable": true,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "tooltip",
+                "reflect": true
+            },
+            "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
+            },
+            "tooltipPosition": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "TooltipPlacement",
+                    "resolved": "\"bottom\" | \"bottom-left\" | \"bottom-right\" | \"left\" | \"right\" | \"top\" | \"top-left\" | \"top-right\"",
+                    "references": {
+                        "TooltipPlacement": {
+                            "location": "import",
+                            "path": "../../global/interfaces",
+                            "id": "src/global/interfaces.ts::TooltipPlacement"
+                        }
+                    }
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "tooltip-position",
+                "reflect": false,
+                "defaultValue": "\"bottom-right\""
+            },
+            "permanentlyDelete": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "permanently-delete",
+                "reflect": false,
+                "defaultValue": "false"
+            },
+            "textWrap": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "text-wrap",
+                "reflect": false,
+                "defaultValue": "true"
+            },
+            "customBackground": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "custom-background",
+                "reflect": false
+            },
+            "isSubmit": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "is-submit",
+                "reflect": false,
+                "defaultValue": "false"
+            }
+        };
+    }
+    static get states() {
+        return {
+            "isTabbing": {}
+        };
+    }
+    static get elementRef() { return "el"; }
+    static get watchers() {
+        return [{
+                "propName": "buttonType",
+                "methodName": "validateType"
+            }, {
+                "propName": "icon",
+                "methodName": "updateIcon"
+            }, {
+                "propName": "disabled",
+                "methodName": "handleDisabledChange"
+            }];
+    }
+    static get listeners() {
+        return [{
+                "name": "wmUserIsTabbing",
+                "method": "toggleTabbingOn",
+                "target": "window",
+                "capture": false,
+                "passive": false
+            }, {
+                "name": "wmUserIsNotTabbing",
+                "method": "toggleTabbingOff",
+                "target": "window",
+                "capture": false,
+                "passive": false
+            }, {
+                "name": "scroll",
+                "method": "handleScroll",
+                "target": "window",
+                "capture": true,
+                "passive": true
+            }, {
+                "name": "keydown",
+                "method": "handleKeydown",
+                "target": undefined,
+                "capture": false,
+                "passive": false
+            }];
+    }
+}