@ionic/core 8.8.19 → 8.8.20-dev.11788449221.155f9f1e

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

@@ -1,16 +1,20 @@
 /*!
  * (C) Ionic http://ionicframework.com - MIT License
  */
+import xRegular from "@phosphor-icons/core/assets/regular/x.svg";
 import { Build, Host, forceUpdate, h, } from "@stencil/core";
-import { createNotchController, checkInvalidState } from "../../utils/forms/index";
+import { createClearButtonPressController, createNotchController, checkInvalidState } from "../../utils/forms/index";
 import { inheritAriaAttributes, debounceEvent, inheritAttributes, componentOnReady } from "../../utils/helpers";
+import { printIonWarning } from "../../utils/logging/index";
 import { createSlotMutationController } from "../../utils/slot-mutation-controller";
 import { createColorClasses, hostContext } from "../../utils/theme";
 import { closeCircle, closeSharp } from "ionicons/icons";
-import { getIonMode } from "../../global/ionic-global";
+import { config } from "../../global/config";
+import { getIonTheme } from "../../global/ionic-global";
 import { getCounterText } from "./input.utils";
 /**
- * @virtualProp {"ios" | "md"} mode - The mode determines which platform styles to use.
+ * @virtualProp {"ios" | "md"} mode - The mode determines the platform behaviors of the component.
+ * @virtualProp {"ios" | "md" | "ionic"} theme - The theme determines the visual appearance of the component.
  *
  * @slot label - The label text to associate with the input. Use the `labelPlacement` property to control where the label is placed relative to the input. Use this if you need to render a label with custom HTML. (EXPERIMENTAL)
  * @slot start - Content to display at the leading edge of the input. (EXPERIMENTAL)
@@ -44,6 +48,9 @@ export class Input {
          * Track validation state for proper aria-live announcements
          */
         this.isInvalid = false;
+        /** Keeps the clear button visible for the duration of a press. */
+        this.isClearButtonPressed = false;
+        this.clearButtonPressController = createClearButtonPressController((isPressed) => (this.isClearButtonPressed = isPressed));
         /**
          * 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"`.
@@ -75,15 +82,6 @@ export class Input {
          * 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.
          */
@@ -100,6 +98,11 @@ export class Input {
          * If `true`, the element will have its spelling and grammar checked.
          */
         this.spellcheck = false;
+        /**
+         * The size of the input. If "large", it will have an increased height. By default the
+         * size is medium. This property only applies to the `"ionic"` theme.
+         */
+        this.size = 'medium';
         /**
          * The type of control to display. The default type is text.
          */
@@ -145,6 +148,7 @@ export class Input {
             this.isComposing = false;
         };
         this.clearTextInput = (ev) => {
+            this.clearButtonPressController.release();
             if (this.clearInput && !this.readonly && !this.disabled && ev) {
                 ev.preventDefault();
                 ev.stopPropagation();
@@ -227,6 +231,9 @@ export class Input {
     }
     componentWillLoad() {
         this.inheritedAttributes = Object.assign(Object.assign({}, inheritAriaAttributes(this.el)), inheritAttributes(this.el, ['tabindex', 'title', 'data-form-type', 'dir']));
+        if (this.labelPlacement === undefined) {
+            this.labelPlacement = getIonTheme(this) === 'ionic' ? ionicThemeDefaultLabelPlacement : 'start';
+        }
     }
     connectedCallback() {
         const { el } = this;
@@ -281,6 +288,7 @@ export class Input {
                 detail: this.el,
             }));
         }
+        this.clearButtonPressController.destroy();
         if (this.slotMutationController) {
             this.slotMutationController.destroy();
             this.slotMutationController = undefined;
@@ -355,6 +363,52 @@ export class Input {
     getValue() {
         return typeof this.value === 'number' ? this.value.toString() : (this.value || '').toString();
     }
+    getFill() {
+        const theme = getIonTheme(this);
+        const { fill } = this;
+        if (theme === 'ionic' && fill === undefined) {
+            return 'outline';
+        }
+        return fill;
+    }
+    getLabelPlacement() {
+        const theme = getIonTheme(this);
+        const { el, labelPlacement } = this;
+        if (theme === 'ionic' && labelPlacement !== 'stacked' && labelPlacement !== 'floating') {
+            printIonWarning(`The "${labelPlacement}" label placement is not supported in the ${theme} theme. The default value of "${ionicThemeDefaultLabelPlacement}" will be used instead.`, el);
+            return ionicThemeDefaultLabelPlacement;
+        }
+        return labelPlacement;
+    }
+    // TODO(FW-6201): Remove this method when size is supported in ios and md
+    getSize() {
+        const theme = getIonTheme(this);
+        const { size } = this;
+        if (theme !== 'ionic' && (size === 'large' || size === 'xlarge')) {
+            printIonWarning(`The "${size}" size is not supported in the ${theme} theme.`);
+            // Fallback to medium size, which is the default size for all themes.
+            return 'medium';
+        }
+        return size;
+    }
+    getShape() {
+        const theme = getIonTheme(this);
+        const { shape } = this;
+        // TODO(ROU-5475): Remove the check for `soft` when the shape is supported in ios and md.
+        if ((theme === 'ios' && shape === 'round') || (theme !== 'ionic' && shape === 'soft')) {
+            printIonWarning(`The "${shape}" shape is not supported in the ${theme} theme.`);
+            return undefined;
+        }
+        if (shape !== undefined) {
+            return shape;
+        }
+        // TODO(FW-6229): Update this when the default shape has been decided.
+        if (theme !== 'ionic') {
+            return undefined;
+        }
+        // Fallback to round shape, which is the default shape for the ionic theme.
+        return 'round';
+    }
     checkClearOnEdit(ev) {
         if (!this.shouldClearOnEdit()) {
             return;
@@ -488,9 +542,9 @@ export class Input {
      * when fill="outline".
      */
     renderLabelContainer() {
-        const mode = getIonMode(this);
-        const hasOutlineFill = mode === 'md' && this.fill === 'outline';
-        if (hasOutlineFill) {
+        const theme = getIonTheme(this);
+        const hasOutlineFill = this.fill === 'outline';
+        if (hasOutlineFill && theme === 'md') {
             /**
              * The outline fill has a special outline
              * that appears around the input and the label.
@@ -507,19 +561,47 @@ export class Input {
             ];
         }
         /**
-         * If not using the outline style,
-         * we can render just the label.
+         * If not using the outline style, OR if using the
+         * ionic theme, just render the label. For the ionic
+         * theme, the outline will be rendered elsewhere.
          */
         return this.renderLabel();
     }
+    /**
+     * Get the icon to use for the clear icon.
+     * If an icon is set on the component, use that.
+     * Otherwise, use the icon set in the config.
+     * If no icon is set in the config, use the default icon.
+     *
+     * @internal
+     */
+    get inputClearIcon() {
+        // Return the icon if it is explicitly set
+        if (this.clearInputIcon != null) {
+            return this.clearInputIcon;
+        }
+        // Determine the theme and map to default icons
+        const theme = getIonTheme(this);
+        const defaultIcons = {
+            ios: closeCircle,
+            ionic: xRegular,
+            md: closeSharp,
+        };
+        // Get the default icon based on the theme, falling back to 'md' icon if necessary
+        const defaultIcon = defaultIcons[theme] || defaultIcons.md;
+        // Return the configured input clear icon or the default icon
+        return config.get('inputClearIcon', defaultIcon);
+    }
     render() {
-        const { disabled, fill, readonly, shape, inputId, labelPlacement, el, hasFocus, clearInputIcon } = this;
-        const mode = getIonMode(this);
+        const { disabled, readonly, inputId, el, hasFocus, clearInput, inputClearIcon } = this;
+        const theme = getIonTheme(this);
         const value = this.getValue();
+        const fill = this.getFill();
+        const size = this.getSize();
+        const shape = this.getShape();
         const inItem = hostContext('ion-item', this.el);
-        const shouldRenderHighlight = mode === 'md' && fill !== 'outline' && !inItem;
-        const defaultClearIcon = mode === 'ios' ? closeCircle : closeSharp;
-        const clearIconData = clearInputIcon !== null && clearInputIcon !== void 0 ? clearInputIcon : defaultClearIcon;
+        const shouldRenderHighlight = theme === 'md' && fill !== 'outline' && !inItem;
+        const labelPlacement = this.getLabelPlacement();
         const hasValue = this.hasValue();
         const hasStartEndSlots = el.querySelector('[slot="start"], [slot="end"]') !== null;
         /**
@@ -540,38 +622,48 @@ export class Input {
          * TODO(FW-5592): Remove hasStartEndSlots condition
          */
         const labelShouldFloat = labelPlacement === 'stacked' || (labelPlacement === 'floating' && (hasValue || hasFocus || hasStartEndSlots));
-        return (h(Host, { key: '9ba9cf425b573d2ca9ac34455a0e6b8474c4de6d', class: createColorClasses(this.color, {
-                [mode]: true,
+        return (h(Host, { key: 'f4009568b582fa080103dfb3f490595d5d7e9706', class: createColorClasses(this.color, {
+                [theme]: true,
                 'has-value': hasValue,
                 'has-focus': hasFocus,
                 'label-floating': labelShouldFloat,
                 [`input-fill-${fill}`]: fill !== undefined,
                 [`input-shape-${shape}`]: shape !== undefined,
+                [`input-size-${size}`]: true,
                 [`input-label-placement-${labelPlacement}`]: true,
                 'in-item': inItem,
                 'in-item-color': hostContext('ion-item.ion-color', this.el),
                 'input-disabled': disabled,
-            }) }, h("label", { key: '74b989d0aa5ab38f29f952519868f05119df6005', class: "input-wrapper", htmlFor: inputId, onClick: this.onLabelClick }, this.renderLabelContainer(), h("div", { key: '47f2b42e2f74ea866b4f871026e08ab375d7a726', class: "native-wrapper", onClick: this.onLabelClick }, h("slot", { key: 'eaabe5a4a329a356cac3294d15c087d0d131fff2', name: "start" }), h("input", Object.assign({ key: 'c821a984a8a9b7f96f30892c06d8deda093ff24b', class: "native-input", ref: (input) => (this.nativeInput = input), id: inputId, disabled: disabled, autoCapitalize: this.autocapitalize, autoComplete: this.autocomplete, autoCorrect: this.autocorrect, autoFocus: this.autofocus, enterKeyHint: this.enterkeyhint, inputMode: this.inputmode, min: this.min, max: this.max, minLength: this.minlength, maxLength: this.maxlength, multiple: this.multiple, name: this.name, pattern: this.pattern, placeholder: this.placeholder || '', readOnly: readonly, required: this.required, spellcheck: this.spellcheck, step: this.step, type: this.type, value: value, onInput: this.onInput, onChange: this.onChange, onBlur: this.onBlur, onFocus: this.onFocus, onKeyDown: this.onKeydown, onCompositionstart: this.onCompositionStart, onCompositionend: this.onCompositionEnd, "aria-describedby": this.getHintTextID(), "aria-invalid": this.isInvalid ? 'true' : undefined, "aria-labelledby": this.getLabelledById() }, this.inheritedAttributes)), this.clearInput && !readonly && !disabled && (h("button", { key: '62069c11016ee190dc46ab941372e1c4ad8a36ed', "aria-label": "reset", type: "button", class: "input-clear-icon", onPointerDown: (ev) => {
-                /**
-                 * This prevents mobile browsers from
-                 * blurring the input when the clear
-                 * button is activated.
-                 */
-                ev.preventDefault();
-            }, onClick: this.clearTextInput }, h("ion-icon", { key: 'dd75a516d32110d85382b664c663bd41f177ce12', "aria-hidden": "true", icon: clearIconData }))), h("slot", { key: '330d4b9389f2c62223a5ee24003e96ef3e6b2473', name: "end" })), shouldRenderHighlight && h("div", { key: '8e442bed130ddc84976ab70fd3f8578d6bcc6316', class: "input-highlight" })), this.renderBottomContent()));
+                'input-readonly': readonly,
+            }) }, h("label", { key: 'a05502716afcf5d286f197131619b2bc57ba61e0', class: "input-wrapper", htmlFor: inputId, onClick: this.onLabelClick }, this.renderLabelContainer(), h("div", { key: 'de4621c5eff21e26197f28a3e66217fcae449c75', class: "native-wrapper", onClick: this.onLabelClick }, 
+        /**
+         * For the ionic theme, we render the outline container here
+         * instead of higher up, so it can be positioned relative to
+         * the native wrapper instead of the <label> element or the
+         * entire component. This allows the label text to be positioned
+         * above the outline, while staying within the bounds of the
+         * <label> element, ensuring that clicking the label text
+         * focuses the input.
+         */
+        theme === 'ionic' && h("div", { key: '79e084dd8d7b0f530ea6518ee6f2ceb2ac099a8e', class: "input-outline" }), h("slot", { key: 'a4d0f148035c0f8afca5171139a05665d778bd07', name: "start" }), h("input", Object.assign({ key: 'f399d498b4c289571a114347c08c2ae16266ba6f', class: "native-input", ref: (input) => (this.nativeInput = input), id: inputId, disabled: disabled, autoCapitalize: this.autocapitalize, autoComplete: this.autocomplete, autoCorrect: this.autocorrect, autoFocus: this.autofocus, enterKeyHint: this.enterkeyhint, inputMode: this.inputmode, min: this.min, max: this.max, minLength: this.minlength, maxLength: this.maxlength, multiple: this.multiple, name: this.name, pattern: this.pattern, placeholder: this.placeholder || '', readOnly: readonly, required: this.required, spellcheck: this.spellcheck, step: this.step, type: this.type, value: value, onInput: this.onInput, onChange: this.onChange, onBlur: this.onBlur, onFocus: this.onFocus, onKeyDown: this.onKeydown, onCompositionstart: this.onCompositionStart, onCompositionend: this.onCompositionEnd, "aria-describedby": this.getHintTextID(), "aria-invalid": this.isInvalid ? 'true' : undefined, "aria-labelledby": this.getLabelledById() }, this.inheritedAttributes)), clearInput && !readonly && !disabled && (h("button", { key: 'f6672256dfebae3bae35afd61d26bb705e8f268c', "aria-label": "reset", type: "button", class: {
+                'input-clear-icon': true,
+                'input-clear-button-pressed': this.isClearButtonPressed,
+            }, onPointerDown: this.clearButtonPressController.onPointerDown, onPointerCancel: this.clearButtonPressController.release, onClick: this.clearTextInput }, h("ion-icon", { key: '999e8ec2b4c1614ce8f396b6a3e2ff26cb41dfbd', "aria-hidden": "true", icon: inputClearIcon }))), h("slot", { key: '2d0df6c7dd9dc17d8bd5e33b9eac1e11a25dd874', name: "end" })), shouldRenderHighlight && h("div", { key: 'f80b2c9fe4dfbb038e6c7b5a98e775cdd5ef6a21', class: "input-highlight" })), this.renderBottomContent()));
     }
     static get is() { return "ion-input"; }
     static get encapsulation() { return "scoped"; }
     static get originalStyleUrls() {
         return {
             "ios": ["input.ios.scss"],
-            "md": ["input.md.scss"]
+            "md": ["input.md.scss"],
+            "ionic": ["input.ionic.scss"]
         };
     }
     static get styleUrls() {
         return {
             "ios": ["input.ios.css"],
-            "md": ["input.md.css"]
+            "md": ["input.md.css"],
+            "ionic": ["input.ionic.css"]
         };
     }
     static get properties() {
@@ -873,7 +965,7 @@ export class Input {
                 "optional": true,
                 "docs": {
                     "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."
+                    "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 when the theme is `\"md\"`."
                 },
                 "getter": false,
                 "setter": false,
@@ -939,23 +1031,22 @@ export class Input {
             },
             "labelPlacement": {
                 "type": "string",
-                "mutable": false,
+                "mutable": true,
                 "complexType": {
                     "original": "'start' | 'end' | 'floating' | 'stacked' | 'fixed'",
-                    "resolved": "\"end\" | \"fixed\" | \"floating\" | \"stacked\" | \"start\"",
+                    "resolved": "\"end\" | \"fixed\" | \"floating\" | \"stacked\" | \"start\" | undefined",
                     "references": {}
                 },
                 "required": false,
-                "optional": false,
+                "optional": true,
                 "docs": {
                     "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 (\"...\")."
+                    "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 (\"...\").\n\nDefaults to \"stacked\" for the ionic theme, or \"start\" for all other themes.\n\nIn the ionic theme, only the values \"stacked\" and \"floating\" are supported."
                 },
                 "getter": false,
                 "setter": false,
                 "reflect": false,
-                "attribute": "label-placement",
-                "defaultValue": "'start'"
+                "attribute": "label-placement"
             },
             "max": {
                 "type": "any",
@@ -1154,15 +1245,15 @@ export class Input {
                 "type": "string",
                 "mutable": false,
                 "complexType": {
-                    "original": "'round'",
-                    "resolved": "\"round\" | undefined",
+                    "original": "'soft' | 'round' | 'rectangular'",
+                    "resolved": "\"rectangular\" | \"round\" | \"soft\" | undefined",
                     "references": {}
                 },
                 "required": false,
                 "optional": true,
                 "docs": {
                     "tags": [],
-                    "text": "The shape of the input. If \"round\" it will have an increased border radius."
+                    "text": "Set to `\"soft\"` for an input with slightly rounded corners, `\"round\"` for an input with fully\nrounded corners, or `\"rectangular\"` for an input without rounded corners.\nDefaults to `\"round\"` for the ionic theme, and `undefined` for all other themes.\nOnly applies when the fill is set to `\"solid\"` or `\"outline\"`."
                 },
                 "getter": false,
                 "setter": false,
@@ -1208,6 +1299,26 @@ export class Input {
                 "reflect": false,
                 "attribute": "step"
             },
+            "size": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "'medium' | 'large' | 'xlarge'",
+                    "resolved": "\"large\" | \"medium\" | \"xlarge\" | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": "The size of the input. If \"large\", it will have an increased height. By default the\nsize is medium. This property only applies to the `\"ionic\"` theme."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "attribute": "size",
+                "defaultValue": "'medium'"
+            },
             "type": {
                 "type": "string",
                 "mutable": false,
@@ -1260,7 +1371,8 @@ export class Input {
     static get states() {
         return {
             "hasFocus": {},
-            "isInvalid": {}
+            "isInvalid": {},
+            "isClearButtonPressed": {}
         };
     }
     static get events() {
@@ -1419,3 +1531,4 @@ export class Input {
     }
 }
 let inputIds = 0;
+const ionicThemeDefaultLabelPlacement = 'stacked';