@ukic/web-components 2.1.0-beta.12 → 2.1.0-beta.13

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

@@ -1,9 +1,17 @@
-import { h, Host, } from "@stencil/core";
+import { h, Host, Fragment, } from "@stencil/core";
 import { createPopper } from "@popperjs/core";
 import Check from "../../assets/check-icon.svg";
 import { onComponentRequiredPropUndefined } from "../../utils/helpers";
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 export class Menu {
   constructor() {
+    this.ungroupedOptions = [];
+    this.isSearchBar = false;
+    this.isSearchableSelect = false;
+    // Prevents menu re-opening immediately after it is closed on blur when clicking input.
+    this.preventClickOpen = false;
+    this.hasTimedOut = false;
+    this.isLoading = false;
     this.handleClearListener = () => {
       this.optionHighlighted = "";
     };
@@ -11,10 +19,6 @@ export class Menu {
       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();
@@ -52,18 +56,31 @@ export class Menu {
         });
       }
     };
+    this.getParentEl = (parent) => {
+      if (parent.tagName === "IC-SEARCH-BAR") {
+        this.isSearchBar = true;
+      }
+      else if (parent.tagName === "IC-SELECT" &&
+        parent.getAttribute("searchable") !== null &&
+        parent.getAttribute("searchable") !== undefined) {
+        this.isSearchableSelect = true;
+      }
+    };
     this.arrowBehaviour = (event) => {
       event.preventDefault();
       this.handleMenuChange(true);
     };
+    this.setMenuOptions = () => this.isSearchBar ? this.options : this.ungroupedOptions;
     this.setHighlightedOption = (highlightedIndex) => {
-      this.optionHighlighted = this.options[highlightedIndex].value || undefined;
+      const menuOptions = this.setMenuOptions();
+      menuOptions[highlightedIndex] &&
+        !menuOptions[highlightedIndex].timedOut &&
+        (this.optionHighlighted =
+          menuOptions[highlightedIndex].value || undefined);
     };
     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":
           this.keyboardNav = true;
@@ -81,25 +98,19 @@ export class Menu {
             this.handleMenuChange(true);
           }
           break;
-        case "Backspace":
-          if (isSearchableSelect) {
-            this.inputEl.focus();
-          }
-          break;
-        default:
-          if (isSearchableSelect && event.key !== "Tab") {
-            this.inputEl.focus();
-          }
-          break;
       }
     };
     this.manSetInputValueKeyboardOpen = (event) => {
-      const highlightedOptionIndex = this.options.findIndex((option) => option.value === this.optionHighlighted);
-      const getOptionId = (index) => Array.from(this.host.querySelectorAll("li"))[index].id;
+      var _a;
+      const menuOptions = this.setMenuOptions();
+      this.keyboardNav = false;
+      const highlightedOptionIndex = menuOptions.findIndex((option) => option.value === this.optionHighlighted);
+      const getOptionId = (index) => { var _a; return (_a = Array.from(this.host.querySelectorAll("li"))[index]) === null || _a === void 0 ? void 0 : _a.id; };
       switch (event.key) {
         case "ArrowDown":
+          this.keyboardNav = true;
           this.arrowBehaviour(event);
-          if (highlightedOptionIndex < this.options.length - 1) {
+          if (highlightedOptionIndex < menuOptions.length - 1) {
             this.setHighlightedOption(highlightedOptionIndex + 1);
             this.menuOptionId.emit({
               optionId: getOptionId(highlightedOptionIndex + 1),
@@ -115,12 +126,13 @@ export class Menu {
           this.focusFromSearchKeypress = false;
           break;
         case "ArrowUp":
+          this.keyboardNav = true;
           this.arrowBehaviour(event);
           if (highlightedOptionIndex <= 0 ||
-            highlightedOptionIndex > this.options.length + 1) {
-            this.setHighlightedOption(this.options.length - 1);
+            highlightedOptionIndex > menuOptions.length + 1) {
+            this.setHighlightedOption(menuOptions.length - 1);
             this.menuOptionId.emit({
-              optionId: getOptionId(this.options.length - 1),
+              optionId: getOptionId(menuOptions.length - 1),
             });
           }
           else {
@@ -132,9 +144,28 @@ export class Menu {
           this.preventIncorrectTabOrder = false;
           this.focusFromSearchKeypress = false;
           break;
+        case "Home":
+          this.keyboardNav = true;
+          event.preventDefault();
+          this.arrowBehaviour(event);
+          this.setHighlightedOption(0);
+          this.menuOptionId.emit({
+            optionId: getOptionId(0),
+          });
+          break;
+        case "End":
+          this.keyboardNav = true;
+          event.preventDefault();
+          this.arrowBehaviour(event);
+          this.setHighlightedOption(menuOptions.length - 1);
+          this.menuOptionId.emit({
+            optionId: getOptionId(menuOptions.length - 1),
+          });
+          break;
         case "Enter":
           event.preventDefault();
           this.setInputValue(highlightedOptionIndex);
+          this.value = (_a = menuOptions[highlightedOptionIndex]) === null || _a === void 0 ? void 0 : _a.value;
           break;
         case "Escape":
           this.handleMenuChange(false);
@@ -142,40 +173,66 @@ export class Menu {
           break;
         case "Shift":
         case "Tab":
+          if (this.isSearchBar) {
+            this.keyboardNav = true;
+          }
           this.preventIncorrectTabOrder = true;
           break;
         case "Backspace":
           if (this.isSearchBar) {
             this.parentEl.setFocus();
-            this.focusFromSearchKeypress = true;
             this.setHighlightedOption(0);
           }
+          else if (this.isSearchableSelect) {
+            this.parentEl.setFocus();
+            this.value = null;
+          }
+          this.focusFromSearchKeypress = true;
           break;
         default:
-          if (this.isSearchBar && event.key !== "Tab") {
-            this.parentEl.setFocus();
+          if (event.key !== "Tab") {
+            if (this.isSearchBar) {
+              this.parentEl.setFocus();
+              this.setHighlightedOption(0);
+            }
+            else if (this.isSearchableSelect) {
+              this.parentEl.setFocus();
+              this.value = null;
+            }
             this.focusFromSearchKeypress = true;
-            this.setHighlightedOption(0);
           }
           break;
       }
     };
     this.setInputValue = (highlightedOptionIndex) => {
       var _a;
-      if (this.options[highlightedOptionIndex]) {
+      const menuOptions = this.setMenuOptions();
+      if (menuOptions[highlightedOptionIndex]) {
         this.menuOptionSelect.emit({
-          value: (_a = this.options[highlightedOptionIndex]) === null || _a === void 0 ? void 0 : _a.value,
+          value: (_a = menuOptions[highlightedOptionIndex]) === null || _a === void 0 ? void 0 : _a.value,
         });
         this.optionHighlighted = undefined;
         this.menuOptionId.emit({ optionId: undefined });
       }
-      this.handleMenuChange(false);
+      if (!this.hasTimedOut)
+        this.handleMenuChange(false);
+      else
+        this.parentEl.setFocus();
     };
     this.handleOptionClick = (event) => {
       const { value, label } = event.target.dataset;
       this.menuOptionSelect.emit({ value, label });
       this.handleMenuChange(false);
     };
+    this.handleRetry = () => {
+      this.retryButtonClicked.emit({ value: this.value });
+    };
+    this.handleRetryKeyDown = (ev) => {
+      if (ev.key === "Enter" || ev.key === " ") {
+        ev.preventDefault();
+        this.retryButtonClicked.emit({ value: this.value, keyPressed: ev.key });
+      }
+    };
     this.handleBlur = (event) => {
       if (event.relatedTarget !== this.inputEl) {
         if (!this.menu.contains(event.relatedTarget)) {
@@ -194,6 +251,9 @@ export class Menu {
       if (this.activationType === "automatic") {
         this.autoSetValueOnMenuKeyDown(event);
       }
+      else if (this.activationType === "manual" && this.isSearchableSelect) {
+        this.manSetInputValueKeyboardOpen(event);
+      }
     };
     this.emitMenuKeyPress = (isNavKey, key) => {
       this.menuKeyPress.emit({ isNavKey: isNavKey, key: key });
@@ -204,15 +264,22 @@ export class Menu {
       const isSearchableSelect = this.inputEl.tagName === "INPUT";
       this.keyboardNav = false;
       switch (event.key) {
-        case "ArrowUp":
+        case " ":
           event.preventDefault();
-          this.setPreviousOptionValue(selectedOptionIndex);
-          this.keyboardNav = true;
+          break;
+        case "ArrowUp":
+          if (!this.hasTimedOut) {
+            event.preventDefault();
+            this.setPreviousOptionValue(selectedOptionIndex);
+            this.keyboardNav = true;
+          }
           break;
         case "ArrowDown":
-          event.preventDefault();
-          this.setNextOptionValue(selectedOptionIndex);
-          this.keyboardNav = true;
+          if (!this.hasTimedOut) {
+            event.preventDefault();
+            this.setNextOptionValue(selectedOptionIndex);
+            this.keyboardNav = true;
+          }
           break;
         case "Home":
           this.menuOptionSelect.emit({
@@ -227,6 +294,8 @@ export class Menu {
           this.keyboardNav = true;
           break;
         case "Enter":
+          !this.hasTimedOut && this.handleMenuChange(false);
+          break;
         case "Escape":
           this.handleMenuChange(false);
           break;
@@ -238,7 +307,7 @@ export class Menu {
         case "Shift":
           break;
         default:
-          if (isSearchableSelect && event.key !== "Tab") {
+          if (isSearchableSelect && event.key !== "Tab" && !this.hasTimedOut) {
             this.inputEl.focus();
           }
           if (event.key.length === 1) {
@@ -310,24 +379,35 @@ export class Menu {
         this.menu.classList.add("menu-scroll");
       }
     };
+    this.handleTimeoutBlur = (ev) => {
+      this.timeoutBlur.emit({ ev });
+    };
+    this.optionContent = (option) => {
+      var _a;
+      return (h(Fragment, null, option.loading && h("ic-loading-indicator", { size: "icon" }), 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 === null || option === void 0 ? void 0 : option.value)}-description`, class: "option-description", variant: "caption", "aria-hidden": "true" }, h("p", null, option.description)))), !!option.value &&
+        !!this.value &&
+        (option === null || option === void 0 ? void 0 : option.value.toLowerCase()) === ((_a = this.value) === null || _a === void 0 ? void 0 : _a.toLowerCase()) &&
+        this.parentEl.tagName !== "IC-SEARCH-BAR" && (h("span", { class: "check-icon", innerHTML: Check }))));
+    };
     this.displayOption = (option, index, parentOption) => {
-      const { open, value } = this;
+      const { open, value, keyboardNav, isManualMode, initialOptionsListRender, optionHighlighted, options, } = this;
       return (h("li", { id: this.getOptionId(option.value), class: {
           option: true,
-          "focused-option": this.isManualMode
-            ? (this.keyboardNav || this.initialOptionsListRender) &&
-              option.value === this.optionHighlighted
-            : this.keyboardNav && option.value === value,
+          "focused-option": isManualMode
+            ? (keyboardNav || initialOptionsListRender) &&
+              option.value === optionHighlighted
+            : keyboardNav && option.value === value,
           "last-recommended-option": option.recommended &&
-            this.options[index + 1] &&
-            !this.options[index + 1].recommended,
+            options[index + 1] &&
+            !options[index + 1].recommended,
           "disabled-option": option.disabled,
+          "loading-option": option.loading,
+          timeout: option.timedOut,
         }, role: "option", tabindex: open &&
-          (option.value === value || option.value === this.optionHighlighted) &&
-          this.keyboardNav
+          (option.value === value || option.value === optionHighlighted) &&
+          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: 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 }))));
+          : "-1", "aria-label": this.getOptionAriaLabel(option, parentOption), "aria-selected": option.value === value, "aria-disabled": option.disabled ? "true" : "false", onClick: !option.timedOut && !option.loading && this.handleOptionClick, onBlur: this.handleBlur, onMouseDown: this.handleMouseDown, "data-value": option.value, "data-label": option.label }, option.timedOut ? (h(Fragment, null, h("div", { class: "loading-error-info" }, h("svg", { class: "error-icon-svg", "aria-labelledby": "error-title", xmlns: "http://www.w3.org/2000/svg", viewBox: "0 0 24 24", fill: "#000000" }, h("title", { id: "error-title" }, "Error"), h("path", { d: "M0 0h24v24H0z", fill: "none" }), h("path", { d: "M12 2C6.47 2 2 6.47 2 12s4.47 10 10 10 10-4.47 10-10S17.53 2 12 2zm5 13.59L15.59 17 12 13.41 8.41 17 7 15.59 10.59 12 7 8.41 8.41 7 12 10.59 15.59 7 17 8.41 13.41 12 17 15.59z" })), h("ic-typography", { variant: "label" }, option.label)), h("ic-button", { size: "small", variant: "tertiary", onClick: this.handleRetry, onKeyDown: this.handleRetryKeyDown, onBlur: this.handleTimeoutBlur, id: "retry-button" }, "Retry"))) : (this.optionContent(option))));
     };
     this.open = undefined;
     this.options = undefined;
@@ -347,7 +427,9 @@ export class Menu {
     this.initialOptionsListRender = false;
     this.preventIncorrectTabOrder = false;
   }
-  watchOptionsHandler() {
+  watchOptionsHandler(newOptions) {
+    this.hasTimedOut = newOptions.some((opt) => opt.timedOut);
+    this.isLoading = newOptions.some((opt) => opt.loading);
     this.ungroupedOptions = [];
     this.loadUngroupedOptions();
   }
@@ -372,7 +454,6 @@ export class Menu {
       this.autoSetInputValueKeyboardOpen(event);
     }
     else {
-      this.keyboardNav = true;
       this.manSetInputValueKeyboardOpen(event);
     }
   }
@@ -383,17 +464,18 @@ export class Menu {
     this.setHighlightedOption(0);
   }
   connectedCallback() {
-    var _a;
-    if (((_a = this.parentEl) === null || _a === void 0 ? void 0 : _a.tagName) === "IC-SEARCH-BAR") {
+    this.getParentEl(this.parentEl);
+    if (this.isSearchBar) {
       this.setHighlightedOption(0);
       this.initialOptionsListRender = true;
     }
   }
   componentWillLoad() {
     this.loadUngroupedOptions();
-    this.isSearchBar = this.parentEl.tagName === "IC-SEARCH-BAR";
     this.parentEl.addEventListener("icClear", this.handleClearListener);
     this.parentEl.addEventListener("icSubmitSearch", this.handleSubmitSearch);
+    this.hasTimedOut = this.options.some((opt) => opt.timedOut);
+    this.isLoading = this.options.some((opt) => opt.loading);
   }
   componentDidLoad() {
     if (this.isSearchBar &&
@@ -442,7 +524,8 @@ export class Menu {
       if (this.value &&
         this.keyboardNav &&
         inputValueInOptions &&
-        this.autoFocusOnSelected) {
+        this.autoFocusOnSelected &&
+        !this.isSearchableSelect) {
         this.scrollToSelected(this.menu);
       }
       else if (this.inputEl.tagName !== "IC-TEXT-FIELD" &&
@@ -464,16 +547,13 @@ export class Menu {
     this.parentEl.removeEventListener("icSubmitSearch", this.handleSubmitSearch);
   }
   render() {
-    var _a, _b;
-    const { inputLabel, options, menuId, value, fullWidth } = this;
+    const { inputLabel, options, menuId, value, fullWidth, hasTimedOut, isLoading, small, open, inputEl, keyboardNav, } = this;
     return (h(Host, { class: {
         "full-width": fullWidth,
-        "no-focus": ((_a = this.inputEl) === null || _a === void 0 ? void 0 : _a.tagName) === "INPUT",
-        small: this.small,
-        open: this.open,
-      } }, options.length !== 0 && (h("ul", { id: menuId, class: "menu", role: "listbox", "aria-label": inputLabel, "aria-activedescendant": value != null && value !== "" ? this.getOptionId(value) : "", tabindex: open && !this.keyboardNav && ((_b = this.inputEl) === null || _b === void 0 ? void 0 : _b.tagName) !== "INPUT"
-        ? "0"
-        : "-1", ref: (el) => (this.menu = el), onKeyDown: this.handleMenuKeyDown, onKeyUp: this.handleMenuKeyUp, onBlur: this.handleBlur }, this.getSortedOptions(options).map((option, index) => {
+        "no-focus": (inputEl === null || inputEl === void 0 ? void 0 : inputEl.tagName) === "INPUT" || hasTimedOut || isLoading,
+        small: small,
+        open: open,
+      } }, options.length !== 0 && (h("ul", { id: menuId, class: "menu", role: "listbox", "aria-label": inputLabel, "aria-activedescendant": value != null && value !== "" ? this.getOptionId(value) : "", tabindex: open && !keyboardNav && (inputEl === null || inputEl === void 0 ? void 0 : inputEl.tagName) !== "INPUT" ? "0" : "-1", ref: (el) => (this.menu = el), onKeyDown: this.handleMenuKeyDown, onKeyUp: this.handleMenuKeyUp, onBlur: this.handleBlur }, this.getSortedOptions(options).map((option, index) => {
       if (option.children) {
         if (option.children.length > 0) {
           return (h("div", null, h("ic-typography", { class: "option-group-title", role: "presentation", variant: "subtitle-small" }, h("p", null, option.label)), option.children.map((childOption) => this.displayOption(childOption, index, option))));
@@ -851,6 +931,51 @@ export class Menu {
             }
           }
         }
+      }, {
+        "method": "retryButtonClicked",
+        "name": "retryButtonClicked",
+        "bubbles": true,
+        "cancelable": true,
+        "composed": true,
+        "docs": {
+          "tags": [{
+              "name": "internal",
+              "text": "Emitted when the retry button is clicked"
+            }],
+          "text": ""
+        },
+        "complexType": {
+          "original": "IcValueEventDetail",
+          "resolved": "IcValueEventDetail",
+          "references": {
+            "IcValueEventDetail": {
+              "location": "import",
+              "path": "../../utils/types"
+            }
+          }
+        }
+      }, {
+        "method": "timeoutBlur",
+        "name": "timeoutBlur",
+        "bubbles": true,
+        "cancelable": true,
+        "composed": true,
+        "docs": {
+          "tags": [{
+              "name": "internal",
+              "text": "Emitted when the timeout menu loses focus"
+            }],
+          "text": ""
+        },
+        "complexType": {
+          "original": "{ ev: FocusEvent }",
+          "resolved": "{ ev: FocusEvent; }",
+          "references": {
+            "FocusEvent": {
+              "location": "global"
+            }
+          }
+        }
       }];
   }
   static get methods() {