@ukic/web-components 2.1.0-beta.1 → 2.1.0-beta.10

package/dist/collection/components/ic-menu/ic-menu.js

@@ -4,13 +4,21 @@ import Check from "../../assets/check-icon.svg";
 import { onComponentRequiredPropUndefined } from "../../utils/helpers";
 export class Menu {
   constructor() {
+    this.handleClearListener = () => {
+      this.optionHighlighted = "";
+    };
+    this.handleSubmitSearch = () => {
+      const highlightedOptionIndex = this.options.findIndex((option) => option.value === this.optionHighlighted);
+      this.setInputValue(highlightedOptionIndex);
+    };
     this.ungroupedOptions = [];
     // Prevents menu re-opening immediately after it is closed on blur when clicking input
     this.preventClickOpen = false;
+    this.isSearchBar = false;
     this.handleMenuChange = (open, focusInput) => {
       if (!open)
         this.popperInstance.destroy();
-      this.menuChange.emit({ open, focusInput });
+      this.menuStateChange.emit({ open, focusInput });
       if (!open && focusInput !== false) {
         this.inputEl.focus();
         this.preventClickOpen = false;
@@ -18,13 +26,13 @@ export class Menu {
     };
     this.setNextOptionValue = (selectedOptionIndex) => {
       if (this.ungroupedOptions[selectedOptionIndex + 1]) {
-        this.optionSelect.emit({
+        this.menuOptionSelect.emit({
           value: this.ungroupedOptions[selectedOptionIndex + 1].value,
           optionId: this.getOptionId(this.ungroupedOptions[selectedOptionIndex + 1].value),
         });
       }
       else {
-        this.optionSelect.emit({
+        this.menuOptionSelect.emit({
           value: this.ungroupedOptions[0].value,
           optionId: this.getOptionId(this.ungroupedOptions[0].value),
         });
@@ -32,13 +40,13 @@ export class Menu {
     };
     this.setPreviousOptionValue = (selectedOptionIndex) => {
       if (this.ungroupedOptions[selectedOptionIndex - 1]) {
-        this.optionSelect.emit({
+        this.menuOptionSelect.emit({
           value: this.ungroupedOptions[selectedOptionIndex - 1].value,
           optionId: this.getOptionId(this.ungroupedOptions[selectedOptionIndex - 1].value),
         });
       }
       else {
-        this.optionSelect.emit({
+        this.menuOptionSelect.emit({
           value: this.ungroupedOptions[this.ungroupedOptions.length - 1].value,
           optionId: this.getOptionId(this.ungroupedOptions[this.ungroupedOptions.length - 1].value),
         });
@@ -54,6 +62,7 @@ export class Menu {
     this.autoSetInputValueKeyboardOpen = (event) => {
       var _a;
       const selectedOptionIndex = this.ungroupedOptions.findIndex((option) => option.value === this.value);
+      this.keyboardNav = false;
       const isSearchableSelect = ((_a = this.inputEl) === null || _a === void 0 ? void 0 : _a.tagName) === "INPUT";
       switch (event.key) {
         case "ArrowDown":
@@ -86,9 +95,7 @@ export class Menu {
     };
     this.manSetInputValueKeyboardOpen = (event) => {
       const highlightedOptionIndex = this.options.findIndex((option) => option.value === this.optionHighlighted);
-      this.menuOptionId.emit({ optionId: undefined });
       const getOptionId = (index) => Array.from(this.host.shadowRoot.querySelectorAll("li"))[index].id;
-      const isSearchBar = this.parentEl.tagName === "IC-SEARCH-BAR";
       switch (event.key) {
         case "ArrowDown":
           this.arrowBehaviour(event);
@@ -100,6 +107,9 @@ export class Menu {
           }
           else {
             this.setHighlightedOption(0);
+            this.menuOptionId.emit({
+              optionId: getOptionId(0),
+            });
           }
           this.preventIncorrectTabOrder = false;
           this.focusFromSearchKeypress = false;
@@ -122,7 +132,6 @@ export class Menu {
           this.preventIncorrectTabOrder = false;
           this.focusFromSearchKeypress = false;
           break;
-        case " ":
         case "Enter":
           event.preventDefault();
           this.setInputValue(highlightedOptionIndex);
@@ -136,14 +145,14 @@ export class Menu {
           this.preventIncorrectTabOrder = true;
           break;
         case "Backspace":
-          if (isSearchBar) {
+          if (this.isSearchBar) {
             this.parentEl.setFocus();
             this.focusFromSearchKeypress = true;
             this.setHighlightedOption(0);
           }
           break;
         default:
-          if (isSearchBar && event.key !== "Tab") {
+          if (this.isSearchBar && event.key !== "Tab") {
             this.parentEl.setFocus();
             this.focusFromSearchKeypress = true;
             this.setHighlightedOption(0);
@@ -154,7 +163,7 @@ export class Menu {
     this.setInputValue = (highlightedOptionIndex) => {
       var _a;
       if (this.options[highlightedOptionIndex]) {
-        this.optionSelect.emit({
+        this.menuOptionSelect.emit({
           value: (_a = this.options[highlightedOptionIndex]) === null || _a === void 0 ? void 0 : _a.value,
         });
         this.optionHighlighted = undefined;
@@ -164,7 +173,7 @@ export class Menu {
     };
     this.handleOptionClick = (event) => {
       const { value, label } = event.target.dataset;
-      this.optionSelect.emit({ value, label });
+      this.menuOptionSelect.emit({ value, label });
       this.handleMenuChange(false);
     };
     this.handleBlur = (event) => {
@@ -178,15 +187,22 @@ export class Menu {
         this.preventClickOpen = true;
       }
     };
+    this.handleMouseDown = (event) => {
+      event.preventDefault();
+    };
     this.handleMenuKeyDown = (event) => {
       if (this.activationType === "automatic") {
         this.autoSetValueOnMenuKeyDown(event);
       }
     };
+    this.emitMenuKeyPress = (isNavKey, key) => {
+      this.menuKeyPress.emit({ isNavKey: isNavKey, key: key });
+    };
     this.autoSetValueOnMenuKeyDown = (event) => {
       event.cancelBubble = true;
       const selectedOptionIndex = this.ungroupedOptions.findIndex((option) => option.value === this.value);
       const isSearchableSelect = this.inputEl.tagName === "INPUT";
+      this.keyboardNav = false;
       switch (event.key) {
         case "ArrowUp":
           event.preventDefault();
@@ -199,18 +215,17 @@ export class Menu {
           this.keyboardNav = true;
           break;
         case "Home":
-          this.optionSelect.emit({
+          this.menuOptionSelect.emit({
             value: this.ungroupedOptions[0].value,
           });
           this.keyboardNav = true;
           break;
         case "End":
-          this.optionSelect.emit({
+          this.menuOptionSelect.emit({
             value: this.ungroupedOptions[this.ungroupedOptions.length - 1].value,
           });
           this.keyboardNav = true;
           break;
-        case " ":
         case "Enter":
         case "Escape":
           this.handleMenuChange(false);
@@ -226,8 +241,12 @@ export class Menu {
           if (isSearchableSelect && event.key !== "Tab") {
             this.inputEl.focus();
           }
+          if (event.key.length === 1) {
+            this.keyboardNav = true;
+          }
           break;
       }
+      this.emitMenuKeyPress(this.keyboardNav, event.key);
     };
     this.handleMenuKeyUp = (event) => {
       if (event.key === "Tab" && event.shiftKey) {
@@ -276,6 +295,16 @@ export class Menu {
         });
       }
       this.ungroupedOptions = this.getSortedOptions(this.ungroupedOptions);
+      this.ungroupedOptionsSet.emit({ options: this.ungroupedOptions });
+    };
+    this.setMenuScrollbar = () => {
+      let optionsHeight = 0;
+      this.host.shadowRoot
+        .querySelectorAll(".option")
+        .forEach((option) => (optionsHeight += option.clientHeight));
+      if (optionsHeight >= 320) {
+        this.menu.classList.add("menu-scroll");
+      }
     };
     this.displayOption = (option, index, parentOption) => {
       const { open, value } = this;
@@ -293,7 +322,7 @@ export class Menu {
           (option.value === value || option.value === this.optionHighlighted) &&
           this.keyboardNav
           ? "0"
-          : "-1", "aria-label": this.getOptionAriaLabel(option, parentOption), "aria-selected": option.value === value, "aria-disabled": option.disabled ? "true" : "false", onClick: this.handleOptionClick, onBlur: this.handleBlur, onMouseDown: (event) => event.preventDefault(), "data-value": option.value, "data-label": option.label }, h("div", { class: "option-text-container" }, h("ic-typography", { variant: "body", "aria-hidden": "true" }, h("p", null, option.label)), option.description && (h("ic-typography", { id: `${this.getOptionId(option.value)}-description`, class: "option-description", variant: "caption", "aria-hidden": "true" }, h("p", null, option.description)))), option.value === value &&
+          : "-1", "aria-label": this.getOptionAriaLabel(option, parentOption), "aria-selected": option.value === value, "aria-disabled": option.disabled ? "true" : "false", onClick: this.handleOptionClick, onBlur: this.handleBlur, onMouseDown: this.handleMouseDown, "data-value": option.value, "data-label": option.label }, h("div", { class: "option-text-container" }, h("ic-typography", { variant: "body", "aria-hidden": "true" }, h("p", null, option.label)), option.description && (h("ic-typography", { id: `${this.getOptionId(option.value)}-description`, class: "option-description", variant: "caption", "aria-hidden": "true" }, h("p", null, option.description)))), (option === null || option === void 0 ? void 0 : option.value.toLowerCase()) === (value === null || value === void 0 ? void 0 : value.toLowerCase()) &&
         this.parentEl.tagName !== "IC-SEARCH-BAR" && (h("span", { class: "check-icon", innerHTML: Check }))));
     };
     this.open = undefined;
@@ -318,19 +347,12 @@ export class Menu {
     this.ungroupedOptions = [];
     this.loadUngroupedOptions();
   }
-  handleClearListener() {
-    this.optionHighlighted = "";
-  }
-  handleSubmitSearch() {
-    const highlightedOptionIndex = this.options.findIndex((option) => option.value === this.optionHighlighted);
-    this.setInputValue(highlightedOptionIndex);
-  }
   /**
-   * If menu is opened with the mouse, emit menuChange custom event.
+   * @internal If menu is opened with the mouse, emit menuStateChange custom event.
    */
   async handleClickOpen() {
     if (!this.preventClickOpen) {
-      this.menuChange.emit({ open: !this.open });
+      this.menuStateChange.emit({ open: !this.open });
       this.keyboardNav = false;
     }
     this.preventClickOpen = false;
@@ -365,14 +387,14 @@ export class Menu {
   }
   componentWillLoad() {
     this.loadUngroupedOptions();
+    this.isSearchBar = this.parentEl.tagName === "IC-SEARCH-BAR";
+    this.parentEl.addEventListener("icClear", this.handleClearListener);
+    this.parentEl.addEventListener("icSubmitSearch", this.handleSubmitSearch);
   }
   componentDidLoad() {
-    let optionsHeight = 0;
-    this.host.shadowRoot
-      .querySelectorAll(".option")
-      .forEach((option) => (optionsHeight += option.clientHeight));
-    if (optionsHeight > 320) {
-      this.menu.classList.add("menu-scroll");
+    if (this.isSearchBar &&
+      this.parentEl.disableFilter) {
+      this.focusFromSearchKeypress = true;
     }
     onComponentRequiredPropUndefined([
       { prop: this.open, propName: "open" },
@@ -403,6 +425,9 @@ export class Menu {
         ],
       });
     }
+    if (this.open && !!this.options.length) {
+      this.setMenuScrollbar();
+    }
   }
   componentDidUpdate() {
     const inputValueInOptions = this.options.some((option) => option.value === this.value);
@@ -430,6 +455,10 @@ export class Menu {
       }
     }
   }
+  disconnectedCallback() {
+    this.parentEl.removeEventListener("icClear", this.handleClearListener);
+    this.parentEl.removeEventListener("icSubmitSearch", this.handleSubmitSearch);
+  }
   render() {
     var _a, _b;
     const { inputLabel, options, menuId, value, fullWidth } = this;
@@ -478,7 +507,7 @@ export class Menu {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Specify whether the menu is open."
+          "text": "If `true`, the menu will be displayed open."
         },
         "attribute": "open",
         "reflect": true
@@ -500,7 +529,7 @@ export class Menu {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Provide the possible selection options."
+          "text": "The possible menu selection options."
         }
       },
       "small": {
@@ -515,7 +544,7 @@ export class Menu {
         "optional": true,
         "docs": {
           "tags": [],
-          "text": "Specify whether small styling is to be applied to the element."
+          "text": "If `true`, the small styling will be applied to the menu."
         },
         "attribute": "small",
         "reflect": true,
@@ -533,7 +562,7 @@ export class Menu {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Id of the menu."
+          "text": "The ID of the menu."
         },
         "attribute": "menu-id",
         "reflect": false
@@ -594,7 +623,7 @@ export class Menu {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Reference to the input element."
+          "text": "The reference to the input element."
         }
       },
       "parentEl": {
@@ -614,7 +643,7 @@ export class Menu {
         "docs": {
           "tags": [{
               "name": "internal",
-              "text": "- set if ic-menu is nested inside another component"
+              "text": "- The parent element if ic-menu is nested inside another component."
             }],
           "text": ""
         }
@@ -631,7 +660,7 @@ export class Menu {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Label for the input element."
+          "text": "The label for the input element."
         },
         "attribute": "input-label",
         "reflect": false
@@ -652,7 +681,7 @@ export class Menu {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Reference to an anchor element the menu will position itself from when rendered."
+          "text": "The reference to an anchor element the menu will position itself from when rendered."
         }
       },
       "fullWidth": {
@@ -667,7 +696,7 @@ export class Menu {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "If true then fill width of container"
+          "text": "If `true`, the menu will fill the width of the container."
         },
         "attribute": "full-width",
         "reflect": false,
@@ -686,7 +715,7 @@ export class Menu {
         "docs": {
           "tags": [{
               "name": "internal",
-              "text": "If true, autofocus on selected item when menu is open"
+              "text": "If `true`, autofocus will be applied on selected item when menu is open."
             }],
           "text": ""
         },
@@ -707,14 +736,17 @@ export class Menu {
   }
   static get events() {
     return [{
-        "method": "optionSelect",
-        "name": "optionSelect",
+        "method": "menuOptionSelect",
+        "name": "menuOptionSelect",
         "bubbles": true,
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": "Emitted when an option is selected."
+          "tags": [{
+              "name": "internal",
+              "text": "Emitted when an option is selected."
+            }],
+          "text": ""
         },
         "complexType": {
           "original": "IcOptionSelectEventDetail",
@@ -727,14 +759,17 @@ export class Menu {
           }
         }
       }, {
-        "method": "menuChange",
-        "name": "menuChange",
+        "method": "menuStateChange",
+        "name": "menuStateChange",
         "bubbles": true,
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": "Emitted when state of menu changes (i.e. open or close)."
+          "tags": [{
+              "name": "internal",
+              "text": "Emitted when state of menu changes (i.e. open or close)."
+            }],
+          "text": ""
         },
         "complexType": {
           "original": "IcMenuChangeEventDetail",
@@ -753,8 +788,11 @@ export class Menu {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": "Emitted when an option has been highlighted"
+          "tags": [{
+              "name": "internal",
+              "text": "Emitted when an option has been highlighted"
+            }],
+          "text": ""
         },
         "complexType": {
           "original": "IcMenuOptionIdEventDetail",
@@ -766,6 +804,47 @@ export class Menu {
             }
           }
         }
+      }, {
+        "method": "menuKeyPress",
+        "name": "menuKeyPress",
+        "bubbles": true,
+        "cancelable": true,
+        "composed": true,
+        "docs": {
+          "tags": [{
+              "name": "internal",
+              "text": "Emitted when key is pressed while menu is open"
+            }],
+          "text": ""
+        },
+        "complexType": {
+          "original": "{ isNavKey: boolean; key: string }",
+          "resolved": "{ isNavKey: boolean; key: string; }",
+          "references": {}
+        }
+      }, {
+        "method": "ungroupedOptionsSet",
+        "name": "ungroupedOptionsSet",
+        "bubbles": true,
+        "cancelable": true,
+        "composed": true,
+        "docs": {
+          "tags": [{
+              "name": "internal",
+              "text": "Emitted when the ungrouped options have been set."
+            }],
+          "text": ""
+        },
+        "complexType": {
+          "original": "{ options: IcMenuOption[] }",
+          "resolved": "{ options: IcMenuOption[]; }",
+          "references": {
+            "IcMenuOption": {
+              "location": "import",
+              "path": "../../utils/types"
+            }
+          }
+        }
       }];
   }
   static get methods() {
@@ -782,8 +861,11 @@ export class Menu {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "If menu is opened with the mouse, emit menuChange custom event.",
-          "tags": []
+          "text": "",
+          "tags": [{
+              "name": "internal",
+              "text": "If menu is opened with the mouse, emit menuStateChange custom event."
+            }]
         }
       },
       "handleKeyboardOpen": {
@@ -842,20 +924,5 @@ export class Menu {
         "methodName": "watchOptionsHandler"
       }];
   }
-  static get listeners() {
-    return [{
-        "name": "icClear",
-        "method": "handleClearListener",
-        "target": "document",
-        "capture": false,
-        "passive": false
-      }, {
-        "name": "icSubmitSearch",
-        "method": "handleSubmitSearch",
-        "target": "document",
-        "capture": false,
-        "passive": false
-      }];
-  }
 }
 //# sourceMappingURL=ic-menu.js.map