@haiilo/catalyst 11.0.0 → 12.0.0

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

@@ -35,33 +35,59 @@ export class CatSelect {
         this.term$ = new Subject();
         this.more$ = new Subject();
         this.valueChangedBySelection = false;
-        this.connector = undefined;
         this.state = INIT_STATE;
         this.hasSlottedLabel = false;
         this.hasSlottedHint = false;
-        this.errorMap = undefined;
+        /**
+         * Whether the label need a marker to shown if the select is required or optional.
+         */
         this.requiredMarker = 'optional';
+        /**
+         * Whether the label is on top or left.
+         */
         this.horizontal = false;
+        /**
+         * Enable multiple selection.
+         */
         this.multiple = false;
+        /**
+         * The debounce time for the search.
+         */
         this.debounce = 250;
+        /**
+         * The placement of the select.
+         */
         this.placement = 'bottom-start';
-        this.value = undefined;
+        /**
+         * Whether the select is disabled.
+         */
         this.disabled = false;
-        this.placeholder = undefined;
-        this.hint = undefined;
-        this.identifier = undefined;
+        /**
+         * The label for the select.
+         */
         this.label = '';
-        this.name = undefined;
+        /**
+         * Visually hide the label, but still show it to assistive technologies like screen readers.
+         */
         this.labelHidden = false;
+        /**
+         * A value is required or must be checked for the form to be submittable.
+         */
         this.required = false;
+        /**
+         * Whether the select should show a clear button.
+         */
         this.clearable = false;
+        /**
+         * Whether the select should add new items.
+         */
         this.tags = false;
-        this.tagHint = undefined;
-        this.noItems = undefined;
-        this.errors = undefined;
+        /**
+         * Fine-grained control over when the errors are shown. Can be `false` to
+         * never show errors, `true` to show errors on blur, or a number to show
+         * errors change with the given delay in milliseconds or immediately on blur.
+         */
         this.errorUpdate = 0;
-        this.nativeAttributes = undefined;
-        this.testId = undefined;
     }
     get id() {
         return this.identifier || this._id;
@@ -693,6 +719,7 @@ export class CatSelect {
         return {
             "requiredMarker": {
                 "type": "string",
+                "attribute": "required-marker",
                 "mutable": false,
                 "complexType": {
                     "original": "'none' | 'required' | 'optional' | 'none!' | 'optional!' | 'required!'",
@@ -705,12 +732,14 @@ export class CatSelect {
                     "tags": [],
                     "text": "Whether the label need a marker to shown if the select is required or optional."
                 },
-                "attribute": "required-marker",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'optional'"
             },
             "horizontal": {
                 "type": "boolean",
+                "attribute": "horizontal",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -723,12 +752,14 @@ export class CatSelect {
                     "tags": [],
                     "text": "Whether the label is on top or left."
                 },
-                "attribute": "horizontal",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "multiple": {
                 "type": "boolean",
+                "attribute": "multiple",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -741,12 +772,14 @@ export class CatSelect {
                     "tags": [],
                     "text": "Enable multiple selection."
                 },
-                "attribute": "multiple",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "debounce": {
                 "type": "number",
+                "attribute": "debounce",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -759,12 +792,14 @@ export class CatSelect {
                     "tags": [],
                     "text": "The debounce time for the search."
                 },
-                "attribute": "debounce",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "250"
             },
             "placement": {
                 "type": "string",
+                "attribute": "placement",
                 "mutable": false,
                 "complexType": {
                     "original": "Placement",
@@ -783,12 +818,14 @@ export class CatSelect {
                     "tags": [],
                     "text": "The placement of the select."
                 },
-                "attribute": "placement",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'bottom-start'"
             },
             "value": {
                 "type": "string",
+                "attribute": "value",
                 "mutable": true,
                 "complexType": {
                     "original": "string | string[] | CatSelectTaggingValue | CatSelectMultipleTaggingValue",
@@ -812,11 +849,13 @@ export class CatSelect {
                     "tags": [],
                     "text": "The value of the select. <br />\n<br />\nThe value of the select depends on whether it is allowed to choose a single item or several items. <br />\nWhen only one item can be selected, the value is the id of the item, in case several items can be selected, the value is an array of ids of the selected items. <br />\n<br />\nIn case the user can add new items to the select (tags activated), the value in the single select is an object (CatSelectTaggingValue) with the id of the item or the name of the created item,\nin the case of multiple select, it is an object (CatSelectMultipleTaggingValue) with the array of the ids of the items selected and the array of the names of the items created"
                 },
-                "attribute": "value",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "disabled": {
                 "type": "boolean",
+                "attribute": "disabled",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -829,12 +868,14 @@ export class CatSelect {
                     "tags": [],
                     "text": "Whether the select is disabled."
                 },
-                "attribute": "disabled",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "placeholder": {
                 "type": "string",
+                "attribute": "placeholder",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -847,11 +888,13 @@ export class CatSelect {
                     "tags": [],
                     "text": "The placeholder text to display within the select."
                 },
-                "attribute": "placeholder",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "hint": {
                 "type": "string",
+                "attribute": "hint",
                 "mutable": false,
                 "complexType": {
                     "original": "string | string[]",
@@ -864,11 +907,13 @@ export class CatSelect {
                     "tags": [],
                     "text": "Optional hint text(s) to be displayed with the select."
                 },
-                "attribute": "hint",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "identifier": {
                 "type": "string",
+                "attribute": "identifier",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -881,11 +926,13 @@ export class CatSelect {
                     "tags": [],
                     "text": "A unique identifier for the input."
                 },
-                "attribute": "identifier",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "label": {
                 "type": "string",
+                "attribute": "label",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -898,12 +945,14 @@ export class CatSelect {
                     "tags": [],
                     "text": "The label for the select."
                 },
-                "attribute": "label",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "''"
             },
             "name": {
                 "type": "string",
+                "attribute": "name",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -916,11 +965,13 @@ export class CatSelect {
                     "tags": [],
                     "text": "The name of the form control. Submitted with the form as part of a name/value pair."
                 },
-                "attribute": "name",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "labelHidden": {
                 "type": "boolean",
+                "attribute": "label-hidden",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -933,12 +984,14 @@ export class CatSelect {
                     "tags": [],
                     "text": "Visually hide the label, but still show it to assistive technologies like screen readers."
                 },
-                "attribute": "label-hidden",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "required": {
                 "type": "boolean",
+                "attribute": "required",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -951,12 +1004,14 @@ export class CatSelect {
                     "tags": [],
                     "text": "A value is required or must be checked for the form to be submittable."
                 },
-                "attribute": "required",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "clearable": {
                 "type": "boolean",
+                "attribute": "clearable",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -969,12 +1024,14 @@ export class CatSelect {
                     "tags": [],
                     "text": "Whether the select should show a clear button."
                 },
-                "attribute": "clearable",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "tags": {
                 "type": "boolean",
+                "attribute": "tags",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -987,12 +1044,14 @@ export class CatSelect {
                     "tags": [],
                     "text": "Whether the select should add new items."
                 },
-                "attribute": "tags",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "tagHint": {
                 "type": "string",
+                "attribute": "tag-hint",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -1005,11 +1064,13 @@ export class CatSelect {
                     "tags": [],
                     "text": "Optional hint text to be displayed on the new item to be added."
                 },
-                "attribute": "tag-hint",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "noItems": {
                 "type": "string",
+                "attribute": "no-items",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -1022,11 +1083,13 @@ export class CatSelect {
                     "tags": [],
                     "text": "The text to display in the dropdown if no results are found."
                 },
-                "attribute": "no-items",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "errors": {
                 "type": "boolean",
+                "attribute": "errors",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean | string[] | ErrorMap",
@@ -1045,11 +1108,13 @@ export class CatSelect {
                     "tags": [],
                     "text": "The validation errors for this input. Will render a hint under the input\nwith the translated error message(s) `error.${key}`. If an object is\npassed, the keys will be used as error keys and the values translation\nparameters.\nIf the value is `true`, the input will be marked as invalid without any\nhints under the input."
                 },
-                "attribute": "errors",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "errorUpdate": {
                 "type": "any",
+                "attribute": "error-update",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean | number",
@@ -1062,12 +1127,14 @@ export class CatSelect {
                     "tags": [],
                     "text": "Fine-grained control over when the errors are shown. Can be `false` to\nnever show errors, `true` to show errors on blur, or a number to show\nerrors change with the given delay in milliseconds or immediately on blur."
                 },
-                "attribute": "error-update",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "0"
             },
             "nativeAttributes": {
                 "type": "unknown",
+                "attribute": "native-attributes",
                 "mutable": false,
                 "complexType": {
                     "original": "{ [key: string]: string }",
@@ -1079,10 +1146,13 @@ export class CatSelect {
                 "docs": {
                     "tags": [],
                     "text": "Attributes that will be added to the native HTML input element."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "testId": {
                 "type": "string",
+                "attribute": "test-id",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -1095,7 +1165,8 @@ export class CatSelect {
                     "tags": [],
                     "text": "A unique identifier for the underlying native element that is used for\ntesting purposes. The attribute is added as `data-test` attribute and acts\nas a shorthand for `nativeAttributes={ 'data-test': 'test-Id' }`."
                 },
-                "attribute": "test-id",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             }
         };