@ukic/web-components 2.1.0-beta.16 → 2.1.0-beta.18

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

@@ -5,15 +5,15 @@ import { onComponentRequiredPropUndefined } from "../../utils/helpers";
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 export class Menu {
   constructor() {
-    this.ungroupedOptions = [];
+    this.firstRender = true;
+    this.hasPreviouslyBlurred = false;
+    this.hasTimedOut = false;
+    this.isLoading = false;
     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.hasPreviouslyBlurred = false;
-    this.firstRender = true;
+    this.ungroupedOptions = [];
     this.handleClearListener = () => {
       this.optionHighlighted = "";
     };
@@ -188,7 +188,6 @@ export class Menu {
           }
           else if (this.isSearchableSelect) {
             this.parentEl.setFocus();
-            this.value = null;
           }
           this.focusFromSearchKeypress = true;
           break;
@@ -200,7 +199,6 @@ export class Menu {
             }
             else if (this.isSearchableSelect) {
               this.parentEl.setFocus();
-              this.value = null;
             }
             this.focusFromSearchKeypress = true;
           }
@@ -414,23 +412,23 @@ export class Menu {
           ? "0"
           : "-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;
-    this.small = false;
-    this.menuId = undefined;
-    this.value = undefined;
-    this.activationType = "automatic";
-    this.inputEl = undefined;
-    this.parentEl = undefined;
-    this.inputLabel = undefined;
-    this.anchorEl = undefined;
-    this.fullWidth = false;
-    this.autoFocusOnSelected = true;
-    this.keyboardNav = false;
-    this.optionHighlighted = undefined;
     this.focusFromSearchKeypress = false;
     this.initialOptionsListRender = false;
+    this.keyboardNav = false;
+    this.optionHighlighted = undefined;
     this.preventIncorrectTabOrder = false;
+    this.activationType = "automatic";
+    this.anchorEl = undefined;
+    this.autoFocusOnSelected = true;
+    this.fullWidth = false;
+    this.inputEl = undefined;
+    this.inputLabel = undefined;
+    this.menuId = undefined;
+    this.open = undefined;
+    this.parentEl = undefined;
+    this.small = false;
+    this.options = undefined;
+    this.value = undefined;
   }
   watchOptionsHandler(newOptions) {
     this.hasTimedOut = newOptions.some((opt) => opt.timedOut);
@@ -441,36 +439,6 @@ export class Menu {
   watchValueHandler() {
     this.menuValueChange.emit({ value: this.value });
   }
-  /**
-   * @internal If menu is opened with the mouse, emit menuStateChange custom event.
-   */
-  async handleClickOpen() {
-    if (!this.preventClickOpen) {
-      this.menuStateChange.emit({ open: !this.open });
-      this.keyboardNav = false;
-    }
-    this.preventClickOpen = false;
-  }
-  /**
-   * Used alongside activationType
-   * If menu is opened via keyboard navigation (i.e. Enter, ArrowUp or ArrowDown), emit optionSelect custom event.
-   * @param {KeyboardEvent} event - keyboard event
-   */
-  async handleKeyboardOpen(event) {
-    this.keyboardNav = false;
-    if (this.activationType === "automatic") {
-      this.autoSetInputValueKeyboardOpen(event);
-    }
-    else {
-      this.manSetInputValueKeyboardOpen(event);
-    }
-  }
-  /**
-   * @internal Used to highlight the first option in the menu.
-   */
-  async handleSetFirstOption() {
-    this.setHighlightedOption(0);
-  }
   connectedCallback() {
     this.getParentEl(this.parentEl);
     if (this.isSearchBar) {
@@ -478,6 +446,13 @@ export class Menu {
       this.initialOptionsListRender = true;
     }
   }
+  disconnectedCallback() {
+    if (this.popperInstance !== undefined) {
+      this.popperInstance.destroy();
+    }
+    this.parentEl.removeEventListener("icClear", this.handleClearListener);
+    this.parentEl.removeEventListener("icSubmitSearch", this.handleSubmitSearch);
+  }
   componentWillLoad() {
     var _a, _b;
     this.loadUngroupedOptions();
@@ -499,6 +474,33 @@ export class Menu {
       //NOTE: no check for value, input-el or anchor-el as otherwise get console errors on first load of select component
     ], "Menu");
   }
+  componentDidUpdate() {
+    const inputValueInOptions = this.options.some((option) => option.value === this.value);
+    const optionHighlightedIsSet = this.optionHighlighted !== null &&
+      this.optionHighlighted !== undefined &&
+      this.optionHighlighted !== "";
+    if (this.open && this.options.length !== 0) {
+      if (this.value &&
+        this.keyboardNav &&
+        inputValueInOptions &&
+        this.autoFocusOnSelected &&
+        !this.isSearchableSelect) {
+        this.scrollToSelected(this.menu);
+      }
+      else if (this.inputEl.tagName !== "IC-TEXT-FIELD" &&
+        this.inputEl.tagName !== "INPUT") {
+        this.menu.focus();
+      }
+      else if (optionHighlightedIsSet &&
+        !this.focusFromSearchKeypress &&
+        !this.preventIncorrectTabOrder) {
+        const highlightedEl = this.host.querySelector(`li[data-value="${this.optionHighlighted}"]`);
+        if (highlightedEl) {
+          highlightedEl.focus();
+        }
+      }
+    }
+  }
   componentDidRender() {
     if (this.firstRender && this.open) {
       this.firstRender = false;
@@ -552,39 +554,35 @@ export class Menu {
       this.setMenuScrollbar();
     }
   }
-  componentDidUpdate() {
-    const inputValueInOptions = this.options.some((option) => option.value === this.value);
-    const optionHighlightedIsSet = this.optionHighlighted !== null &&
-      this.optionHighlighted !== undefined &&
-      this.optionHighlighted !== "";
-    if (this.open && this.options.length !== 0) {
-      if (this.value &&
-        this.keyboardNav &&
-        inputValueInOptions &&
-        this.autoFocusOnSelected &&
-        !this.isSearchableSelect) {
-        this.scrollToSelected(this.menu);
-      }
-      else if (this.inputEl.tagName !== "IC-TEXT-FIELD" &&
-        this.inputEl.tagName !== "INPUT") {
-        this.menu.focus();
-      }
-      else if (optionHighlightedIsSet &&
-        !this.focusFromSearchKeypress &&
-        !this.preventIncorrectTabOrder) {
-        const highlightedEl = this.host.querySelector(`li[data-value="${this.optionHighlighted}"]`);
-        if (highlightedEl) {
-          highlightedEl.focus();
-        }
-      }
+  /**
+   * @internal If menu is opened with the mouse, emit menuStateChange custom event.
+   */
+  async handleClickOpen() {
+    if (!this.preventClickOpen) {
+      this.menuStateChange.emit({ open: !this.open });
+      this.keyboardNav = false;
     }
+    this.preventClickOpen = false;
   }
-  disconnectedCallback() {
-    if (this.popperInstance !== undefined) {
-      this.popperInstance.destroy();
+  /**
+   * Used alongside activationType
+   * If menu is opened via keyboard navigation (i.e. Enter, ArrowUp or ArrowDown), emit optionSelect custom event.
+   * @param {KeyboardEvent} event - keyboard event
+   */
+  async handleKeyboardOpen(event) {
+    this.keyboardNav = false;
+    if (this.activationType === "automatic") {
+      this.autoSetInputValueKeyboardOpen(event);
+    }
+    else {
+      this.manSetInputValueKeyboardOpen(event);
     }
-    this.parentEl.removeEventListener("icClear", this.handleClearListener);
-    this.parentEl.removeEventListener("icSubmitSearch", this.handleSubmitSearch);
+  }
+  /**
+   * @internal Used to highlight the first option in the menu.
+   */
+  async handleSetFirstOption() {
+    this.setHighlightedOption(0);
   }
   render() {
     const { inputLabel, options, menuId, value, fullWidth, hasTimedOut, isLoading, small, open, inputEl, keyboardNav, } = this;
@@ -621,33 +619,38 @@ export class Menu {
   }
   static get properties() {
     return {
-      "open": {
-        "type": "boolean",
+      "activationType": {
+        "type": "string",
         "mutable": false,
         "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
+          "original": "IcActivationTypes",
+          "resolved": "\"automatic\" | \"manual\"",
+          "references": {
+            "IcActivationTypes": {
+              "location": "import",
+              "path": "../../utils/types"
+            }
+          }
         },
-        "required": true,
-        "optional": false,
+        "required": false,
+        "optional": true,
         "docs": {
           "tags": [],
-          "text": "If `true`, the menu will be displayed open."
+          "text": "Determines whether options manually set as values (by pressing 'Enter') when they receive focus using keyboard navigation."
         },
-        "attribute": "open",
-        "reflect": true
+        "attribute": "activation-type",
+        "reflect": false,
+        "defaultValue": "\"automatic\""
       },
-      "options": {
+      "anchorEl": {
         "type": "unknown",
         "mutable": false,
         "complexType": {
-          "original": "IcMenuOption[]",
-          "resolved": "IcMenuOption[]",
+          "original": "HTMLElement",
+          "resolved": "HTMLElement",
           "references": {
-            "IcMenuOption": {
-              "location": "import",
-              "path": "../../utils/types"
+            "HTMLElement": {
+              "location": "global"
             }
           }
         },
@@ -655,10 +658,10 @@ export class Menu {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The possible menu selection options."
+          "text": "The reference to an anchor element the menu will position itself from when rendered."
         }
       },
-      "small": {
+      "autoFocusOnSelected": {
         "type": "boolean",
         "mutable": false,
         "complexType": {
@@ -667,35 +670,58 @@ export class Menu {
           "references": {}
         },
         "required": false,
-        "optional": true,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "internal",
+              "text": "If `true`, autofocus will be applied on selected item when menu is open."
+            }],
+          "text": ""
+        },
+        "attribute": "auto-focus-on-selected",
+        "reflect": false,
+        "defaultValue": "true"
+      },
+      "fullWidth": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
         "docs": {
           "tags": [],
-          "text": "If `true`, the small styling will be applied to the menu."
+          "text": "If `true`, the menu will fill the width of the container."
         },
-        "attribute": "small",
-        "reflect": true,
+        "attribute": "full-width",
+        "reflect": false,
         "defaultValue": "false"
       },
-      "menuId": {
-        "type": "string",
+      "inputEl": {
+        "type": "unknown",
         "mutable": false,
         "complexType": {
-          "original": "string",
-          "resolved": "string",
-          "references": {}
+          "original": "HTMLElement",
+          "resolved": "HTMLElement",
+          "references": {
+            "HTMLElement": {
+              "location": "global"
+            }
+          }
         },
         "required": true,
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The ID of the menu."
-        },
-        "attribute": "menu-id",
-        "reflect": false
+          "text": "The reference to the input element."
+        }
       },
-      "value": {
+      "inputLabel": {
         "type": "string",
-        "mutable": true,
+        "mutable": false,
         "complexType": {
           "original": "string",
           "resolved": "string",
@@ -705,52 +731,44 @@ export class Menu {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The value of the currently selected option."
+          "text": "The label for the input element."
         },
-        "attribute": "value",
+        "attribute": "input-label",
         "reflect": false
       },
-      "activationType": {
+      "menuId": {
         "type": "string",
         "mutable": false,
         "complexType": {
-          "original": "IcActivationTypes",
-          "resolved": "\"automatic\" | \"manual\"",
-          "references": {
-            "IcActivationTypes": {
-              "location": "import",
-              "path": "../../utils/types"
-            }
-          }
+          "original": "string",
+          "resolved": "string",
+          "references": {}
         },
-        "required": false,
-        "optional": true,
+        "required": true,
+        "optional": false,
         "docs": {
           "tags": [],
-          "text": "Determines whether options manually set as values (by pressing 'Enter') when they receive focus using keyboard navigation."
+          "text": "The ID of the menu."
         },
-        "attribute": "activation-type",
-        "reflect": false,
-        "defaultValue": "\"automatic\""
+        "attribute": "menu-id",
+        "reflect": false
       },
-      "inputEl": {
-        "type": "unknown",
+      "open": {
+        "type": "boolean",
         "mutable": false,
         "complexType": {
-          "original": "HTMLElement",
-          "resolved": "HTMLElement",
-          "references": {
-            "HTMLElement": {
-              "location": "global"
-            }
-          }
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
         },
         "required": true,
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The reference to the input element."
-        }
+          "text": "If `true`, the menu will be displayed open."
+        },
+        "attribute": "open",
+        "reflect": true
       },
       "parentEl": {
         "type": "unknown",
@@ -774,32 +792,34 @@ export class Menu {
           "text": ""
         }
       },
-      "inputLabel": {
-        "type": "string",
+      "small": {
+        "type": "boolean",
         "mutable": false,
         "complexType": {
-          "original": "string",
-          "resolved": "string",
+          "original": "boolean",
+          "resolved": "boolean",
           "references": {}
         },
-        "required": true,
-        "optional": false,
+        "required": false,
+        "optional": true,
         "docs": {
           "tags": [],
-          "text": "The label for the input element."
+          "text": "If `true`, the small styling will be applied to the menu."
         },
-        "attribute": "input-label",
-        "reflect": false
+        "attribute": "small",
+        "reflect": true,
+        "defaultValue": "false"
       },
-      "anchorEl": {
+      "options": {
         "type": "unknown",
         "mutable": false,
         "complexType": {
-          "original": "HTMLElement",
-          "resolved": "HTMLElement",
+          "original": "IcMenuOption[]",
+          "resolved": "IcMenuOption[]",
           "references": {
-            "HTMLElement": {
-              "location": "global"
+            "IcMenuOption": {
+              "location": "import",
+              "path": "../../utils/types"
             }
           }
         },
@@ -807,146 +827,124 @@ export class Menu {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The reference to an anchor element the menu will position itself from when rendered."
+          "text": "The possible menu selection options."
         }
       },
-      "fullWidth": {
-        "type": "boolean",
-        "mutable": false,
+      "value": {
+        "type": "string",
+        "mutable": true,
         "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
+          "original": "string",
+          "resolved": "string",
           "references": {}
         },
-        "required": false,
+        "required": true,
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "If `true`, the menu will fill the width of the container."
-        },
-        "attribute": "full-width",
-        "reflect": false,
-        "defaultValue": "false"
-      },
-      "autoFocusOnSelected": {
-        "type": "boolean",
-        "mutable": false,
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [{
-              "name": "internal",
-              "text": "If `true`, autofocus will be applied on selected item when menu is open."
-            }],
-          "text": ""
+          "text": "The value of the currently selected option."
         },
-        "attribute": "auto-focus-on-selected",
-        "reflect": false,
-        "defaultValue": "true"
+        "attribute": "value",
+        "reflect": false
       }
     };
   }
   static get states() {
     return {
-      "keyboardNav": {},
-      "optionHighlighted": {},
       "focusFromSearchKeypress": {},
       "initialOptionsListRender": {},
+      "keyboardNav": {},
+      "optionHighlighted": {},
       "preventIncorrectTabOrder": {}
     };
   }
   static get events() {
     return [{
-        "method": "menuOptionSelect",
-        "name": "menuOptionSelect",
+        "method": "menuKeyPress",
+        "name": "menuKeyPress",
         "bubbles": true,
         "cancelable": true,
         "composed": true,
         "docs": {
           "tags": [{
               "name": "internal",
-              "text": "Emitted when an option is selected."
+              "text": "Emitted when key is pressed while menu is open"
             }],
           "text": ""
         },
         "complexType": {
-          "original": "IcOptionSelectEventDetail",
-          "resolved": "IcOptionSelectEventDetail",
-          "references": {
-            "IcOptionSelectEventDetail": {
-              "location": "import",
-              "path": "./ic-menu.types"
-            }
-          }
+          "original": "{ isNavKey: boolean; key: string }",
+          "resolved": "{ isNavKey: boolean; key: string; }",
+          "references": {}
         }
       }, {
-        "method": "menuStateChange",
-        "name": "menuStateChange",
+        "method": "menuOptionId",
+        "name": "menuOptionId",
         "bubbles": true,
         "cancelable": true,
         "composed": true,
         "docs": {
           "tags": [{
               "name": "internal",
-              "text": "Emitted when state of menu changes (i.e. open or close)."
+              "text": "Emitted when an option has been highlighted"
             }],
           "text": ""
         },
         "complexType": {
-          "original": "IcMenuChangeEventDetail",
-          "resolved": "IcMenuChangeEventDetail",
+          "original": "IcMenuOptionIdEventDetail",
+          "resolved": "IcMenuOptionIdEventDetail",
           "references": {
-            "IcMenuChangeEventDetail": {
+            "IcMenuOptionIdEventDetail": {
               "location": "import",
               "path": "./ic-menu.types"
             }
           }
         }
       }, {
-        "method": "menuOptionId",
-        "name": "menuOptionId",
+        "method": "menuOptionSelect",
+        "name": "menuOptionSelect",
         "bubbles": true,
         "cancelable": true,
         "composed": true,
         "docs": {
           "tags": [{
               "name": "internal",
-              "text": "Emitted when an option has been highlighted"
+              "text": "Emitted when an option is selected."
             }],
           "text": ""
         },
         "complexType": {
-          "original": "IcMenuOptionIdEventDetail",
-          "resolved": "IcMenuOptionIdEventDetail",
+          "original": "IcOptionSelectEventDetail",
+          "resolved": "IcOptionSelectEventDetail",
           "references": {
-            "IcMenuOptionIdEventDetail": {
+            "IcOptionSelectEventDetail": {
               "location": "import",
               "path": "./ic-menu.types"
             }
           }
         }
       }, {
-        "method": "menuKeyPress",
-        "name": "menuKeyPress",
+        "method": "menuStateChange",
+        "name": "menuStateChange",
         "bubbles": true,
         "cancelable": true,
         "composed": true,
         "docs": {
           "tags": [{
               "name": "internal",
-              "text": "Emitted when key is pressed while menu is open"
+              "text": "Emitted when state of menu changes (i.e. open or close)."
             }],
           "text": ""
         },
         "complexType": {
-          "original": "{ isNavKey: boolean; key: string }",
-          "resolved": "{ isNavKey: boolean; key: string; }",
-          "references": {}
+          "original": "IcMenuChangeEventDetail",
+          "resolved": "IcMenuChangeEventDetail",
+          "references": {
+            "IcMenuChangeEventDetail": {
+              "location": "import",
+              "path": "./ic-menu.types"
+            }
+          }
         }
       }, {
         "method": "menuValueChange",
@@ -972,70 +970,70 @@ export class Menu {
           }
         }
       }, {
-        "method": "ungroupedOptionsSet",
-        "name": "ungroupedOptionsSet",
+        "method": "retryButtonClicked",
+        "name": "retryButtonClicked",
         "bubbles": true,
         "cancelable": true,
         "composed": true,
         "docs": {
           "tags": [{
               "name": "internal",
-              "text": "Emitted when the ungrouped options have been set."
+              "text": "Emitted when the retry button is clicked"
             }],
           "text": ""
         },
         "complexType": {
-          "original": "{ options: IcMenuOption[] }",
-          "resolved": "{ options: IcMenuOption[]; }",
+          "original": "IcValueEventDetail",
+          "resolved": "IcValueEventDetail",
           "references": {
-            "IcMenuOption": {
+            "IcValueEventDetail": {
               "location": "import",
               "path": "../../utils/types"
             }
           }
         }
       }, {
-        "method": "retryButtonClicked",
-        "name": "retryButtonClicked",
+        "method": "timeoutBlur",
+        "name": "timeoutBlur",
         "bubbles": true,
         "cancelable": true,
         "composed": true,
         "docs": {
           "tags": [{
               "name": "internal",
-              "text": "Emitted when the retry button is clicked"
+              "text": "Emitted when the timeout menu loses focus"
             }],
           "text": ""
         },
         "complexType": {
-          "original": "IcValueEventDetail",
-          "resolved": "IcValueEventDetail",
+          "original": "{ ev: FocusEvent }",
+          "resolved": "{ ev: FocusEvent; }",
           "references": {
-            "IcValueEventDetail": {
-              "location": "import",
-              "path": "../../utils/types"
+            "FocusEvent": {
+              "location": "global"
             }
           }
         }
       }, {
-        "method": "timeoutBlur",
-        "name": "timeoutBlur",
+        "method": "ungroupedOptionsSet",
+        "name": "ungroupedOptionsSet",
         "bubbles": true,
         "cancelable": true,
         "composed": true,
         "docs": {
           "tags": [{
               "name": "internal",
-              "text": "Emitted when the timeout menu loses focus"
+              "text": "Emitted when the ungrouped options have been set."
             }],
           "text": ""
         },
         "complexType": {
-          "original": "{ ev: FocusEvent }",
-          "resolved": "{ ev: FocusEvent; }",
+          "original": "{ options: IcMenuOption[] }",
+          "resolved": "{ options: IcMenuOption[]; }",
           "references": {
-            "FocusEvent": {
-              "location": "global"
+            "IcMenuOption": {
+              "location": "import",
+              "path": "../../utils/types"
             }
           }
         }