@haiilo/catalyst 11.0.0 → 12.0.0

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

@@ -24,39 +24,64 @@ export class CatInput {
         this.hasSlottedHint = false;
         this.hasSlottedCounter = false;
         this.isPasswordShown = false;
-        this.errorMap = undefined;
+        /**
+         * Whether the label need a marker to shown if the input is required or optional.
+         */
         this.requiredMarker = 'optional';
+        /**
+         * Whether the label is on top or left.
+         */
         this.horizontal = false;
-        this.autoComplete = undefined;
+        /**
+         * Whether the input should show a clear button.
+         */
         this.clearable = false;
+        /**
+         * Whether the input should show a password toggle button for password inputs.
+         */
         this.togglePassword = false;
+        /**
+         * Whether the input is disabled.
+         */
         this.disabled = false;
+        /**
+         * Displays the input in a loading state with a spinner.
+         */
         this.loading = false;
-        this.hint = undefined;
-        this.icon = undefined;
+        /**
+         * Display the icon on the right.
+         */
         this.iconRight = false;
-        this.identifier = undefined;
+        /**
+         * The label for the input.
+         */
         this.label = '';
+        /**
+         * Visually hide the label, but still show it to assistive technologies like screen readers.
+         */
         this.labelHidden = false;
-        this.max = undefined;
-        this.maxLength = undefined;
-        this.min = undefined;
-        this.minLength = undefined;
-        this.name = undefined;
-        this.placeholder = undefined;
-        this.textPrefix = undefined;
-        this.textSuffix = undefined;
+        /**
+         * The value is not editable.
+         */
         this.readonly = false;
+        /**
+         * A value is required or must be check for the form to be submittable.
+         */
         this.required = false;
+        /**
+         * Use round input edges.
+         */
         this.round = false;
+        /**
+         * Type of form control.
+         */
         this.type = 'text';
-        this.value = 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;
-        this.timeMaskOptions = undefined;
-        this.dateMaskOptions = undefined;
     }
     get id() {
         return this.identifier || this._id;
@@ -204,6 +229,7 @@ export class CatInput {
         return {
             "requiredMarker": {
                 "type": "string",
+                "attribute": "required-marker",
                 "mutable": false,
                 "complexType": {
                     "original": "'none' | 'required' | 'optional' | 'none!' | 'optional!' | 'required!'",
@@ -216,12 +242,14 @@ export class CatInput {
                     "tags": [],
                     "text": "Whether the label need a marker to shown if the input 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",
@@ -234,12 +262,14 @@ export class CatInput {
                     "tags": [],
                     "text": "Whether the label is on top or left."
                 },
-                "attribute": "horizontal",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "autoComplete": {
                 "type": "string",
+                "attribute": "auto-complete",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -252,11 +282,13 @@ export class CatInput {
                     "tags": [],
                     "text": "Hint for form autofill feature."
                 },
-                "attribute": "auto-complete",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "clearable": {
                 "type": "boolean",
+                "attribute": "clearable",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -269,12 +301,14 @@ export class CatInput {
                     "tags": [],
                     "text": "Whether the input should show a clear button."
                 },
-                "attribute": "clearable",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "togglePassword": {
                 "type": "boolean",
+                "attribute": "toggle-password",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -287,12 +321,14 @@ export class CatInput {
                     "tags": [],
                     "text": "Whether the input should show a password toggle button for password inputs."
                 },
-                "attribute": "toggle-password",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "disabled": {
                 "type": "boolean",
+                "attribute": "disabled",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -305,12 +341,14 @@ export class CatInput {
                     "tags": [],
                     "text": "Whether the input is disabled."
                 },
-                "attribute": "disabled",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "loading": {
                 "type": "boolean",
+                "attribute": "loading",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -323,12 +361,14 @@ export class CatInput {
                     "tags": [],
                     "text": "Displays the input in a loading state with a spinner."
                 },
-                "attribute": "loading",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "hint": {
                 "type": "string",
+                "attribute": "hint",
                 "mutable": false,
                 "complexType": {
                     "original": "string | string[]",
@@ -341,11 +381,13 @@ export class CatInput {
                     "tags": [],
                     "text": "Optional hint text(s) to be displayed with the input."
                 },
-                "attribute": "hint",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "icon": {
                 "type": "string",
+                "attribute": "icon",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -358,11 +400,13 @@ export class CatInput {
                     "tags": [],
                     "text": "The name of an icon to be displayed in the input."
                 },
-                "attribute": "icon",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "iconRight": {
                 "type": "boolean",
+                "attribute": "icon-right",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -375,12 +419,14 @@ export class CatInput {
                     "tags": [],
                     "text": "Display the icon on the right."
                 },
-                "attribute": "icon-right",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "identifier": {
                 "type": "string",
+                "attribute": "identifier",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -393,11 +439,13 @@ export class CatInput {
                     "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",
@@ -410,12 +458,14 @@ export class CatInput {
                     "tags": [],
                     "text": "The label for the input."
                 },
-                "attribute": "label",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "''"
             },
             "labelHidden": {
                 "type": "boolean",
+                "attribute": "label-hidden",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -428,12 +478,14 @@ export class CatInput {
                     "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"
             },
             "max": {
                 "type": "any",
+                "attribute": "max",
                 "mutable": false,
                 "complexType": {
                     "original": "number | string",
@@ -446,11 +498,13 @@ export class CatInput {
                     "tags": [],
                     "text": "A maximum value for numeric values."
                 },
-                "attribute": "max",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "maxLength": {
                 "type": "number",
+                "attribute": "max-length",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -463,11 +517,13 @@ export class CatInput {
                     "tags": [],
                     "text": "A maximum length (number of characters) for textual values."
                 },
-                "attribute": "max-length",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "min": {
                 "type": "any",
+                "attribute": "min",
                 "mutable": false,
                 "complexType": {
                     "original": "number | string",
@@ -480,11 +536,13 @@ export class CatInput {
                     "tags": [],
                     "text": "A minimum value for numeric values."
                 },
-                "attribute": "min",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "minLength": {
                 "type": "number",
+                "attribute": "min-length",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -497,11 +555,13 @@ export class CatInput {
                     "tags": [],
                     "text": "A minimum length (number of characters) for textual values."
                 },
-                "attribute": "min-length",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "name": {
                 "type": "string",
+                "attribute": "name",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -514,11 +574,13 @@ export class CatInput {
                     "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
             },
             "placeholder": {
                 "type": "string",
+                "attribute": "placeholder",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -531,11 +593,13 @@ export class CatInput {
                     "tags": [],
                     "text": "The placeholder text to display within the input."
                 },
-                "attribute": "placeholder",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "textPrefix": {
                 "type": "string",
+                "attribute": "text-prefix",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -548,11 +612,13 @@ export class CatInput {
                     "tags": [],
                     "text": "A textual prefix to be displayed in the input."
                 },
-                "attribute": "text-prefix",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "textSuffix": {
                 "type": "string",
+                "attribute": "text-suffix",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -565,11 +631,13 @@ export class CatInput {
                     "tags": [],
                     "text": "A textual suffix to be displayed in the input."
                 },
-                "attribute": "text-suffix",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "readonly": {
                 "type": "boolean",
+                "attribute": "readonly",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -582,12 +650,14 @@ export class CatInput {
                     "tags": [],
                     "text": "The value is not editable."
                 },
-                "attribute": "readonly",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "required": {
                 "type": "boolean",
+                "attribute": "required",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -600,12 +670,14 @@ export class CatInput {
                     "tags": [],
                     "text": "A value is required or must be check for the form to be submittable."
                 },
-                "attribute": "required",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "round": {
                 "type": "boolean",
+                "attribute": "round",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -618,12 +690,14 @@ export class CatInput {
                     "tags": [],
                     "text": "Use round input edges."
                 },
-                "attribute": "round",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "type": {
                 "type": "string",
+                "attribute": "type",
                 "mutable": false,
                 "complexType": {
                     "original": "InputType",
@@ -642,12 +716,14 @@ export class CatInput {
                     "tags": [],
                     "text": "Type of form control."
                 },
-                "attribute": "type",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'text'"
             },
             "value": {
                 "type": "string",
+                "attribute": "value",
                 "mutable": true,
                 "complexType": {
                     "original": "string",
@@ -660,11 +736,13 @@ export class CatInput {
                     "tags": [],
                     "text": "The value of the control."
                 },
-                "attribute": "value",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "errors": {
                 "type": "boolean",
+                "attribute": "errors",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean | string[] | ErrorMap",
@@ -683,11 +761,13 @@ export class CatInput {
                     "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",
@@ -700,12 +780,14 @@ export class CatInput {
                     "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 }",
@@ -717,10 +799,13 @@ export class CatInput {
                 "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",
@@ -733,11 +818,13 @@ export class CatInput {
                     "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
             },
             "timeMaskOptions": {
                 "type": "unknown",
+                "attribute": "time-mask-options",
                 "mutable": false,
                 "complexType": {
                     "original": "FormatTimeMaskOptions",
@@ -755,10 +842,13 @@ export class CatInput {
                 "docs": {
                     "tags": [],
                     "text": "Activates cleave-zen time mask on input"
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "dateMaskOptions": {
                 "type": "unknown",
+                "attribute": "date-mask-options",
                 "mutable": false,
                 "complexType": {
                     "original": "FormatDateMaskOptions",
@@ -776,7 +866,9 @@ export class CatInput {
                 "docs": {
                     "tags": [],
                     "text": "Activates cleave-zen date mask on input"
-                }
+                },
+                "getter": false,
+                "setter": false
             }
         };
     }