@ukic/web-components 2.2.0 → 2.4.0

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

@@ -18,7 +18,7 @@ export class Menu {
       this.optionHighlighted = "";
     };
     this.handleSubmitSearch = () => {
-      const highlightedOptionIndex = this.options.findIndex((option) => option.value === this.optionHighlighted);
+      const highlightedOptionIndex = this.options.findIndex((option) => option[this.valueField] === this.optionHighlighted);
       this.setInputValue(highlightedOptionIndex);
     };
     this.handleMenuChange = (open, focusInput) => {
@@ -31,28 +31,28 @@ export class Menu {
     this.setNextOptionValue = (selectedOptionIndex) => {
       if (this.ungroupedOptions[selectedOptionIndex + 1]) {
         this.menuOptionSelect.emit({
-          value: this.ungroupedOptions[selectedOptionIndex + 1].value,
-          optionId: this.getOptionId(this.ungroupedOptions[selectedOptionIndex + 1].value),
+          value: this.ungroupedOptions[selectedOptionIndex + 1][this.valueField],
+          optionId: this.getOptionId(this.ungroupedOptions[selectedOptionIndex + 1][this.valueField]),
         });
       }
       else {
         this.menuOptionSelect.emit({
-          value: this.ungroupedOptions[0].value,
-          optionId: this.getOptionId(this.ungroupedOptions[0].value),
+          value: this.ungroupedOptions[0][this.valueField],
+          optionId: this.getOptionId(this.ungroupedOptions[0][this.valueField]),
         });
       }
     };
     this.setPreviousOptionValue = (selectedOptionIndex) => {
       if (this.ungroupedOptions[selectedOptionIndex - 1]) {
         this.menuOptionSelect.emit({
-          value: this.ungroupedOptions[selectedOptionIndex - 1].value,
-          optionId: this.getOptionId(this.ungroupedOptions[selectedOptionIndex - 1].value),
+          value: this.ungroupedOptions[selectedOptionIndex - 1][this.valueField],
+          optionId: this.getOptionId(this.ungroupedOptions[selectedOptionIndex - 1][this.valueField]),
         });
       }
       else {
         this.menuOptionSelect.emit({
-          value: this.ungroupedOptions[this.ungroupedOptions.length - 1].value,
-          optionId: this.getOptionId(this.ungroupedOptions[this.ungroupedOptions.length - 1].value),
+          value: this.ungroupedOptions[this.ungroupedOptions.length - 1][this.valueField],
+          optionId: this.getOptionId(this.ungroupedOptions[this.ungroupedOptions.length - 1][this.valueField]),
         });
       }
     };
@@ -76,10 +76,10 @@ export class Menu {
       menuOptions[highlightedIndex] &&
         !menuOptions[highlightedIndex].timedOut &&
         (this.optionHighlighted =
-          menuOptions[highlightedIndex].value || undefined);
+          menuOptions[highlightedIndex][this.valueField] || undefined);
     };
     this.autoSetInputValueKeyboardOpen = (event) => {
-      const selectedOptionIndex = this.ungroupedOptions.findIndex((option) => option.value === this.value);
+      const selectedOptionIndex = this.ungroupedOptions.findIndex((option) => option[this.valueField] === this.value);
       this.keyboardNav = false;
       switch (event.key) {
         case "ArrowDown":
@@ -101,10 +101,9 @@ export class Menu {
       }
     };
     this.manSetInputValueKeyboardOpen = (event) => {
-      var _a;
       const menuOptions = this.setMenuOptions();
       this.keyboardNav = false;
-      const highlightedOptionIndex = menuOptions.findIndex((option) => option.value === this.optionHighlighted);
+      const highlightedOptionIndex = menuOptions.findIndex((option) => option[this.valueField] === 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":
@@ -165,7 +164,9 @@ export class Menu {
         case "Enter":
           event.preventDefault();
           this.setInputValue(highlightedOptionIndex);
-          this.value = (_a = menuOptions[highlightedOptionIndex]) === null || _a === void 0 ? void 0 : _a.value;
+          if (menuOptions[highlightedOptionIndex] !== undefined) {
+            this.value = menuOptions[highlightedOptionIndex][this.valueField];
+          }
           break;
         case "Escape":
           if (this.open) {
@@ -208,11 +209,10 @@ export class Menu {
       }
     };
     this.setInputValue = (highlightedOptionIndex) => {
-      var _a;
       const menuOptions = this.setMenuOptions();
-      if (menuOptions[highlightedOptionIndex]) {
+      if (menuOptions[highlightedOptionIndex] !== undefined) {
         this.menuOptionSelect.emit({
-          value: (_a = menuOptions[highlightedOptionIndex]) === null || _a === void 0 ? void 0 : _a.value,
+          value: menuOptions[highlightedOptionIndex][this.valueField],
         });
         this.optionHighlighted = undefined;
         this.menuOptionId.emit({ optionId: undefined });
@@ -265,7 +265,7 @@ export class Menu {
     };
     this.autoSetValueOnMenuKeyDown = (event) => {
       event.cancelBubble = true;
-      const selectedOptionIndex = this.ungroupedOptions.findIndex((option) => option.value === this.value);
+      const selectedOptionIndex = this.ungroupedOptions.findIndex((option) => option[this.valueField] === this.value);
       const isSearchableSelect = this.inputEl.tagName === "INPUT";
       this.keyboardNav = false;
       switch (event.key) {
@@ -288,13 +288,13 @@ export class Menu {
           break;
         case "Home":
           this.menuOptionSelect.emit({
-            value: this.ungroupedOptions[0].value,
+            value: this.ungroupedOptions[0][this.valueField],
           });
           this.keyboardNav = true;
           break;
         case "End":
           this.menuOptionSelect.emit({
-            value: this.ungroupedOptions[this.ungroupedOptions.length - 1].value,
+            value: this.ungroupedOptions[this.ungroupedOptions.length - 1][this.valueField],
           });
           this.keyboardNav = true;
           break;
@@ -331,12 +331,15 @@ export class Menu {
       return `${this.menuId}-${value}`;
     };
     this.getOptionAriaLabel = (option, parentOption) => {
-      let ariaLabel = option.label;
+      let ariaLabel = option[this.labelField];
       if (option.description) {
         ariaLabel = `${ariaLabel}, ${option.description}`;
       }
+      if (option.element) {
+        ariaLabel = `${ariaLabel}, ${option.element.ariaLabel}`;
+      }
       if (parentOption) {
-        return `${ariaLabel}, ${parentOption.label} group`;
+        return `${ariaLabel}, ${parentOption[this.labelField]} group`;
       }
       else {
         return ariaLabel;
@@ -389,19 +392,19 @@ export class Menu {
     };
     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 &&
+      return (h(Fragment, null, option.loading && h("ic-loading-indicator", { size: "icon" }), h("div", { class: "option-text-container" }, h("div", { class: "option-label" }, option.icon && (h("div", { class: "option-icon", innerHTML: option.icon, "aria-hidden": "true" })), h("ic-typography", { variant: "body", "aria-hidden": "true" }, h("p", null, option[this.labelField]))), option.description && (h("ic-typography", { id: `${this.getOptionId(option[this.valueField])}-description`, class: "option-description", variant: "caption", "aria-hidden": "true" }, h("p", null, option.description))), option.element && (h("div", { class: "option-element", innerHTML: option.element.component, "aria-hidden": "true" }))), !!option[this.valueField] &&
         !!this.value &&
-        (option === null || option === void 0 ? void 0 : option.value.toLowerCase()) === ((_a = this.value) === null || _a === void 0 ? void 0 : _a.toLowerCase()) &&
+        option[this.valueField].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, keyboardNav, isManualMode, initialOptionsListRender, optionHighlighted, options, } = this;
-      return (h("li", { id: this.getOptionId(option.value), class: {
+      return (h("li", { id: this.getOptionId(option[this.valueField]), class: {
           option: true,
           "focused-option": isManualMode
             ? (keyboardNav || initialOptionsListRender) &&
-              option.value === optionHighlighted
-            : keyboardNav && option.value === value,
+              option[this.valueField] === optionHighlighted
+            : keyboardNav && option[this.valueField] === value,
           "last-recommended-option": option.recommended &&
             options[index + 1] &&
             !options[index + 1].recommended,
@@ -409,10 +412,11 @@ export class Menu {
           "loading-option": option.loading,
           timeout: option.timedOut,
         }, role: "option", tabindex: open &&
-          (option.value === value || option.value === optionHighlighted) &&
+          (option[this.valueField] === value ||
+            option[this.valueField] === optionHighlighted) &&
           keyboardNav
           ? "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))));
+          : "-1", "aria-label": this.getOptionAriaLabel(option, parentOption), "aria-selected": option[this.valueField] === value, "aria-disabled": option.disabled ? "true" : "false", onClick: !option.timedOut && !option.loading && this.handleOptionClick, onBlur: this.handleBlur, onMouseDown: this.handleMouseDown, "data-value": option[this.valueField], "data-label": option[this.labelField] }, 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[this.labelField])), h("ic-button", { size: "small", variant: "tertiary", onClick: this.handleRetry, onKeyDown: this.handleRetryKeyDown, onBlur: this.handleTimeoutBlur, id: "retry-button" }, "Retry"))) : (this.optionContent(option))));
     };
     this.focusFromSearchKeypress = false;
     this.initialOptionsListRender = false;
@@ -425,6 +429,7 @@ export class Menu {
     this.fullWidth = false;
     this.inputEl = undefined;
     this.inputLabel = undefined;
+    this.labelField = "label";
     this.menuId = undefined;
     this.open = undefined;
     this.parentEl = undefined;
@@ -432,6 +437,7 @@ export class Menu {
     this.small = false;
     this.options = undefined;
     this.value = undefined;
+    this.valueField = "value";
   }
   watchOptionsHandler(newOptions) {
     this.hasTimedOut = newOptions.some((opt) => opt.timedOut);
@@ -479,7 +485,7 @@ export class Menu {
     ], "Menu");
   }
   componentDidUpdate() {
-    const inputValueInOptions = this.options.some((option) => option.value === this.value);
+    const inputValueInOptions = this.options.some((option) => option[this.valueField] === this.value);
     const optionHighlightedIsSet = this.optionHighlighted !== null &&
       this.optionHighlighted !== undefined &&
       this.optionHighlighted !== "";
@@ -598,7 +604,7 @@ export class Menu {
       } }, 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))));
+          return (h("div", null, h("ic-typography", { class: "option-group-title", role: "presentation", variant: "subtitle-small" }, h("p", null, option[this.labelField])), option.children.map((childOption) => this.displayOption(childOption, index, option))));
         }
         else {
           return null;
@@ -632,7 +638,8 @@ export class Menu {
           "references": {
             "IcActivationTypes": {
               "location": "import",
-              "path": "../../utils/types"
+              "path": "../../utils/types",
+              "id": "src/utils/types.ts::IcActivationTypes"
             }
           }
         },
@@ -654,7 +661,8 @@ export class Menu {
           "resolved": "HTMLElement",
           "references": {
             "HTMLElement": {
-              "location": "global"
+              "location": "global",
+              "id": "global::HTMLElement"
             }
           }
         },
@@ -712,7 +720,8 @@ export class Menu {
           "resolved": "HTMLElement",
           "references": {
             "HTMLElement": {
-              "location": "global"
+              "location": "global",
+              "id": "global::HTMLElement"
             }
           }
         },
@@ -740,6 +749,24 @@ export class Menu {
         "attribute": "input-label",
         "reflect": false
       },
+      "labelField": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "The custom name for the label field for IcMenuOption."
+        },
+        "attribute": "label-field",
+        "reflect": false,
+        "defaultValue": "\"label\""
+      },
       "menuId": {
         "type": "string",
         "mutable": false,
@@ -782,7 +809,8 @@ export class Menu {
           "resolved": "HTMLElement",
           "references": {
             "HTMLElement": {
-              "location": "global"
+              "location": "global",
+              "id": "global::HTMLElement"
             }
           }
         },
@@ -805,7 +833,8 @@ export class Menu {
           "references": {
             "IcSearchBarSearchModes": {
               "location": "import",
-              "path": "../ic-search-bar/ic-search-bar.types"
+              "path": "../ic-search-bar/ic-search-bar.types",
+              "id": "src/components/ic-search-bar/ic-search-bar.types.ts::IcSearchBarSearchModes"
             }
           }
         },
@@ -846,7 +875,8 @@ export class Menu {
           "references": {
             "IcMenuOption": {
               "location": "import",
-              "path": "../../utils/types"
+              "path": "../../utils/types",
+              "id": "src/utils/types.ts::IcMenuOption"
             }
           }
         },
@@ -873,6 +903,24 @@ export class Menu {
         },
         "attribute": "value",
         "reflect": false
+      },
+      "valueField": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "The custom name for the value field for IcMenuOption."
+        },
+        "attribute": "value-field",
+        "reflect": false,
+        "defaultValue": "\"value\""
       }
     };
   }
@@ -923,7 +971,8 @@ export class Menu {
           "references": {
             "IcMenuOptionIdEventDetail": {
               "location": "import",
-              "path": "./ic-menu.types"
+              "path": "./ic-menu.types",
+              "id": "src/components/ic-menu/ic-menu.types.ts::IcMenuOptionIdEventDetail"
             }
           }
         }
@@ -946,7 +995,8 @@ export class Menu {
           "references": {
             "IcOptionSelectEventDetail": {
               "location": "import",
-              "path": "./ic-menu.types"
+              "path": "./ic-menu.types",
+              "id": "src/components/ic-menu/ic-menu.types.ts::IcOptionSelectEventDetail"
             }
           }
         }
@@ -969,7 +1019,8 @@ export class Menu {
           "references": {
             "IcMenuChangeEventDetail": {
               "location": "import",
-              "path": "./ic-menu.types"
+              "path": "./ic-menu.types",
+              "id": "src/components/ic-menu/ic-menu.types.ts::IcMenuChangeEventDetail"
             }
           }
         }
@@ -992,7 +1043,8 @@ export class Menu {
           "references": {
             "IcValueEventDetail": {
               "location": "import",
-              "path": "../../utils/types"
+              "path": "../../utils/types",
+              "id": "src/utils/types.ts::IcValueEventDetail"
             }
           }
         }
@@ -1015,7 +1067,8 @@ export class Menu {
           "references": {
             "IcValueEventDetail": {
               "location": "import",
-              "path": "../../utils/types"
+              "path": "../../utils/types",
+              "id": "src/utils/types.ts::IcValueEventDetail"
             }
           }
         }
@@ -1037,7 +1090,8 @@ export class Menu {
           "resolved": "{ ev: FocusEvent; }",
           "references": {
             "FocusEvent": {
-              "location": "global"
+              "location": "global",
+              "id": "global::FocusEvent"
             }
           }
         }
@@ -1060,7 +1114,8 @@ export class Menu {
           "references": {
             "IcMenuOption": {
               "location": "import",
-              "path": "../../utils/types"
+              "path": "../../utils/types",
+              "id": "src/utils/types.ts::IcMenuOption"
             }
           }
         }
@@ -1074,7 +1129,8 @@ export class Menu {
           "parameters": [],
           "references": {
             "Promise": {
-              "location": "global"
+              "location": "global",
+              "id": "global::Promise"
             }
           },
           "return": "Promise<void>"
@@ -1099,10 +1155,12 @@ export class Menu {
             }],
           "references": {
             "Promise": {
-              "location": "global"
+              "location": "global",
+              "id": "global::Promise"
             },
             "KeyboardEvent": {
-              "location": "global"
+              "location": "global",
+              "id": "global::KeyboardEvent"
             }
           },
           "return": "Promise<void>"
@@ -1121,7 +1179,8 @@ export class Menu {
           "parameters": [],
           "references": {
             "Promise": {
-              "location": "global"
+              "location": "global",
+              "id": "global::Promise"
             }
           },
           "return": "Promise<void>"