@watermarkinsights/ripple 5.7.0-8 → 5.7.0

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

@@ -49,6 +49,7 @@ export class NestedSelect {
         });
         this.isExpanded = false;
         this.showClearSelectionButton = false;
+        this.announcement = "";
         this.constrainedMaxHeight = this.maxHeight;
     }
     get isDisabled() {
@@ -160,6 +161,7 @@ export class NestedSelect {
     open(focusLast = false) {
         if (!this.isDisabled) {
             this.showClearSelectionButton = this.childOptions.some((o) => o.selected);
+            this.dropdownEl.scrollTop = 0;
             this.isExpanded = true;
             this.dropdownEl.classList.add("open");
             const elHeight = this.el.clientHeight;
@@ -191,21 +193,15 @@ export class NestedSelect {
     }
     moveDown(menuitemEl) {
         const currentIndex = this.menuitemEls.indexOf(menuitemEl);
-        if (currentIndex == this.menuitemEls.length - 1) {
-            this.menuitemEls[0].focus();
-        }
-        else {
-            this.menuitemEls[currentIndex + 1].focus();
-        }
+        const menuitemToFocus = this.menuitemEls[currentIndex == this.menuitemEls.length - 1 ? 0 : currentIndex + 1];
+        menuitemToFocus.scrollIntoView({ block: "nearest" });
+        menuitemToFocus.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();
-        }
+        const menuitemToFocus = this.menuitemEls[currentIndex == 0 ? this.menuitemEls.length - 1 : currentIndex - 1];
+        menuitemToFocus.scrollIntoView({ block: "nearest" });
+        menuitemToFocus.focus();
     }
     handleButtonBlur(ev) {
         if (isElOrChild(this.el, ev.relatedTarget)) {
@@ -261,6 +257,13 @@ export class NestedSelect {
         const elToFocus = this.el.shadowRoot.querySelector(`button[data-label=${ev.detail}]`);
         elToFocus.focus();
     }
+    announce(message) {
+        // \u00A0 is a non-breaking space character, which causes the message to be read as a new one
+        if (this.liveRegionEl.textContent === message) {
+            message += "\u00A0";
+        }
+        this.announcement = message;
+    }
     renderButtonText() {
         if (this.displayedOptions.length < 1) {
             return h("span", null, this.placeholder);
@@ -279,6 +282,12 @@ export class NestedSelect {
     }
     handleClearSelection() {
         this.optgroupEls.forEach((optgroupEl) => optgroupEl.emitDeselection());
+        const selectionClearedAnnouncement = intl.formatMessage({
+            id: "select.selectionCleared",
+            defaultMessage: "Selection cleared",
+            description: "Screen reader announcement alerting the user they have cleared their selection",
+        });
+        this.announce(selectionClearedAnnouncement);
         if (!this.multiple) {
             this.close();
         }
@@ -316,16 +325,16 @@ export class NestedSelect {
                 this.isExpanded ? this.close() : this.open();
             },
         };
-        return (h(Host, { key: '854bfbccf53069ca95a2c7e3beb60ec7cef4fe52', onBlur: (ev) => this.handleComponentBlur(ev) }, h("div", { key: 'db844c36c341b311a1178899c3dd6f75b3cde901', class: `wrapper ${getTextDir()} label-${this.labelPosition} ${this.errorMessage ? "invalid" : ""}` }, h("div", { key: '57b77d879d3065c2fd6e51c86a4cf9589d2b69dd', class: "label-wrapper" }, h("label", { key: 'd175fa9541a93c22be70143a10b77a087913087e', class: "label", id: "label", htmlFor: "selectbtn" }, this.label, 
+        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", { key: '1e100f81edc7d1dd9c6e1224cd1d5cfeb68e37a7', class: "button-wrapper" }, h("button", Object.assign({ key: 'e8e68bc84666875a5a478aae79d04cc57d231f4b' }, buttonProps, { class: `displayedoption ${this.isExpanded ? "expanded" : ""}`, ref: (el) => (this.buttonEl = el), onBlur: (ev) => this.handleButtonBlur(ev) }), h("span", { key: 'e0dc1adac5cdcb76da590a065b8fc80cead8df69', class: "overflowcontrol" }, h("span", { key: '36427c454c08d30402f50424772c4c3fe6d764e3', class: "button-text" }, this.renderButtonText())), this.renderOverflowCount(), h("div", { key: '2725d1b3b564a3d6a879e598ef5b0bf192dcd1d6', ref: (el) => (this.measurementAreaEl = el), class: "measurement-area", "aria-hidden": "true" })), h("div", { key: '54b75659619de70978e10ab8e3739938686084f8', class: `dropdown  ${this.openUp ? "upwards" : ""}`, ref: (el) => (this.dropdownEl = el) }, h("div", { key: 'a6894d7f78c6eb4a155c2b55f88f43a47377ce7d', ref: (el) => (this.menuEl = el), class: "menu", style: { "--max-height": this.constrainedMaxHeight } }, this.renderClearSelectionButton(), this.optgroupEls.map((optgroupEl) => {
+        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) }), 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", style: { "--max-height": this.constrainedMaxHeight }, tabIndex: -1 }, this.renderClearSelectionButton(), this.optgroupEls.map((optgroupEl) => {
             return (h("button", { class: `menuitem group-btn ${optgroupEl.disabled ? "disabled" : ""}`, role: "menuitem", "data-label": optgroupEl.label, tabindex: -1, "aria-disabled": optgroupEl.disabled, onClick: () => {
                     if (!optgroupEl.disabled) {
                         optgroupEl.isExpanded = !optgroupEl.isExpanded;
                         forceUpdate(this.el);
                     }
                 }, onKeyDown: (ev) => this.handleMenuitemKeydown(ev) }, h("span", null, optgroupEl.label), this.renderSelectionCount(optgroupEl), optgroupEl.disabled && h("div", { class: "disabled-indication" }, "Disabled")));
-        })), h("div", { key: '52fd5904572fe4691cbae1422ccaf285f4a408dd', ref: (el) => (this.optListWrapperEl = el), class: "option-list-wrapper hidden" }, h("slot", { key: '7e3cf958381b7035914cc7f40bd386b923b1ef31' }))), h("div", { key: '0b4dfb9684d0f61cef7781d3b20d87d0ce7771ee', id: "error", class: this.errorMessage ? "error-message" : "" }, this.errorMessage)))));
+        })), 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))), h("div", { id: "nestedselect-announcement", "aria-live": "assertive", "aria-atomic": "true", class: "sr-only", ref: (el) => (this.liveRegionEl = el) }, this.announcement)));
     }
     static get is() { return "wm-nested-select"; }
     static get encapsulation() { return "shadow"; }
@@ -579,7 +588,8 @@ export class NestedSelect {
     static get states() {
         return {
             "isExpanded": {},
-            "showClearSelectionButton": {}
+            "showClearSelectionButton": {},
+            "announcement": {}
         };
     }
     static get events() {

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

@@ -48,7 +48,7 @@ export class Optgroup {
         handleDisabledAttribute(this.el, this.isDisabled);
     }
     render() {
-        return (h(Host, { key: '1db6713870fdb7ed53744c5ea7a04f767e404c34' }, h("div", { key: '504d6788ecbe82ac24ab4b7a0231b10be1435d3c', class: `list-wrapper` }, h("priv-option-list", { key: 'f435b5664196850ba254cab7868c9e55eee7be33', ref: (el) => (this.optionListEl = el), multiple: this.parentNestedSelect.multiple, search: this.parentNestedSelect.search, maxHeight: this.parentNestedSelect.constrainedMaxHeight, searchPlaceholder: this.parentNestedSelect.searchPlaceholder, optgroupLabel: this.label, selectAll: this.parentNestedSelect.selectAll, onOptionListAllSelected: () => this.wmOptgroupAllSelected.emit(), onOptionListAllDeselected: () => this.wmOptgroupAllDeselected.emit() }, h("slot", { key: '583dd769b16ba249c6c68618d5431b7b359f69e8' })))));
+        return (h(Host, null, h("div", { class: `list-wrapper` }, h("priv-option-list", { ref: (el) => (this.optionListEl = el), multiple: this.parentNestedSelect.multiple, search: this.parentNestedSelect.search, maxHeight: this.parentNestedSelect.constrainedMaxHeight, searchPlaceholder: this.parentNestedSelect.searchPlaceholder, optgroupLabel: this.label, selectAll: this.parentNestedSelect.selectAll, onOptionListAllSelected: () => this.wmOptgroupAllSelected.emit(), onOptionListAllDeselected: () => this.wmOptgroupAllDeselected.emit() }, h("slot", null)))));
     }
     static get is() { return "wm-optgroup"; }
     static get encapsulation() { return "shadow"; }

package/dist/collection/components/selects/wm-option/wm-option.e2e.js

@@ -0,0 +1,22 @@
+import { newE2EPage } from "@stencil/core/testing";
+describe("wm-option", () => {
+    let page;
+    beforeEach(async () => {
+        page = await newE2EPage();
+        await page.setContent("<wm-select id='test' label='select something'><wm-option id='first' disabled onClick='action()'>First option</wm-option><wm-option id='second' disabled>Second option</wm-option><wm-option id='third'>Third option</wm-option></wm-select><script>function action() {document.getElementById('second').textContent = 'the function ran!'}</script>");
+    });
+    // RENDER
+    it("renders", async () => {
+        const element = await page.find("wm-option");
+        expect(element).not.toBeNull();
+    });
+    it("prevents action on disabled option", async () => {
+        await page.keyboard.press("Tab");
+        await page.keyboard.press("Enter"); // dropdown opens
+        await page.waitForChanges();
+        await page.keyboard.press("Enter"); // Enter on disabled option
+        await page.waitForChanges();
+        let changedOption = await page.find("wm-option#second");
+        expect(changedOption.textContent).toEqual("Second option"); // the function that shouldn't run replaces this text by: "the function ran!"
+    });
+});

package/dist/collection/components/selects/wm-option/wm-option.js

@@ -143,7 +143,7 @@ export class Option {
         this.parentOptionList.addEventListener("optionListSearchChanged", (ev) => this.handleSearch(ev));
     }
     render() {
-        return (h(Host, { key: '3dced6efa2b70875a3bb7489ee0cfe5961c628b5', role: "option", tabindex: this.focused ? 0 : -1, class: this.hostClasses }, h("div", { key: '65bb987febc952dfb5960abb0f2cd4f767f00ddc', class: `option-wrapper ${this.parentOptionList.multiple ? "checkbox" : ""}` }, h("span", { key: 'ce1d604a7e8c6107aaf6fefeaec2097c8bdcf214', class: "option-text", "aria-hidden": "true", ref: (el) => (this.textEl = el) }, this.el.textContent), h("span", { key: '1b398c044798828a2689478abc62a83c1ed1057c', class: "sr-only" }, this.el.textContent)), h("div", { key: '3d6a694ab8d006fedfeee03d31ca17ef98f92dc2', class: "subinfo" }, this.subinfo)));
+        return (h(Host, { role: "option", tabindex: this.focused ? 0 : -1, class: this.hostClasses }, h("div", { class: `option-wrapper ${this.parentOptionList.multiple ? "checkbox" : ""}` }, h("span", { class: "option-text", "aria-hidden": "true", ref: (el) => (this.textEl = el) }, this.el.textContent), h("span", { class: "sr-only" }, this.el.textContent)), h("div", { class: "subinfo" }, this.subinfo)));
     }
     static get is() { return "wm-option"; }
     static get encapsulation() { return "shadow"; }

package/dist/collection/components/selects/wm-option/wm-option.spec.js

@@ -0,0 +1,63 @@
+import { newSpecPage } from "@stencil/core/testing";
+import { Option } from "./wm-option";
+import { Select } from "../wm-select/wm-select";
+// mock MutationObserver
+global.MutationObserver = jest.fn().mockImplementation(() => ({
+    observe: jest.fn(),
+    unobserve: jest.fn(),
+    disconnect: jest.fn(),
+}));
+describe("wm-option", () => {
+    it("builds", async () => {
+        const page = await newSpecPage({
+            components: [Option],
+            html: `<wm-select label="abel">
+      <wm-option>1</wm-option>
+      <wm-option value="second">2</wm-option>
+      </wm-select>`,
+        });
+        expect(page.root).toMatchSnapshot();
+    });
+    it("has the role of option", async () => {
+        const page = await newSpecPage({
+            components: [Option],
+            html: `<wm-select label="label">
+      <wm-option>1</wm-option>
+      <wm-option value="second">2</wm-option>
+      </wm-select>`,
+        });
+        expect(page.root).toEqualAttribute("role", "option");
+    });
+    it("returns the value", async () => {
+        // if devs set the value attribute or property,
+        // the component should return it on comp.value
+        const page = await newSpecPage({
+            components: [Select, Option],
+            html: `<wm-select label="abel">
+      <wm-option>1</wm-option>
+      <wm-option value="second">2</wm-option>
+      </wm-select>`,
+        });
+        const select = page.root;
+        const options = select.querySelectorAll("wm-option");
+        expect(options[0].value).toBeUndefined();
+        expect(options[1].value).toBe("second");
+    });
+    it("handles disabled onClick function", async () => {
+        const page = await newSpecPage({
+            components: [Option],
+            html: `<wm-select label="label">
+      <wm-option>1</wm-option>
+      <wm-option value="second">2</wm-option>
+      </wm-select>`,
+        });
+        const menuItem = page.root;
+        const onClickFunc = () => console.log("Message");
+        menuItem.onclick = onClickFunc;
+        expect(menuItem.onclick).toEqual(onClickFunc);
+        menuItem.disabled = true;
+        expect(menuItem.onclick).toBe(null);
+        menuItem.disabled = false;
+        expect(menuItem.onclick).toEqual(onClickFunc);
+    });
+});

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

@@ -227,9 +227,9 @@
   margin-left: 0.5rem;
 }
 .wrapper .button-wrapper > .displayedoption[disabled] {
-  color: #6b6b6b;
-  border-color: #8a8a8a;
-  background: #f0f0f0;
+  color: var(--wmcolor-select-option-text-disabled);
+  border-color: var(--wmcolor-border-dark);
+  background: var(--wmcolor-select-option-background-disabled);
   cursor: default;
 }
 .wrapper .button-wrapper > .dropdown {