@ionic/core 8.5.4-dev.11743804128.16dbb459 → 8.5.4-dev.11743808789.130d15f2

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

@@ -30,6 +30,71 @@ export class Input {
          * Resets when the input loses focus.
          */
         this.didInputClearOnEdit = false;
+        this.hasFocus = false;
+        /**
+         * Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.
+         * Available options: `"off"`, `"none"`, `"on"`, `"sentences"`, `"words"`, `"characters"`.
+         */
+        this.autocapitalize = 'off';
+        /**
+         * Indicates whether the value of the control can be automatically completed by the browser.
+         */
+        this.autocomplete = 'off';
+        /**
+         * Whether auto correction should be enabled when the user is entering/editing the text value.
+         */
+        this.autocorrect = 'off';
+        /**
+         * Sets the [`autofocus` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus) on the native input element.
+         *
+         * This may not be sufficient for the element to be focused on page load. See [managing focus](/docs/developing/managing-focus) for more information.
+         */
+        this.autofocus = false;
+        /**
+         * If `true`, a clear icon will appear in the input when there is a value. Clicking it clears the input.
+         */
+        this.clearInput = false;
+        /**
+         * If `true`, a character counter will display the ratio of characters used and the total character limit. Developers must also set the `maxlength` property for the counter to be calculated correctly.
+         */
+        this.counter = false;
+        /**
+         * If `true`, the user cannot interact with the input.
+         */
+        this.disabled = false;
+        /**
+         * Where to place the label relative to the input.
+         * `"start"`: The label will appear to the left of the input in LTR and to the right in RTL.
+         * `"end"`: The label will appear to the right of the input in LTR and to the left in RTL.
+         * `"floating"`: The label will appear smaller and above the input when the input is focused or it has a value. Otherwise it will appear on top of the input.
+         * `"stacked"`: The label will appear smaller and above the input regardless even when the input is blurred or has no value.
+         * `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("...").
+         */
+        this.labelPlacement = 'start';
+        /**
+         * The name of the control, which is submitted with the form data.
+         */
+        this.name = this.inputId;
+        /**
+         * If `true`, the user cannot modify the value.
+         */
+        this.readonly = false;
+        /**
+         * If `true`, the user must fill in a value before submitting a form.
+         */
+        this.required = false;
+        /**
+         * If `true`, the element will have its spelling and grammar checked.
+         */
+        this.spellcheck = false;
+        /**
+         * The type of control to display. The default type is text.
+         */
+        this.type = 'text';
+        /**
+         * The value of the input.
+         */
+        this.value = '';
         this.onInput = (ev) => {
             const input = ev.target;
             if (input) {
@@ -76,41 +141,6 @@ export class Input {
             this.value = '';
             this.emitInputChange(ev);
         };
-        this.hasFocus = false;
-        this.color = undefined;
-        this.autocapitalize = 'off';
-        this.autocomplete = 'off';
-        this.autocorrect = 'off';
-        this.autofocus = false;
-        this.clearInput = false;
-        this.clearInputIcon = undefined;
-        this.clearOnEdit = undefined;
-        this.counter = false;
-        this.counterFormatter = undefined;
-        this.debounce = undefined;
-        this.disabled = false;
-        this.enterkeyhint = undefined;
-        this.errorText = undefined;
-        this.fill = undefined;
-        this.inputmode = undefined;
-        this.helperText = undefined;
-        this.label = undefined;
-        this.labelPlacement = 'start';
-        this.max = undefined;
-        this.maxlength = undefined;
-        this.min = undefined;
-        this.minlength = undefined;
-        this.multiple = undefined;
-        this.name = this.inputId;
-        this.pattern = undefined;
-        this.placeholder = undefined;
-        this.readonly = false;
-        this.required = false;
-        this.shape = undefined;
-        this.spellcheck = false;
-        this.step = undefined;
-        this.type = 'text';
-        this.value = '';
     }
     debounceChanged() {
         const { ionInput, debounce, originalIonInput } = this;
@@ -471,6 +501,7 @@ export class Input {
         return {
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -489,11 +520,13 @@ export class Input {
                     "tags": [],
                     "text": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
                 },
-                "attribute": "color",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "autocapitalize": {
                 "type": "string",
+                "attribute": "autocapitalize",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -506,12 +539,14 @@ export class Input {
                     "tags": [],
                     "text": "Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.\nAvailable options: `\"off\"`, `\"none\"`, `\"on\"`, `\"sentences\"`, `\"words\"`, `\"characters\"`."
                 },
-                "attribute": "autocapitalize",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'off'"
             },
             "autocomplete": {
                 "type": "string",
+                "attribute": "autocomplete",
                 "mutable": false,
                 "complexType": {
                     "original": "AutocompleteTypes",
@@ -530,12 +565,14 @@ export class Input {
                     "tags": [],
                     "text": "Indicates whether the value of the control can be automatically completed by the browser."
                 },
-                "attribute": "autocomplete",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'off'"
             },
             "autocorrect": {
                 "type": "string",
+                "attribute": "autocorrect",
                 "mutable": false,
                 "complexType": {
                     "original": "'on' | 'off'",
@@ -548,12 +585,14 @@ export class Input {
                     "tags": [],
                     "text": "Whether auto correction should be enabled when the user is entering/editing the text value."
                 },
-                "attribute": "autocorrect",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'off'"
             },
             "autofocus": {
                 "type": "boolean",
+                "attribute": "autofocus",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -566,12 +605,14 @@ export class Input {
                     "tags": [],
                     "text": "Sets the [`autofocus` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus) on the native input element.\n\nThis may not be sufficient for the element to be focused on page load. See [managing focus](/docs/developing/managing-focus) for more information."
                 },
-                "attribute": "autofocus",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "clearInput": {
                 "type": "boolean",
+                "attribute": "clear-input",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -584,12 +625,14 @@ export class Input {
                     "tags": [],
                     "text": "If `true`, a clear icon will appear in the input when there is a value. Clicking it clears the input."
                 },
-                "attribute": "clear-input",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "clearInputIcon": {
                 "type": "string",
+                "attribute": "clear-input-icon",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -602,11 +645,13 @@ export class Input {
                     "tags": [],
                     "text": "The icon to use for the clear button. Only applies when `clearInput` is set to `true`."
                 },
-                "attribute": "clear-input-icon",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "clearOnEdit": {
                 "type": "boolean",
+                "attribute": "clear-on-edit",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -619,11 +664,13 @@ export class Input {
                     "tags": [],
                     "text": "If `true`, the value will be cleared after focus upon edit. Defaults to `true` when `type` is `\"password\"`, `false` for all other types."
                 },
-                "attribute": "clear-on-edit",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "counter": {
                 "type": "boolean",
+                "attribute": "counter",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -636,12 +683,14 @@ export class Input {
                     "tags": [],
                     "text": "If `true`, a character counter will display the ratio of characters used and the total character limit. Developers must also set the `maxlength` property for the counter to be calculated correctly."
                 },
-                "attribute": "counter",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "counterFormatter": {
                 "type": "unknown",
+                "attribute": "counter-formatter",
                 "mutable": false,
                 "complexType": {
                     "original": "(inputLength: number, maxLength: number) => string",
@@ -653,10 +702,13 @@ export class Input {
                 "docs": {
                     "tags": [],
                     "text": "A callback used to format the counter text.\nBy default the counter text is set to \"itemLength / maxLength\".\n\nSee https://ionicframework.com/docs/troubleshooting/runtime#accessing-this\nif you need to access `this` from within the callback."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "debounce": {
                 "type": "number",
+                "attribute": "debounce",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -669,11 +721,13 @@ export class Input {
                     "tags": [],
                     "text": "Set the amount of time, in milliseconds, to wait to trigger the `ionInput` event after each keystroke."
                 },
-                "attribute": "debounce",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "disabled": {
                 "type": "boolean",
+                "attribute": "disabled",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -686,12 +740,14 @@ export class Input {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the input."
                 },
-                "attribute": "disabled",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "false"
             },
             "enterkeyhint": {
                 "type": "string",
+                "attribute": "enterkeyhint",
                 "mutable": false,
                 "complexType": {
                     "original": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'",
@@ -704,11 +760,13 @@ export class Input {
                     "tags": [],
                     "text": "A hint to the browser for which enter key to display.\nPossible values: `\"enter\"`, `\"done\"`, `\"go\"`, `\"next\"`,\n`\"previous\"`, `\"search\"`, and `\"send\"`."
                 },
-                "attribute": "enterkeyhint",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "errorText": {
                 "type": "string",
+                "attribute": "error-text",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -721,11 +779,13 @@ export class Input {
                     "tags": [],
                     "text": "Text that is placed under the input and displayed when an error is detected."
                 },
-                "attribute": "error-text",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "fill": {
                 "type": "string",
+                "attribute": "fill",
                 "mutable": false,
                 "complexType": {
                     "original": "'outline' | 'solid'",
@@ -738,11 +798,13 @@ export class Input {
                     "tags": [],
                     "text": "The fill for the item. If `\"solid\"` the item will have a background. If\n`\"outline\"` the item will be transparent with a border. Only available in `md` mode."
                 },
-                "attribute": "fill",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "inputmode": {
                 "type": "string",
+                "attribute": "inputmode",
                 "mutable": false,
                 "complexType": {
                     "original": "'none' | 'text' | 'tel' | 'url' | 'email' | 'numeric' | 'decimal' | 'search'",
@@ -755,11 +817,13 @@ export class Input {
                     "tags": [],
                     "text": "A hint to the browser for which keyboard to display.\nPossible values: `\"none\"`, `\"text\"`, `\"tel\"`, `\"url\"`,\n`\"email\"`, `\"numeric\"`, `\"decimal\"`, and `\"search\"`."
                 },
-                "attribute": "inputmode",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "helperText": {
                 "type": "string",
+                "attribute": "helper-text",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -772,11 +836,13 @@ export class Input {
                     "tags": [],
                     "text": "Text that is placed under the input and displayed when no error is detected."
                 },
-                "attribute": "helper-text",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "label": {
                 "type": "string",
+                "attribute": "label",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -789,11 +855,13 @@ export class Input {
                     "tags": [],
                     "text": "The visible label associated with the input.\n\nUse this if you need to render a plaintext label.\n\nThe `label` property will take priority over the `label` slot if both are used."
                 },
-                "attribute": "label",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "labelPlacement": {
                 "type": "string",
+                "attribute": "label-placement",
                 "mutable": false,
                 "complexType": {
                     "original": "'start' | 'end' | 'floating' | 'stacked' | 'fixed'",
@@ -806,12 +874,14 @@ export class Input {
                     "tags": [],
                     "text": "Where to place the label relative to the input.\n`\"start\"`: The label will appear to the left of the input in LTR and to the right in RTL.\n`\"end\"`: The label will appear to the right of the input in LTR and to the left in RTL.\n`\"floating\"`: The label will appear smaller and above the input when the input is focused or it has a value. Otherwise it will appear on top of the input.\n`\"stacked\"`: The label will appear smaller and above the input regardless even when the input is blurred or has no value.\n`\"fixed\"`: The label has the same behavior as `\"start\"` except it also has a fixed width. Long text will be truncated with ellipses (\"...\")."
                 },
-                "attribute": "label-placement",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'start'"
             },
             "max": {
                 "type": "any",
+                "attribute": "max",
                 "mutable": false,
                 "complexType": {
                     "original": "string | number",
@@ -824,11 +894,13 @@ export class Input {
                     "tags": [],
                     "text": "The maximum value, which must not be less than its minimum (min attribute) value."
                 },
-                "attribute": "max",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "maxlength": {
                 "type": "number",
+                "attribute": "maxlength",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -841,11 +913,13 @@ export class Input {
                     "tags": [],
                     "text": "If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the maximum number of characters that the user can enter."
                 },
-                "attribute": "maxlength",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "min": {
                 "type": "any",
+                "attribute": "min",
                 "mutable": false,
                 "complexType": {
                     "original": "string | number",
@@ -858,11 +932,13 @@ export class Input {
                     "tags": [],
                     "text": "The minimum value, which must not be greater than its maximum (max attribute) value."
                 },
-                "attribute": "min",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "minlength": {
                 "type": "number",
+                "attribute": "minlength",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -875,11 +951,13 @@ export class Input {
                     "tags": [],
                     "text": "If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the minimum number of characters that the user can enter."
                 },
-                "attribute": "minlength",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "multiple": {
                 "type": "boolean",
+                "attribute": "multiple",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -892,11 +970,13 @@ export class Input {
                     "tags": [],
                     "text": "If `true`, the user can enter more than one value. This attribute applies when the type attribute is set to `\"email\"`, otherwise it is ignored."
                 },
-                "attribute": "multiple",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "name": {
                 "type": "string",
+                "attribute": "name",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -909,12 +989,14 @@ export class Input {
                     "tags": [],
                     "text": "The name of the control, which is submitted with the form data."
                 },
-                "attribute": "name",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "this.inputId"
             },
             "pattern": {
                 "type": "string",
+                "attribute": "pattern",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -927,11 +1009,13 @@ export class Input {
                     "tags": [],
                     "text": "A regular expression that the value is checked against. The pattern must match the entire value, not just some subset. Use the title attribute to describe the pattern to help the user. This attribute applies when the value of the type attribute is `\"text\"`, `\"search\"`, `\"tel\"`, `\"url\"`, `\"email\"`, `\"date\"`, or `\"password\"`, otherwise it is ignored. When the type attribute is `\"date\"`, `pattern` will only be used in browsers that do not support the `\"date\"` input type natively. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/date for more information."
                 },
-                "attribute": "pattern",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "placeholder": {
                 "type": "string",
+                "attribute": "placeholder",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -944,11 +1028,13 @@ export class Input {
                     "tags": [],
                     "text": "Instructional text that shows before the input has a value.\nThis property applies only when the `type` property is set to `\"email\"`,\n`\"number\"`, `\"password\"`, `\"search\"`, `\"tel\"`, `\"text\"`, or `\"url\"`, otherwise it is ignored."
                 },
-                "attribute": "placeholder",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "readonly": {
                 "type": "boolean",
+                "attribute": "readonly",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -961,12 +1047,14 @@ export class Input {
                     "tags": [],
                     "text": "If `true`, the user cannot modify the value."
                 },
-                "attribute": "readonly",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "false"
             },
             "required": {
                 "type": "boolean",
+                "attribute": "required",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -979,12 +1067,14 @@ export class Input {
                     "tags": [],
                     "text": "If `true`, the user must fill in a value before submitting a form."
                 },
-                "attribute": "required",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "shape": {
                 "type": "string",
+                "attribute": "shape",
                 "mutable": false,
                 "complexType": {
                     "original": "'round'",
@@ -997,11 +1087,13 @@ export class Input {
                     "tags": [],
                     "text": "The shape of the input. If \"round\" it will have an increased border radius."
                 },
-                "attribute": "shape",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "spellcheck": {
                 "type": "boolean",
+                "attribute": "spellcheck",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1014,12 +1106,14 @@ export class Input {
                     "tags": [],
                     "text": "If `true`, the element will have its spelling and grammar checked."
                 },
-                "attribute": "spellcheck",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "step": {
                 "type": "string",
+                "attribute": "step",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -1032,11 +1126,13 @@ export class Input {
                     "tags": [],
                     "text": "Works with the min and max attributes to limit the increments at which a value can be set.\nPossible values are: `\"any\"` or a positive floating point number."
                 },
-                "attribute": "step",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "type": {
                 "type": "string",
+                "attribute": "type",
                 "mutable": false,
                 "complexType": {
                     "original": "TextFieldTypes",
@@ -1055,12 +1151,14 @@ export class Input {
                     "tags": [],
                     "text": "The type of control to display. The default type is text."
                 },
-                "attribute": "type",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'text'"
             },
             "value": {
                 "type": "any",
+                "attribute": "value",
                 "mutable": true,
                 "complexType": {
                     "original": "string | number | null",
@@ -1073,7 +1171,8 @@ export class Input {
                     "tags": [],
                     "text": "The value of the input."
                 },
-                "attribute": "value",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "''"
             }