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

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

@@ -5,6 +5,7 @@ import { IcInformationStatus, IcThemeForegroundEnum, } from "../../utils/types";
 import Expand from "./assets/Expand.svg";
 import Clear from "./assets/Clear.svg";
 let inputIds = 0;
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 export class Select {
   constructor() {
     this.inputId = `ic-select-input-${inputIds++}`;
@@ -12,10 +13,20 @@ export class Select {
     this.ungroupedOptions = [];
     this.inheritedAttributes = {};
     this.hasSetDefaultValue = false;
-    this.initialRender = false;
     this.initialOptionsEmpty = false;
+    this.handleRetry = (ev) => {
+      var _a;
+      if (ev.detail.keyPressed)
+        (_a = this.searchableSelectElement) === null || _a === void 0 ? void 0 : _a.focus();
+      this.blurredBecauseButtonPressed = true;
+      this.retryButtonClick = true;
+      this.hasSetDefaultValue = true;
+      this.icRetryLoad.emit({ value: this.hiddenInputValue });
+    };
     this.emitIcChange = (value) => {
-      this.value = value;
+      if (!this.searchable) {
+        this.value = value;
+      }
       clearTimeout(this.debounceIcChange);
       this.debounceIcChange = window.setTimeout(() => {
         this.icChange.emit({ value: value });
@@ -58,11 +69,6 @@ export class Select {
     this.getLabelFromValue = (value) => {
       return getLabelFromValue(value, this.options);
     };
-    this.getValueFromLabel = (label) => {
-      var _a;
-      const value = (_a = this.options.find((option) => option.label === label)) === null || _a === void 0 ? void 0 : _a.value;
-      return value;
-    };
     this.getFilteredChildMenuOptions = (option) => {
       let children = option.children;
       if (this.searchable) {
@@ -86,7 +92,13 @@ export class Select {
         return;
       }
       if (this.searchable) {
-        this.searchableSelectInputValue = this.getLabelFromValue(event.detail.value);
+        this.value = event.detail.value;
+        // After editing the input, if selecting the same option as before, set the input value to label again
+        if (this.value === this.currValue) {
+          this.searchableSelectInputValue = this.getLabelFromValue(this.value);
+        }
+        this.inputValueToFilter = null;
+        this.hiddenInputValue = this.getValueFromLabel(this.searchableSelectInputValue);
       }
       this.ariaActiveDescendant = event.detail.optionId;
       this.icOptionSelect.emit({ value: event.detail.value });
@@ -123,8 +135,10 @@ export class Select {
         this.menu.options = this.filteredOptions;
       }
       else {
-        this.noOptions = null;
-        this.menu.options = this.options;
+        if (!this.hasTimedOut && !this.loading) {
+          this.noOptions = null;
+          this.menu.options = this.options;
+        }
       }
       if (event.detail !== 0 && this.isMenuEnabled()) {
         this.menu.handleClickOpen();
@@ -139,13 +153,15 @@ export class Select {
     };
     this.handleClear = (event) => {
       event.stopPropagation();
+      this.hasTimedOut = false;
       this.noOptions = null;
       this.emitImmediateIcChange(null);
       this.icClear.emit();
       if (this.searchable) {
         this.searchableSelectElement.value = null;
         this.searchableSelectInputValue = null;
-        this.menu.options = this.options;
+        this.filteredOptions = this.options;
+        this.hiddenInputValue = null;
         this.searchableSelectElement.focus();
         if (!this.isMenuEnabled()) {
           this.setMenuChange(false);
@@ -157,7 +173,11 @@ export class Select {
     };
     this.handleCharacterKeyDown = (key) => {
       // Only close menu when space is pressed if not being used alongside character keys to quickly select options
-      if (this.open && key === " " && this.pressedCharacters.length === 0) {
+      if (this.open &&
+        key === " " &&
+        this.pressedCharacters.length === 0 &&
+        !this.hasTimedOut &&
+        !this.loading) {
         this.setMenuChange(false);
       }
       if (key.length === 1 && !this.searchable) {
@@ -185,8 +205,10 @@ export class Select {
           this.menu.options = this.filteredOptions;
         }
         else {
-          this.noOptions = null;
-          this.menu.options = this.options;
+          if (!this.hasTimedOut) {
+            this.noOptions = null;
+            this.menu.options = this.options;
+          }
         }
       }
       if (this.open && event.key === "Enter") {
@@ -195,6 +217,7 @@ export class Select {
       else {
         if (!(isArrowKey && this.noOptions !== null) && this.isMenuEnabled()) {
           if (!(event.key === " " && this.pressedCharacters.length > 0)) {
+            // Keyboard events get passed onto ic-menu
             this.menu.handleKeyboardOpen(event);
           }
           this.handleCharacterKeyDown(event.key);
@@ -204,7 +227,15 @@ export class Select {
     this.handleClearButtonFocus = () => {
       this.clearButtonFocused = true;
     };
-    this.handleClearButtonBlur = () => {
+    this.handleClearButtonBlur = (ev) => {
+      var _a;
+      const retryButton = (_a = this.menu) === null || _a === void 0 ? void 0 : _a.querySelector("#retry-button");
+      if (!(this.searchableSelectElement &&
+        ev.relatedTarget === this.searchableSelectElement) &&
+        !(retryButton && ev.relatedTarget === retryButton)) {
+        this.setMenuChange(false);
+        this.handleFocusIndicatorDisplay();
+      }
       this.clearButtonFocused = false;
     };
     this.handleFilter = () => {
@@ -217,7 +248,7 @@ export class Select {
       });
       let menuOptionsFiltered;
       if (this.searchable) {
-        menuOptionsFiltered = getFilteredMenuOptions(options, this.includeDescriptionsInSearch, this.searchableSelectInputValue, this.searchMatchPosition);
+        menuOptionsFiltered = getFilteredMenuOptions(options, this.includeDescriptionsInSearch, this.inputValueToFilter, this.searchMatchPosition);
       }
       else {
         menuOptionsFiltered = getFilteredMenuOptions(options, false, this.pressedCharacters, "start");
@@ -259,15 +290,37 @@ export class Select {
         this.filteredOptions = this.noOptions;
       }
     };
+    this.triggerLoading = () => {
+      this.hasTimedOut = false;
+      this.noOptions = [{ label: this.loadingLabel, value: "", loading: true }];
+      if (this.filteredOptions !== this.noOptions && this.searchable)
+        this.filteredOptions = this.noOptions;
+      else if (!this.searchable && this.options !== this.noOptions)
+        this.options = this.noOptions;
+      if (this.timeout) {
+        this.timeoutTimer = window.setTimeout(() => {
+          this.loading = false;
+          this.hasTimedOut = true;
+          this.noOptions = [
+            { label: this.loadingErrorLabel, value: "", timedOut: true },
+          ];
+          this.filteredOptions = this.noOptions;
+          if (!this.searchable)
+            this.options = this.noOptions;
+        }, this.timeout);
+      }
+    };
+    this.getValueFromLabel = (label) => {
+      var _a;
+      const value = (_a = this.options.find((option) => option.label === label)) === null || _a === void 0 ? void 0 : _a.value;
+      return value;
+    };
     this.handleSearchableSelectInput = (event) => {
       this.searchableSelectInputValue = event.target.value;
       this.icInput.emit({ value: this.searchableSelectInputValue });
-      if (this.disableFilter) {
-        this.emitIcChange(this.searchableSelectInputValue);
-      }
-      else if (this.getValueFromLabel(this.searchableSelectInputValue) === undefined) {
-        this.emitIcChange(null);
-      }
+      this.emitIcChange(this.searchableSelectInputValue);
+      this.hiddenInputValue = this.searchableSelectInputValue;
+      this.inputValueToFilter = this.searchableSelectInputValue;
       if (this.isMenuEnabled()) {
         this.setMenuChange(true);
       }
@@ -295,20 +348,43 @@ export class Select {
       this.icFocus.emit();
     };
     this.onBlur = (event) => {
+      var _a;
+      const target = event.relatedTarget;
+      if (target !== null &&
+        target.tagName === "UL" &&
+        target.className.includes("menu")) {
+        return;
+      }
+      const retryButton = (_a = this.menu) === null || _a === void 0 ? void 0 : _a.querySelector("#retry-button");
       const isSearchableAndNoFocusedInternalElements = this.searchable &&
         event.relatedTarget !== this.menu &&
         !Array.from(this.menu.querySelectorAll("[role='option']")).includes(event.relatedTarget) &&
-        !(this.clearButton && event.relatedTarget === this.clearButton);
+        !(this.clearButton && event.relatedTarget === this.clearButton) &&
+        !(retryButton && event.relatedTarget === retryButton);
       if (isSearchableAndNoFocusedInternalElements) {
-        this.setMenuChange(false);
+        if (!this.retryButtonClick) {
+          this.setMenuChange(false);
+        }
         this.handleFocusIndicatorDisplay();
       }
+      this.retryButtonClick = false;
       this.icBlur.emit();
     };
+    this.onTimeoutBlur = (ev) => {
+      if (ev.detail.ev.relatedTarget !==
+        this.searchableSelectElement &&
+        !this.blurredBecauseButtonPressed) {
+        this.setMenuChange(false);
+        this.handleFocusIndicatorDisplay();
+        this.icBlur.emit();
+      }
+      this.blurredBecauseButtonPressed = false;
+    };
     this.handleFormReset = () => {
       this.value = this.initialValue;
       if (this.searchable) {
         this.searchableSelectInputValue = this.getDefaultValue(this.value);
+        this.hiddenInputValue = this.value;
       }
     };
     this.label = undefined;
@@ -334,6 +410,10 @@ export class Select {
     this.charactersUntilSuggestions = 0;
     this.emptyOptionListText = "No results found";
     this.disableFilter = false;
+    this.timeout = undefined;
+    this.loadingLabel = "Loading...";
+    this.loadingErrorLabel = "Loading Error";
+    this.loading = false;
     this.open = false;
     this.clearButtonFocused = false;
     this.searchableSelectInputValue = null;
@@ -345,32 +425,41 @@ export class Select {
     this.currValue = this.value;
     this.debounceIcChange = undefined;
     this.pressedCharacters = "";
+    this.hiddenInputValue = undefined;
+    this.inputValueToFilter = this.value;
+  }
+  loadingHandler(newValue) {
+    newValue && this.triggerLoading();
   }
   watchOptionsHandler() {
-    if (this.isExternalFiltering()) {
-      if (this.options.length > 0) {
+    if (!this.hasTimedOut) {
+      this.loading = false;
+      clearTimeout(this.timeoutTimer);
+      if (this.isExternalFiltering()) {
+        if (this.options.length > 0) {
+          this.setOptionsValuesFromLabels();
+          this.noOptions = null;
+          this.filteredOptions = this.options;
+        }
+        else if (this.isMenuEnabled()) {
+          this.noOptions = [{ label: this.emptyOptionListText, value: "" }];
+          this.filteredOptions = this.noOptions;
+        }
+        this.updateSearchableSelectResultAriaLive();
+        this.setDefaultValue();
+      }
+      else {
         this.setOptionsValuesFromLabels();
-        this.noOptions = null;
         this.filteredOptions = this.options;
-      }
-      else if (this.isMenuEnabled()) {
-        this.noOptions = [{ label: this.emptyOptionListText, value: "" }];
-        this.filteredOptions = this.noOptions;
-        // Will prevent 'No results found' displaying on initial load and setting default value
-        if (!this.initialRender) {
-          this.setMenuChange(true);
+        if (this.initialOptionsEmpty) {
+          this.setDefaultValue();
+          this.initialOptionsEmpty = false;
         }
       }
-      this.updateSearchableSelectResultAriaLive();
-      this.setDefaultValue();
     }
     else {
-      this.setOptionsValuesFromLabels();
-      this.filteredOptions = this.options;
-      if (this.initialOptionsEmpty) {
-        this.setDefaultValue();
-        this.initialOptionsEmpty = false;
-      }
+      if (!this.searchable)
+        this.options = this.noOptions;
     }
   }
   debounceChangedHandler(newValue) {
@@ -380,6 +469,10 @@ export class Select {
     if (this.value !== this.currValue) {
       this.currValue = this.value;
     }
+    if (this.searchable && !!this.currValue) {
+      this.searchableSelectInputValue =
+        this.getLabelFromValue(this.currValue) || this.currValue;
+    }
   }
   /**
    * Sets focus on the input box.
@@ -421,11 +514,10 @@ export class Select {
     ]);
     this.setOptionsValuesFromLabels();
     addFormResetListener(this.host, this.handleFormReset);
-    this.initialRender = true;
     if (!this.options.length) {
       this.initialOptionsEmpty = true;
     }
-    else if (!this.disableFilter) {
+    else {
       this.setDefaultValue();
     }
   }
@@ -434,18 +526,24 @@ export class Select {
       this.setTextColor();
     }
   }
-  componentWillUpdate() {
-    this.initialRender = false;
-  }
   componentDidLoad() {
     onComponentRequiredPropUndefined([{ prop: this.label, propName: "label" }], "Select");
+    if (this.loading)
+      this.triggerLoading();
+    this.hiddenInputValue = this.searchable && this.currValue;
   }
   disconnectedCallback() {
     removeFormResetListener(this.host, this.handleFormReset);
   }
   render() {
+    var _a, _b;
     const { small, disabled, fullWidth, helperText, hideLabel, label, menuId, name, options, placeholder, readonly, required, searchable, showClearButton, validationStatus, validationText, currValue, } = this;
-    renderHiddenInput(true, this.host, name, currValue, disabled);
+    const isOrHasLoaded = ((_a = (searchable ? this.filteredOptions : options)[0]) === null || _a === void 0 ? void 0 : _a.label) ===
+      this.loadingLabel ||
+      ((_b = (searchable ? this.filteredOptions : options)[0]) === null || _b === void 0 ? void 0 : _b.label) ===
+        this.loadingErrorLabel;
+    const inputValue = this.searchable ? this.hiddenInputValue : currValue;
+    renderHiddenInput(true, this.host, name, inputValue, disabled);
     const invalid = validationStatus === IcInformationStatus.Error ? "true" : "false";
     const describedBy = getInputDescribedByText(this.inputId, helperText !== "", hasValidationStatus(this.validationStatus, this.disabled)).trim();
     return (h(Host, { class: {
@@ -453,14 +551,14 @@ export class Select {
         searchable: searchable,
         small: small,
         "full-width": fullWidth,
-      } }, h("ic-input-container", { readonly: readonly }, !hideLabel && (h("ic-input-label", { for: this.inputId, label: label, helperText: helperText, required: required, disabled: disabled, readonly: readonly })), h("ic-input-component-container", { ref: (el) => (this.anchorEl = el), class: { "menu-open": this.open }, small: small, fullWidth: fullWidth, disabled: disabled, readonly: readonly, validationStatus: validationStatus }, readonly ? (h("ic-typography", null, h("p", null, this.getLabelFromValue(currValue)))) : isMobileOrTablet() ? (h("select", Object.assign({ ref: (el) => (this.nativeSelectElement = el), disabled: disabled, onChange: this.handleNativeSelectChange, required: required, id: this.inputId, "aria-label": label, "aria-describedby": describedBy, "aria-invalid": invalid, onBlur: this.onBlur, onFocus: this.onFocus, onKeyDown: this.handleNativeSelectKeyDown }, this.inheritedAttributes), h("option", { value: "", selected: true, disabled: !showClearButton }, placeholder), options.map((option) => {
+      }, onBlur: this.onBlur }, h("ic-input-container", { readonly: readonly }, !hideLabel && (h("ic-input-label", { for: this.inputId, label: label, helperText: helperText, required: required, disabled: disabled, readonly: readonly })), h("ic-input-component-container", { ref: (el) => (this.anchorEl = el), class: { "menu-open": this.open }, small: small, fullWidth: fullWidth, disabled: disabled, readonly: readonly, validationStatus: validationStatus }, readonly ? (h("ic-typography", null, h("p", null, this.getLabelFromValue(currValue)))) : isMobileOrTablet() ? (h("select", Object.assign({ ref: (el) => (this.nativeSelectElement = el), disabled: disabled, onChange: this.handleNativeSelectChange, required: required, id: this.inputId, "aria-label": label, "aria-describedby": describedBy, "aria-invalid": invalid, onBlur: this.onBlur, onFocus: this.onFocus, onKeyDown: this.handleNativeSelectKeyDown }, this.inheritedAttributes), h("option", { value: "", selected: true, disabled: !showClearButton }, placeholder), options.map((option) => {
       if (option.children) {
         return (h("optgroup", { label: option.label }, option.children.map((option) => (h("option", { value: option.value, disabled: option.disabled, selected: option.value === currValue }, option.label)))));
       }
       else {
         return (h("option", { value: option.value, disabled: option.disabled, selected: option.value === currValue }, option.label));
       }
-    }))) : searchable ? (h("div", { class: "searchable-select-container" }, h("input", { class: "select-input", role: "combobox", "aria-label": label, "aria-describedby": describedBy, "aria-activedescendant": this.ariaActiveDescendant, "aria-autocomplete": "list", "aria-expanded": this.open ? "true" : "false", "aria-invalid": invalid, "aria-required": required ? "true" : "false", "aria-controls": menuId, ref: (el) => (this.searchableSelectElement = el), id: this.inputId, value: this.searchableSelectInputValue, placeholder: placeholder, disabled: disabled, onInput: this.handleSearchableSelectInput, onClick: this.handleClick, onKeyDown: this.handleKeyDown, onFocus: this.onFocus, onBlur: this.onBlur }), this.searchableSelectInputValue &&
+    }))) : searchable ? (h("div", { class: "searchable-select-container" }, h("input", { class: "select-input", role: "combobox", autocomplete: "off", "aria-label": label, "aria-describedby": describedBy, "aria-activedescendant": this.ariaActiveDescendant, "aria-autocomplete": "list", "aria-expanded": this.open ? "true" : "false", "aria-invalid": invalid, "aria-required": required ? "true" : "false", "aria-controls": menuId, ref: (el) => (this.searchableSelectElement = el), id: this.inputId, value: this.searchableSelectInputValue, placeholder: placeholder, disabled: disabled, onInput: this.handleSearchableSelectInput, onClick: this.handleClick, onKeyDown: this.handleKeyDown, onFocus: this.onFocus, onBlur: this.onBlur }), this.searchableSelectInputValue &&
       (showClearButton || searchable) && (h("div", { class: "clear-button-container" }, h("ic-button", { id: "clear-button", ref: (el) => (this.clearButton = el), "aria-label": this.searchableSelectInputValue && currValue === null
         ? "Clear input"
         : "Clear selection", class: "clear-button", innerHTML: Clear, onClick: this.handleClear, onFocus: this.handleClearButtonFocus, onBlur: this.handleClearButtonBlur, size: small ? "small" : "default", variant: "icon", appearance: this.clearButtonFocused
@@ -479,10 +577,10 @@ export class Select {
       }, innerHTML: Expand, "aria-hidden": "true" }))), currValue && showClearButton && (h("ic-button", { id: "clear-button", "aria-label": "Clear selection", class: "clear-button", innerHTML: Clear, onClick: this.handleClear, onFocus: this.handleClearButtonFocus, onBlur: this.handleClearButtonBlur, size: small ? "small" : "default", variant: "icon", appearance: this.clearButtonFocused
         ? IcThemeForegroundEnum.Light
         : IcThemeForegroundEnum.Dark }))))), !isMobileOrTablet() && (h("ic-menu", { class: {
-        "no-results": this.noOptions !== null && this.searchable,
+        "no-results": this.noOptions !== null || isOrHasLoaded,
       }, ref: (el) => (this.menu = el), inputEl: searchable
         ? this.searchableSelectElement
-        : this.customSelectElement, inputLabel: label, anchorEl: this.anchorEl, small: small, menuId: menuId, open: this.open, options: searchable ? this.filteredOptions : options, value: currValue, fullWidth: fullWidth, onMenuStateChange: this.handleMenuChange, onMenuOptionSelect: this.handleCustomSelectChange, onMenuKeyPress: this.handleMenuKeyPress, onUngroupedOptionsSet: this.setUngroupedOptions, parentEl: this.host })), hasValidationStatus(this.validationStatus, this.disabled) && (h("ic-input-validation", { class: { "menu-open": this.open }, ariaLiveMode: "polite", status: validationStatus, message: validationText, for: this.inputId })))));
+        : this.customSelectElement, inputLabel: label, anchorEl: this.anchorEl, small: small, menuId: menuId, open: this.open, options: searchable ? this.filteredOptions : options, value: currValue, fullWidth: fullWidth, onMenuStateChange: this.handleMenuChange, onMenuOptionSelect: this.handleCustomSelectChange, onMenuKeyPress: this.handleMenuKeyPress, onUngroupedOptionsSet: this.setUngroupedOptions, onRetryButtonClicked: this.handleRetry, parentEl: this.host, onTimeoutBlur: this.onTimeoutBlur, activationType: this.searchable ? "manual" : "automatic" })), hasValidationStatus(this.validationStatus, this.disabled) && (h("ic-input-validation", { class: { "menu-open": this.open }, ariaLiveMode: "polite", status: validationStatus, message: validationText, for: this.inputId })))));
   }
   static get is() { return "ic-select"; }
   static get encapsulation() { return "shadow"; }
@@ -926,6 +1024,77 @@ export class Select {
         "attribute": "disable-filter",
         "reflect": false,
         "defaultValue": "false"
+      },
+      "timeout": {
+        "type": "number",
+        "mutable": false,
+        "complexType": {
+          "original": "number",
+          "resolved": "number",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "If using external filtering, set a timeout for when loading takes too long."
+        },
+        "attribute": "timeout",
+        "reflect": false
+      },
+      "loadingLabel": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "Change the message displayed whilst the options are being loaded externally."
+        },
+        "attribute": "loading-label",
+        "reflect": false,
+        "defaultValue": "\"Loading...\""
+      },
+      "loadingErrorLabel": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "Change the message displayed when external loading times out."
+        },
+        "attribute": "loading-error-label",
+        "reflect": false,
+        "defaultValue": "\"Loading Error\""
+      },
+      "loading": {
+        "type": "boolean",
+        "mutable": true,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "Trigger loading state when fetching options asyncronously"
+        },
+        "attribute": "loading",
+        "reflect": false,
+        "defaultValue": "false"
       }
     };
   }
@@ -941,7 +1110,9 @@ export class Select {
       "currDebounce": {},
       "currValue": {},
       "debounceIcChange": {},
-      "pressedCharacters": {}
+      "pressedCharacters": {},
+      "hiddenInputValue": {},
+      "inputValueToFilter": {}
     };
   }
   static get events() {
@@ -1050,6 +1221,26 @@ export class Select {
             }
           }
         }
+      }, {
+        "method": "icRetryLoad",
+        "name": "icRetryLoad",
+        "bubbles": true,
+        "cancelable": true,
+        "composed": true,
+        "docs": {
+          "tags": [],
+          "text": "Emitted when the 'retry loading' button is clicked"
+        },
+        "complexType": {
+          "original": "IcValueEventDetail",
+          "resolved": "IcValueEventDetail",
+          "references": {
+            "IcValueEventDetail": {
+              "location": "import",
+              "path": "../../interface"
+            }
+          }
+        }
       }];
   }
   static get methods() {
@@ -1075,6 +1266,9 @@ export class Select {
   static get elementRef() { return "host"; }
   static get watchers() {
     return [{
+        "propName": "loading",
+        "methodName": "loadingHandler"
+      }, {
         "propName": "options",
         "methodName": "watchOptionsHandler"
       }, {