@watermarkinsights/ripple 5.6.0 → 5.7.0-0

package/dist/collection/components/selects/wm-nested-select/wm-nested-select.js

@@ -0,0 +1,586 @@
+import { h, Host, forceUpdate } from "@stencil/core";
+import { getTextDir, intl, isElOrChild, shouldOpenUp, toBool } from "../../../global/functions";
+import { globalMessages } from "../../../global/intl";
+export class NestedSelect {
+    constructor() {
+        this.openUp = false;
+        this.overflowCount = 0;
+        this.displayedOptions = [];
+        this.clearSelectionMessage = this.multiple
+            ? intl.formatMessage({
+                id: "select.multiClearSelection",
+                defaultMessage: "Clear all Selections",
+                description: "Button text to clear selection. Use imperative",
+            })
+            : intl.formatMessage({
+                id: "select.singleClearSelection",
+                defaultMessage: "Clear Selection",
+                description: "Button text to clear selection. Use imperative",
+            });
+        this.disabled = false;
+        this.maxHeight = undefined;
+        this.label = undefined;
+        this.labelPosition = "top";
+        this.requiredField = false;
+        this.errorMessage = undefined;
+        this.multiple = false;
+        this.search = false;
+        this.selectAll = false;
+        this.placeholder = this.multiple
+            ? intl.formatMessage({
+                id: "select.multiPlaceholder",
+                defaultMessage: "Make a selection",
+                description: "Placeholder text for multiple select. Use imperative",
+            })
+            : intl.formatMessage({
+                id: "select.singlePlaceholder",
+                defaultMessage: "Select an Option",
+                description: "Placeholder text for single select. Use imperative",
+            });
+        this.searchPlaceholder = intl.formatMessage({
+            id: "select.searchPlaceholder",
+            defaultMessage: "Search",
+            description: "Placeholder text. Use imperative",
+        });
+        this.allSelectedMessage = intl.formatMessage({
+            id: "select.allSelected",
+            defaultMessage: "All selected",
+            description: "Text displayed when all options are selected",
+        });
+        this.isExpanded = false;
+        this.showClearSelectionButton = false;
+    }
+    get isDisabled() {
+        // string "false" needs to be treated as bool False because react wrappers convert bool to string.
+        return toBool(this.disabled);
+    }
+    get childOptions() {
+        return Array.from(this.el.querySelectorAll("wm-option"));
+    }
+    get optgroupEls() {
+        return Array.from(this.el.querySelectorAll("wm-optgroup"));
+    }
+    get menuitemEls() {
+        return Array.from(this.el.shadowRoot.querySelectorAll(".menuitem"));
+    }
+    get allSelected() {
+        return this.childOptions.every((option) => option.selected);
+    }
+    componentWillLoad() {
+        const mutationObserver = new MutationObserver((mutationRecordList) => mutationRecordList.forEach((mutationRecord) => this.handleChildChange(mutationRecord)));
+        mutationObserver.observe(this.el, {
+            childList: true,
+            attributes: true,
+            subtree: true,
+            attributeFilter: ["selected"],
+        });
+    }
+    componentDidLoad() {
+        if (this.maxHeight) {
+            this.dropdownEl.style.maxHeight = this.maxHeight;
+        }
+    }
+    handleChildChange(_) {
+        // on update of children or children selected state, reset button text and rerender
+        this.setButtonText();
+        forceUpdate(this.el);
+        // this.optionListEl.handleChildChange(_);
+    }
+    setButtonText() {
+        this.displayedOptions = this.childOptions.filter((x) => x.selected);
+        // handle overflow + counter for multiselect
+        if (this.multiple) {
+            // this is a fixed measurement accounting for the max width of a 3 character overflow counter
+            const overflowCounterWidth = 38;
+            const computedStyle = window.getComputedStyle(this.buttonEl);
+            // there seems to be no quick way to get an elements width without padding, except for subtracting padding manually
+            const paddingLeft = parseInt(computedStyle.getPropertyValue("padding-left").slice(0, -2));
+            const paddingRight = parseInt(computedStyle.getPropertyValue("padding-right").slice(0, -2));
+            const availableSpace = this.buttonEl.clientWidth - paddingLeft - paddingRight - overflowCounterWidth;
+            this.overflowCount = 0;
+            this.measurementAreaEl.textContent = this.displayedOptions.map((x) => x.textContent).join(", ");
+            let optionsTotalWidth = this.measurementAreaEl.clientWidth;
+            while (optionsTotalWidth > availableSpace && this.displayedOptions.length > 1) {
+                this.overflowCount++;
+                this.displayedOptions.pop();
+                this.measurementAreaEl.textContent = this.displayedOptions.map((x) => x.textContent).join(", ");
+                optionsTotalWidth = this.measurementAreaEl.clientWidth;
+            }
+        }
+    }
+    countOptgroupSelected(optgroupEl) {
+        let selectedOptions = Array.from(optgroupEl.querySelectorAll("wm-option")).filter((option) => option.selected);
+        return selectedOptions.length;
+    }
+    handleOptionSelection() {
+        if (!this.multiple) {
+            this.close();
+        }
+    }
+    handleChildEnter() {
+        // only occurs for multiselects. handle the click, then close
+        this.close();
+    }
+    closePopupOnEscape() {
+        this.close();
+    }
+    close(returnFocus = true) {
+        if (this.isExpanded) {
+            this.isExpanded = false;
+            this.dropdownEl.classList.remove("open");
+            window.setTimeout(() => {
+                this.optgroupEls.forEach((optgroupEl) => (optgroupEl.isExpanded = false));
+                if (returnFocus) {
+                    this.buttonEl.focus();
+                }
+            }, 150);
+        }
+    }
+    open() {
+        if (!this.isDisabled) {
+            this.showClearSelectionButton = this.childOptions.some((o) => o.selected);
+            this.isExpanded = true;
+            this.dropdownEl.classList.add("open");
+            const elHeight = this.el.clientHeight;
+            this.openUp = shouldOpenUp(this.el, this.dropdownEl.clientHeight, elHeight, 0);
+            window.requestAnimationFrame(() => {
+                this.focusFirstMenuitem();
+            });
+        }
+    }
+    focusFirstMenuitem() {
+        if (this.menuitemEls.length > 0) {
+            this.menuitemEls[0].focus();
+        }
+    }
+    moveDown(menuitemEl) {
+        const currentIndex = this.menuitemEls.indexOf(menuitemEl);
+        if (currentIndex == this.menuitemEls.length - 1) {
+            this.menuitemEls[0].focus();
+        }
+        else {
+            this.menuitemEls[currentIndex + 1].focus();
+        }
+    }
+    moveUp(menuitemEl) {
+        const currentIndex = this.menuitemEls.indexOf(menuitemEl);
+        if (currentIndex == 0) {
+            this.menuitemEls[this.menuitemEls.length - 1].focus();
+        }
+        else {
+            this.menuitemEls[currentIndex - 1].focus();
+        }
+    }
+    handleButtonBlur(ev) {
+        if (isElOrChild(this.el, ev.relatedTarget)) {
+            // do not emit a blur event when opening the dropdown and focusing the Options
+            ev.stopPropagation();
+        }
+    }
+    handleClick(ev) {
+        if (!isElOrChild(this.el, ev.target)) {
+            this.close();
+        }
+    }
+    handleMenuitemKeydown(ev) {
+        switch (ev.key) {
+            case "ArrowDown":
+                ev.preventDefault();
+                // focus next
+                this.moveDown(ev.target);
+                break;
+            case "ArrowUp":
+                ev.preventDefault();
+                this.moveUp(ev.target);
+                // focus previous
+                break;
+            case "ArrowRight":
+                if (ev.target.classList.contains("group-btn")) {
+                    ev.preventDefault();
+                    ev.target.click();
+                }
+                break;
+            case "Escape":
+                ev.preventDefault();
+                this.close();
+                break;
+        }
+    }
+    handleComponentBlur(ev) {
+        // Do not close or emit custom blur event when blurring to an element inside (wm-option)
+        if (!this.el.contains(ev.relatedTarget)) {
+            this.close(false);
+            this.wmNestedSelectBlurred.emit();
+        }
+    }
+    handleOptgroupExpanded() {
+        this.menuEl.classList.add("hidden");
+        this.optListWrapperEl.classList.remove("hidden");
+    }
+    handleOptgroupHidden(ev) {
+        this.showClearSelectionButton = this.childOptions.some((o) => o.selected);
+        this.menuEl.classList.remove("hidden");
+        this.optListWrapperEl.classList.add("hidden");
+        // focus back to nested select
+        const elToFocus = this.el.shadowRoot.querySelector(`button[data-label=${ev.detail}]`);
+        elToFocus.focus();
+    }
+    renderButtonText() {
+        if (this.displayedOptions.length < 1) {
+            return h("span", null, this.placeholder);
+        }
+        else if (this.multiple && this.allSelected && this.overflowCount > 0) {
+            return this.allSelectedMessage;
+        }
+        else {
+            return this.displayedOptions.map((x, idx) => (h("span", null, idx > 0 ? ", " : "", x.textContent)));
+        }
+    }
+    renderOverflowCount() {
+        if (this.overflowCount > 0) {
+            return (h("span", null, h("span", { class: "overflow-counter" }, "+", this.overflowCount)));
+        }
+    }
+    handleClearSelection() {
+        this.optgroupEls.forEach((optgroupEl) => optgroupEl.emitDeselection());
+        if (!this.multiple) {
+            this.close();
+        }
+    }
+    renderClearSelectionButton() {
+        if (this.showClearSelectionButton) {
+            return (h("button", { class: "menuitem", onClick: () => this.handleClearSelection(), tabindex: -1, onKeyDown: (ev) => this.handleMenuitemKeydown(ev) }, this.clearSelectionMessage));
+        }
+    }
+    renderSelectionCount(optgroupEl) {
+        const selectionCount = this.countOptgroupSelected(optgroupEl);
+        if (selectionCount) {
+            const singleSelectionCountMessage = intl.formatMessage({
+                id: "select.optgroupSingleSelectionCount",
+                defaultMessage: "Item Selected",
+                description: "Text indicating number of selected in a group, where only a single selection is possible.",
+            }, { numSelected: selectionCount });
+            const multipleSelectionCountMessage = intl.formatMessage({
+                id: "select.optgroupMultipleSelectionCount",
+                defaultMessage: "{numSelected} Selected",
+                description: "Text indicating number of selected in a group, where multiple selections are possible.",
+            }, { numSelected: selectionCount });
+            return (h("div", { class: "selection-count" }, h("span", null, this.multiple ? multipleSelectionCountMessage : singleSelectionCountMessage)));
+        }
+    }
+    render() {
+        const buttonProps = {
+            id: "selectbtn",
+            ["disabled"]: this.isDisabled,
+            ["aria-controls"]: "list",
+            ["aria-labelledby"]: "label selectbtn",
+            ["aria-describedby"]: "error",
+            ["aria-expanded"]: this.isExpanded ? "true" : "false",
+            onClick: () => {
+                this.isExpanded ? this.close() : this.open();
+            },
+        };
+        return (h(Host, { onBlur: (ev) => this.handleComponentBlur(ev) }, h("div", { class: `wrapper ${getTextDir()} label-${this.labelPosition} ${this.errorMessage ? "invalid" : ""}` }, h("div", { class: "label-wrapper" }, h("label", { class: "label", id: "label", htmlFor: "selectbtn" }, this.label, 
+        // we can't use aria-required or required attributes because it's invalid on the elements we're using (button controlling a listbox)
+        this.requiredField ? (h("span", { class: "required" }, h("span", { class: "sr-only" }, globalMessages.requiredField), h("span", { "aria-hidden": "true" }, "*"))) : (""))), h("div", { class: "button-wrapper" }, h("button", Object.assign({}, buttonProps, { class: `displayedoption ${this.isExpanded ? "expanded" : ""}`, ref: (el) => (this.buttonEl = el), onBlur: (ev) => this.handleButtonBlur(ev), onFocus: () => this.close() }), h("span", { class: "overflowcontrol" }, h("span", { class: "button-text" }, this.renderButtonText())), this.renderOverflowCount(), h("div", { ref: (el) => (this.measurementAreaEl = el), class: "measurement-area", "aria-hidden": "true" })), h("div", { class: `dropdown  ${this.openUp ? "upwards" : ""}`, ref: (el) => (this.dropdownEl = el) }, h("div", { ref: (el) => (this.menuEl = el), class: "menu" }, this.renderClearSelectionButton(), this.optgroupEls.map((optgroupEl) => {
+            return (h("button", { class: "menuitem group-btn", role: "menuitem", "data-label": optgroupEl.label, tabindex: -1, onClick: () => {
+                    optgroupEl.isExpanded = !optgroupEl.isExpanded;
+                    forceUpdate(this.el);
+                }, onKeyDown: (ev) => this.handleMenuitemKeydown(ev) }, h("span", null, optgroupEl.label), this.renderSelectionCount(optgroupEl)));
+        })), h("div", { ref: (el) => (this.optListWrapperEl = el), class: "option-list-wrapper hidden" }, h("slot", null))), h("div", { id: "error", class: this.errorMessage ? "error-message" : "" }, this.errorMessage)))));
+    }
+    static get is() { return "wm-nested-select"; }
+    static get encapsulation() { return "shadow"; }
+    static get delegatesFocus() { return true; }
+    static get originalStyleUrls() {
+        return {
+            "$": ["wm-nested-select.scss"]
+        };
+    }
+    static get styleUrls() {
+        return {
+            "$": ["wm-nested-select.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"
+            },
+            "maxHeight": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "max-height",
+                "reflect": false
+            },
+            "label": {
+                "type": "string",
+                "mutable": true,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "label",
+                "reflect": false
+            },
+            "labelPosition": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "\"top\" | \"left\" | \"none\"",
+                    "resolved": "\"left\" | \"none\" | \"top\"",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "label-position",
+                "reflect": false,
+                "defaultValue": "\"top\""
+            },
+            "requiredField": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "required-field",
+                "reflect": false,
+                "defaultValue": "false"
+            },
+            "errorMessage": {
+                "type": "string",
+                "mutable": true,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "error-message",
+                "reflect": false
+            },
+            "multiple": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "multiple",
+                "reflect": false,
+                "defaultValue": "false"
+            },
+            "search": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "search",
+                "reflect": false,
+                "defaultValue": "false"
+            },
+            "selectAll": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "select-all",
+                "reflect": false,
+                "defaultValue": "false"
+            },
+            "placeholder": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "placeholder",
+                "reflect": false,
+                "defaultValue": "this.multiple\n    ? intl.formatMessage({\n        id: \"select.multiPlaceholder\",\n        defaultMessage: \"Make a selection\",\n        description: \"Placeholder text for multiple select. Use imperative\",\n      })\n    : intl.formatMessage({\n        id: \"select.singlePlaceholder\",\n        defaultMessage: \"Select an Option\",\n        description: \"Placeholder text for single select. Use imperative\",\n      })"
+            },
+            "searchPlaceholder": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "search-placeholder",
+                "reflect": false,
+                "defaultValue": "intl.formatMessage({\n    id: \"select.searchPlaceholder\",\n    defaultMessage: \"Search\",\n    description: \"Placeholder text. Use imperative\",\n  })"
+            },
+            "allSelectedMessage": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "all-selected-message",
+                "reflect": false,
+                "defaultValue": "intl.formatMessage({\n    id: \"select.allSelected\",\n    defaultMessage: \"All selected\",\n    description: \"Text displayed when all options are selected\",\n  })"
+            }
+        };
+    }
+    static get states() {
+        return {
+            "isExpanded": {},
+            "showClearSelectionButton": {}
+        };
+    }
+    static get events() {
+        return [{
+                "method": "wmNestedSelectBlurred",
+                "name": "wmNestedSelectBlurred",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "complexType": {
+                    "original": "void",
+                    "resolved": "void",
+                    "references": {}
+                }
+            }];
+    }
+    static get elementRef() { return "el"; }
+    static get listeners() {
+        return [{
+                "name": "wmOptionSelected",
+                "method": "handleOptionSelection",
+                "target": undefined,
+                "capture": false,
+                "passive": false
+            }, {
+                "name": "wmEnterKeyPressed",
+                "method": "handleChildEnter",
+                "target": undefined,
+                "capture": false,
+                "passive": false
+            }, {
+                "name": "wmEscKeyPressed",
+                "method": "closePopupOnEscape",
+                "target": undefined,
+                "capture": false,
+                "passive": false
+            }, {
+                "name": "click",
+                "method": "handleClick",
+                "target": "document",
+                "capture": true,
+                "passive": false
+            }, {
+                "name": "optgroupExpanded",
+                "method": "handleOptgroupExpanded",
+                "target": undefined,
+                "capture": false,
+                "passive": false
+            }, {
+                "name": "optgroupHidden",
+                "method": "handleOptgroupHidden",
+                "target": undefined,
+                "capture": false,
+                "passive": false
+            }];
+    }
+}

package/dist/collection/components/selects/wm-optgroup/wm-optgroup.css

@@ -0,0 +1,51 @@
+/* --------------------------------------
+   1. Box-shadow
+   -------------------------------------- */
+/* --------------------------------------
+   2. Border-radius
+   -------------------------------------- */
+/* --------------------------------------
+   3. Transforms
+   -------------------------------------- */
+/* --------------------------------------
+   4. Button Focus
+   -------------------------------------- */
+/* --------------------------------------
+   5. Flex
+   -------------------------------------- */
+/* --------------------------------------
+   7. Screen Reader Only
+   -------------------------------------- */
+/* --------------------------------------
+   8. Label styles
+   this mixin includes all the styles for the label
+   + flex rules on the parent container to switch between top and left position
+   + srOnly when label is hidden
+   Assumes the following markup:
+   div.wrapper[.label-left.invalid] > div.label-wrapper > label.label > span.required
+   .wrapper is for the flex rules
+   .label-wrapper is to set the height of the label when positioned left so it's the same height as
+   the input. It can't be done directly on .label because of possible line wrapping.
+   When the label is on top there's no line wrapping at all to ensure proper alignment of inlined elements
+   (they can't be aligned on the baseline because of possible description text and error message)
+   -------------------------------------- */
+:host {
+  width: 100%;
+  display: none;
+}
+:host .sr-only {
+  position: absolute !important;
+  width: 1px !important;
+  height: 1px !important;
+  padding: 0 !important;
+  border: 0 !important;
+  overflow: hidden !important;
+  clip: rect(0, 0, 0, 0) !important;
+  clip-path: inset(50%) !important;
+  white-space: nowrap !important;
+  margin: -1px !important;
+}
+
+:host(.visible) {
+  display: unset;
+}