@siemens/ix 0.0.0-20240522073858 → 0.0.0-pr-1318-20240627080522

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

@@ -20,14 +20,30 @@ import { h, Host, } from "@stencil/core";
 import { ArrowFocusController } from "../utils/focus";
 import { OnListener } from "../utils/listener";
 import { createMutationObserver } from "../utils/mutation-observer";
+import { HookValidationLifecycle, } from "../utils/field";
+import { makeRef } from "../utils/make-ref";
+import { a11yBoolean } from "../utils/a11y";
+/**
+ * @form-ready 2.4.0
+ */
 export class Select {
     constructor() {
+        this.inputRef = makeRef();
         this.focusControllerCallbackBind = this.focusDropdownItem.bind(this);
         this.itemObserver = createMutationObserver(() => {
             this.arrowFocusController.items = this.visibleNonShadowItems;
         });
+        this.name = undefined;
+        this.required = false;
+        this.label = undefined;
+        this.warningText = undefined;
+        this.infoText = undefined;
+        this.invalidText = undefined;
+        this.validText = undefined;
+        this.helperText = undefined;
+        this.showTextAsTooltip = undefined;
         this.selectedIndices = undefined;
-        this.value = undefined;
+        this.value = [];
         this.allowClear = false;
         this.mode = 'single';
         this.editable = false;
@@ -43,9 +59,13 @@ export class Select {
         this.dropdownWrapperRef = undefined;
         this.dropdownAnchor = undefined;
         this.isDropdownEmpty = false;
-        this.navigationItem = undefined;
+        this.navigationItem = null;
         this.inputFilterText = undefined;
-        this.inputValue = undefined;
+        this.inputValue = null;
+        this.isInvalid = false;
+        this.isValid = false;
+        this.isInfo = false;
+        this.isWarning = false;
     }
     get nonShadowItems() {
         return Array.from(this.hostElement.querySelectorAll('ix-select-item'));
@@ -99,7 +119,6 @@ export class Select {
         }
         else {
             this.arrowFocusController.disconnect();
-            this.arrowFocusController = undefined;
             this.itemObserver.disconnect();
         }
     }
@@ -107,11 +126,28 @@ export class Select {
         const newId = event.detail;
         this.itemClick(newId);
     }
+    async updateFormInternalValue(value) {
+        if (Array.isArray(value)) {
+            this.formInternals.setFormValue(value.join(','));
+            return;
+        }
+        this.formInternals.setFormValue(value);
+    }
+    /** @internal */
+    async hasValidValue() {
+        return this.required && !!this.hasValue();
+    }
+    hasValue() {
+        if (Array.isArray(this.value)) {
+            return !!this.value.length;
+        }
+        return !!this.value;
+    }
     focusDropdownItem(index) {
-        var _a;
-        this.navigationItem = undefined;
+        var _a, _b;
+        this.navigationItem = null;
         if (index < this.visibleNonShadowItems.length) {
-            const nestedDropdownItem = (_a = this.visibleNonShadowItems[index]) === null || _a === void 0 ? void 0 : _a.shadowRoot.querySelector('ix-dropdown-item');
+            const nestedDropdownItem = (_b = (_a = this.visibleNonShadowItems[index]) === null || _a === void 0 ? void 0 : _a.shadowRoot) === null || _b === void 0 ? void 0 : _b.querySelector('ix-dropdown-item');
             requestAnimationFrame(() => {
                 nestedDropdownItem.shadowRoot.querySelector('button').focus();
             });
@@ -120,7 +156,7 @@ export class Select {
     itemClick(newId) {
         this.value = this.toggleValue(newId);
         this.updateSelection();
-        this.emitValueChange();
+        this.emitValueChange(this.value);
     }
     emitAddItem(value) {
         if (value === undefined || value.trim() === '') {
@@ -159,34 +195,37 @@ export class Select {
             ids = Array.isArray(this.value) ? [...this.value] : [this.value];
         }
         this.items.forEach((item) => {
-            item.selected = ids.some(
-            // Check can be removed if value is type of string in future releases
-            (i) => i ===
-                (item.value !== undefined && item.value !== null
-                    ? item.value.toString()
-                    : ''));
+            item.selected = ids.some((i) => {
+                if (typeof i !== typeof item.value) {
+                    return i.toString() === item.value.toString();
+                }
+                else {
+                    return i === item.value;
+                }
+            });
         });
         this.selectedLabels = this.selectedItems.map((item) => item.label);
         if (this.isSingleMode && ((_a = this.selectedLabels) === null || _a === void 0 ? void 0 : _a.length)) {
             this.inputValue = this.selectedLabels[0];
-            this.inputRef && (this.inputRef.value = this.inputValue);
+            this.input && (this.input.value = this.inputValue);
             return;
         }
         this.inputValue = null;
     }
-    emitValueChange() {
-        this.valueChange.emit(this.value);
-        if (!this.value) {
-            this.itemSelectionChange.emit(null);
+    emitValueChange(value) {
+        this.valueChange.emit(value);
+        if (!value) {
+            this.itemSelectionChange.emit([]);
         }
         else {
-            this.itemSelectionChange.emit(Array.isArray(this.value) ? this.value : [this.value]);
+            this.itemSelectionChange.emit(Array.isArray(value) ? value : [value]);
         }
+        this.updateFormInternalValue(value);
     }
     componentDidLoad() {
-        this.inputRef.addEventListener('input', () => {
+        this.input.addEventListener('input', () => {
             this.dropdownShow = true;
-            this.inputChange.emit(this.inputRef.value);
+            this.inputChange.emit(this.input.value);
         });
     }
     componentWillLoad() {
@@ -194,6 +233,7 @@ export class Select {
             this.value = this.selectedIndices;
         }
         this.updateSelection();
+        this.updateFormInternalValue(this.value);
     }
     onLabelChange(event) {
         event.preventDefault();
@@ -211,13 +251,13 @@ export class Select {
     dropdownVisibilityChanged(event) {
         this.dropdownShow = event.detail;
         if (event.detail) {
-            this.inputRef.focus();
-            this.inputRef.select();
+            this.input.focus();
+            this.input.select();
             this.removeHiddenFromItems();
             this.isDropdownEmpty = this.isEveryDropdownItemHidden;
         }
         else {
-            this.navigationItem = undefined;
+            this.navigationItem = null;
             this.updateSelection();
             this.inputFilterText = '';
         }
@@ -271,7 +311,9 @@ export class Select {
             return;
         }
         const moveUp = key === 'ArrowUp';
-        const indexNonShadow = this.visibleNonShadowItems.indexOf(document.activeElement);
+        const indexNonShadow = document.activeElement
+            ? this.visibleNonShadowItems.indexOf(document.activeElement)
+            : -1;
         // Slotted select items
         if (indexNonShadow === 0) {
             if (!this.visibleShadowItems.length && this.isAddItemVisible()) {
@@ -292,6 +334,9 @@ export class Select {
             }
             return;
         }
+        if (!this.navigationItem) {
+            return;
+        }
         if (this.isAddItemVisible() &&
             this.addItemRef.contains(await this.navigationItem.getDropdownItemElement())) {
             if (moveUp) {
@@ -346,13 +391,14 @@ export class Select {
         });
     }
     focusAddItemButton() {
+        var _a, _b;
         if (this.addItemButton) {
-            this.addItemButton.shadowRoot.querySelector('button').focus();
+            (_b = (_a = this.addItemButton.shadowRoot) === null || _a === void 0 ? void 0 : _a.querySelector('button')) === null || _b === void 0 ? void 0 : _b.focus();
             this.navigationItem = this.addItemRef;
         }
     }
     filterItemsWithTypeahead() {
-        this.inputFilterText = this.inputRef.value;
+        this.inputFilterText = this.input.value;
         if (this.isSingleMode && this.inputFilterText === this.selectedLabels[0]) {
             return;
         }
@@ -378,25 +424,27 @@ export class Select {
         });
     }
     clearInput() {
-        this.inputRef.value = '';
+        this.input.value = '';
         this.inputFilterText = '';
     }
     clear() {
         this.clearInput();
         this.selectedLabels = [];
         this.value = [];
-        this.valueChange.emit(null);
+        this.emitValueChange([]);
         this.dropdownShow = false;
     }
-    onInputBlur(e) {
+    onInputBlur(event) {
+        this.ixBlur.emit();
         if (this.editable) {
             return;
         }
         if (this.isSingleMode) {
             return;
         }
+        const target = event.target;
         if (!this.dropdownShow && this.mode !== 'multiple') {
-            e.target['value'] = this.selectedLabels;
+            target.value = this.selectedLabels.toString();
         }
     }
     placeholderValue() {
@@ -416,9 +464,27 @@ export class Select {
             this.editable &&
             this.inputFilterText);
     }
+    onValidationChange({ isInvalid, isInvalidByRequired, isValid, isInfo, isWarning, }) {
+        this.isInvalid = isInvalid || isInvalidByRequired;
+        this.isValid = isValid;
+        this.isWarning = isWarning;
+        this.isInfo = isInfo;
+    }
+    /** @internal */
+    async getAssociatedFormElement() {
+        return this.formInternals.form;
+    }
+    /**
+     * Returns the native input element used in the component.
+     */
+    getNativeInputElement() {
+        return Promise.resolve(this.input);
+    }
     render() {
-        var _a, _b, _c;
-        return (h(Host, { key: '7708ebeef204960e387864c06de4cf3d0d92620b' }, h("div", { key: '76ae70f1d3e1c3988a8db625b8c41626dcc0b28e', class: {
+        var _a, _b, _c, _d;
+        return (h(Host, { key: '21e0971bd52ae14711ef823e767112aa3ea8427e', "aria-disabled": a11yBoolean(this.disabled), class: {
+                disabled: this.disabled,
+            } }, h("ix-field-wrapper", { key: '709016dc62c4268b208f5469ac94274676fb3ada', required: this.required, label: this.label, helperText: this.helperText, invalidText: this.invalidText, infoText: this.infoText, warningText: this.warningText, validText: this.validText, showTextAsTooltip: this.showTextAsTooltip, isInvalid: this.isInvalid, isValid: this.isValid, isInfo: this.isInfo, isWarning: this.isWarning, controlRef: this.inputRef }, h("slot", { key: 'd6b6c90ec55424683d484520c6edd3aa2148d153', name: "label", slot: "label" }), h("div", { key: '50c23c58457980fb5d38d80f89f74a0b1d7c32a1', class: {
                 select: true,
                 disabled: this.disabled,
                 readonly: this.readonly,
@@ -426,34 +492,39 @@ export class Select {
                 this.dropdownAnchor = ref;
                 if (!this.editable)
                     this.dropdownWrapperRef = ref;
-            } }, h("div", { key: '4cc234c24f76895f3dbc4a004c748352ef8aaa33', class: "input-container" }, h("div", { key: '066c71f9a1ead8f39685ea66fb1c83c6ad45f6a6', class: "chips" }, this.isMultipleMode
+            } }, h("div", { key: '2c62a44a73929e8f337b1dbbacb4f4e90a972368', class: "input-container" }, h("div", { key: 'b48c59522094b785eaa673618c500ab957b84916', class: "chips" }, this.isMultipleMode
             ? (_a = this.selectedItems) === null || _a === void 0 ? void 0 : _a.map((item) => (h("ix-filter-chip", { disabled: this.disabled || this.readonly, key: item.value, onCloseClick: (e) => {
                     e.preventDefault();
                     e.stopPropagation();
                     this.itemClick(item.value);
                 } }, item.label)))
-            : '', h("div", { key: '513a21a42da236852e5baa0dd15246f6108fcb0e', class: "trigger" }, h("input", { key: '7e059a58466f1ef24af5465a31842dc373be681c', autocomplete: "off", "data-testid": "input", disabled: this.disabled, readOnly: this.readonly, type: "text", class: {
+            : '', h("div", { key: '80412b3e3ff58078d9a15910c552a9fd16cc723d', class: "trigger" }, h("input", { key: '8c7c72a83997d0fe82acb4fa1afd2fb1d299d8a5', autocomplete: "off", "data-testid": "input", disabled: this.disabled, readOnly: this.readonly, type: "text", class: {
                 'allow-clear': this.allowClear && !!((_b = this.selectedLabels) === null || _b === void 0 ? void 0 : _b.length),
-            }, placeholder: this.placeholderValue(), value: this.inputValue, ref: (ref) => (this.inputRef = ref), onBlur: (e) => this.onInputBlur(e), onFocus: () => {
-                this.navigationItem = undefined;
+            }, placeholder: this.placeholderValue(), value: (_c = this.inputValue) !== null && _c !== void 0 ? _c : '', ref: (ref) => {
+                this.input = ref;
+                this.inputRef(ref);
+            }, onBlur: (e) => this.onInputBlur(e), onFocus: () => {
+                this.navigationItem = null;
             }, onInput: () => this.filterItemsWithTypeahead(), onKeyDown: (e) => this.onKeyDown(e) }), this.allowClear &&
-            (((_c = this.selectedLabels) === null || _c === void 0 ? void 0 : _c.length) || this.inputFilterText) ? (h("ix-icon-button", { class: "clear", icon: 'clear', ghost: true, oval: true, size: "16", onClick: (e) => {
+            (((_d = this.selectedLabels) === null || _d === void 0 ? void 0 : _d.length) || this.inputFilterText) ? (h("ix-icon-button", { class: "clear", icon: 'clear', ghost: true, oval: true, size: "16", onClick: (e) => {
                 e.preventDefault();
                 e.stopPropagation();
                 this.clear();
             } })) : null, this.disabled || this.readonly ? null : (h("ix-icon-button", { "data-select-dropdown": true, class: { 'dropdown-visible': this.dropdownShow }, icon: "chevron-down-small", ghost: true, ref: (ref) => {
                 if (this.editable)
                     this.dropdownWrapperRef = ref;
-            } })))))), h("ix-dropdown", { key: '90d7f4d393e170384c3849a81cc2d0f9cafdaba4', ref: (ref) => (this.dropdownRef = ref), show: this.dropdownShow, closeBehavior: this.isMultipleMode ? 'outside' : 'both', class: {
+            } }))))))), h("ix-dropdown", { key: 'eb80a8a205741cb2a095ee8b0bbfafec2558ccaa', ref: (ref) => (this.dropdownRef = ref), show: this.dropdownShow, closeBehavior: this.isMultipleMode ? 'outside' : 'both', class: {
                 'd-none': this.disabled || this.readonly,
             }, anchor: this.dropdownAnchor, trigger: this.dropdownWrapperRef, onShowChanged: (e) => this.dropdownVisibilityChanged(e), placement: "bottom-start", overwriteDropdownStyle: async () => {
+                var _a, _b;
+                const minWidth = (_b = (_a = this.hostElement.shadowRoot) === null || _a === void 0 ? void 0 : _a.querySelector('.select')) === null || _b === void 0 ? void 0 : _b.getBoundingClientRect().width;
                 return {
-                    minWidth: `${this.hostElement.clientWidth}px`,
+                    minWidth: `${minWidth}px`,
                 };
-            } }, h("div", { key: '5ca9e64a4bd8b566e33717f2d2bac21f86638aeb', class: {
+            } }, h("div", { key: '9ac7e24e0add43e1f78217adf5afbf75687ac12b', class: {
                 'select-list-header': true,
                 hidden: this.hideListHeader || this.isDropdownEmpty,
-            }, title: this.i18nSelectListHeader }, this.i18nSelectListHeader), h("slot", { key: 'c2b10c1b09dd64eb0ab0a6bc51d43f98e876031a' }), h("div", { key: 'a7076d2f894af20584a45109b397b0362ea6f6a5', ref: (ref) => (this.customItemsContainerRef = ref), class: "d-contents" }), this.isAddItemVisible() ? (h("ix-dropdown-item", { "data-testid": "add-item", icon: 'plus', class: {
+            }, title: this.i18nSelectListHeader, onClick: (e) => e.preventDefault() }, this.i18nSelectListHeader), h("slot", { key: 'b4ce515c73fc2ffcbab4ce4c34b8eed01904b9e0' }), h("div", { key: '24961fabb03943f19c449f31dd1151e906923620', ref: (ref) => (this.customItemsContainerRef = ref), class: "d-contents" }), this.isAddItemVisible() ? (h("ix-dropdown-item", { "data-testid": "add-item", icon: 'plus', class: {
                 'add-item': true,
             }, label: this.inputFilterText, onItemClick: (e) => {
                 e.preventDefault();
@@ -465,6 +536,7 @@ export class Select {
     }
     static get is() { return "ix-select"; }
     static get encapsulation() { return "shadow"; }
+    static get formAssociated() { return true; }
     static get originalStyleUrls() {
         return {
             "$": ["select.scss"]
@@ -477,6 +549,187 @@ export class Select {
     }
     static get properties() {
         return {
+            "name": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [{
+                            "name": "since",
+                            "text": "2.4.0"
+                        }],
+                    "text": "A string that represents the element's name attribute,\ncontaining a name that identifies the element when submitting the form."
+                },
+                "attribute": "name",
+                "reflect": true
+            },
+            "required": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [{
+                            "name": "since",
+                            "text": "2.4.0"
+                        }],
+                    "text": "A Boolean attribute indicating that an option with a non-empty string value must be selected"
+                },
+                "attribute": "required",
+                "reflect": true,
+                "defaultValue": "false"
+            },
+            "label": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [{
+                            "name": "since",
+                            "text": "2.4.0"
+                        }],
+                    "text": "Label for the select component"
+                },
+                "attribute": "label",
+                "reflect": false
+            },
+            "warningText": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [{
+                            "name": "since",
+                            "text": "2.4.0"
+                        }],
+                    "text": "Warning text for the select component"
+                },
+                "attribute": "warning-text",
+                "reflect": false
+            },
+            "infoText": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [{
+                            "name": "since",
+                            "text": "2.4.0"
+                        }],
+                    "text": "Info text for the select component"
+                },
+                "attribute": "info-text",
+                "reflect": false
+            },
+            "invalidText": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [{
+                            "name": "since",
+                            "text": "2.4.0"
+                        }],
+                    "text": "Error text for the select component"
+                },
+                "attribute": "invalid-text",
+                "reflect": false
+            },
+            "validText": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [{
+                            "name": "since",
+                            "text": "2.4.0"
+                        }],
+                    "text": "Valid text for the select component"
+                },
+                "attribute": "valid-text",
+                "reflect": false
+            },
+            "helperText": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [{
+                            "name": "since",
+                            "text": "2.4.0"
+                        }],
+                    "text": "Helper text for the select component"
+                },
+                "attribute": "helper-text",
+                "reflect": false
+            },
+            "showTextAsTooltip": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [{
+                            "name": "since",
+                            "text": "2.4.0"
+                        }],
+                    "text": "Show helper, error, info, warning text as tooltip"
+                },
+                "attribute": "show-text-as-tooltip",
+                "reflect": false
+            },
             "selectedIndices": {
                 "type": "string",
                 "mutable": true,
@@ -506,7 +759,7 @@ export class Select {
                     "references": {}
                 },
                 "required": false,
-                "optional": true,
+                "optional": false,
                 "docs": {
                     "tags": [{
                             "name": "since",
@@ -515,7 +768,8 @@ export class Select {
                     "text": "Current selected value.\nThis corresponds to the value property of ix-select-items"
                 },
                 "attribute": "value",
-                "reflect": false
+                "reflect": false,
+                "defaultValue": "[]"
             },
             "allowClear": {
                 "type": "boolean",
@@ -714,7 +968,11 @@ export class Select {
             "isDropdownEmpty": {},
             "navigationItem": {},
             "inputFilterText": {},
-            "inputValue": {}
+            "inputValue": {},
+            "isInvalid": {},
+            "isValid": {},
+            "isInfo": {},
+            "isWarning": {}
         };
     }
     static get events() {
@@ -787,8 +1045,92 @@ export class Select {
                     "resolved": "string",
                     "references": {}
                 }
+            }, {
+                "method": "ixBlur",
+                "name": "ixBlur",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Blur input"
+                },
+                "complexType": {
+                    "original": "void",
+                    "resolved": "void",
+                    "references": {}
+                }
             }];
     }
+    static get methods() {
+        return {
+            "hasValidValue": {
+                "complexType": {
+                    "signature": "() => Promise<boolean>",
+                    "parameters": [],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        }
+                    },
+                    "return": "Promise<boolean>"
+                },
+                "docs": {
+                    "text": "",
+                    "tags": [{
+                            "name": "internal",
+                            "text": undefined
+                        }]
+                }
+            },
+            "getAssociatedFormElement": {
+                "complexType": {
+                    "signature": "() => Promise<HTMLFormElement | null>",
+                    "parameters": [],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        },
+                        "HTMLFormElement": {
+                            "location": "global",
+                            "id": "global::HTMLFormElement"
+                        }
+                    },
+                    "return": "Promise<HTMLFormElement>"
+                },
+                "docs": {
+                    "text": "",
+                    "tags": [{
+                            "name": "internal",
+                            "text": undefined
+                        }]
+                }
+            },
+            "getNativeInputElement": {
+                "complexType": {
+                    "signature": "() => Promise<HTMLInputElement>",
+                    "parameters": [],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        },
+                        "HTMLInputElement": {
+                            "location": "global",
+                            "id": "global::HTMLInputElement"
+                        }
+                    },
+                    "return": "Promise<HTMLInputElement>"
+                },
+                "docs": {
+                    "text": "Returns the native input element used in the component.",
+                    "tags": []
+                }
+            }
+        };
+    }
     static get elementRef() { return "hostElement"; }
     static get watchers() {
         return [{
@@ -817,8 +1159,12 @@ export class Select {
                 "passive": false
             }];
     }
+    static get attachInternalsMemberName() { return "formInternals"; }
 }
 __decorate([
     OnListener('keydown', (self) => self.dropdownShow)
 ], Select.prototype, "onKeyDown", null);
+__decorate([
+    HookValidationLifecycle()
+], Select.prototype, "onValidationChange", null);
 //# sourceMappingURL=select.js.map