Skip to main content
Version: v7 (beta)

ion-input

scoped

The input component is a wrapper to the HTML input element with custom styling and additional functionality. It accepts most of the same properties as the HTML input, but works great on desktop devices and integrates with the keyboard on mobile devices.

Basic Usage

Types

The input component is meant for text type inputs only, such as "text", "password", "email", "number", "search", "tel", and "url". It supports all standard text input events including keyup, keydown, keypress, and more. The default type is "text".

Label Placement

Labels will take up the width of their content by default. Developers can use the labelPlacement property to control how the label is placed relative to the control.

Clear Options

Inputs offer two options for clearing the input based on how you interact with it. The first way is by adding the clearInput property which will show a clear button when the input has a value. The second way is the clearOnEdit property which will clear the input after it has been blurred and then typed in again. Inputs with a type set to "password" will have clearOnEdit enabled by default.

Filled Inputs

Material Design offers filled styles for an input. The fill property on the input can be set to either "solid" or "outline".

Since the fill styles visually defines the input container, inputs that use fill should not be used in ion-item.

Helper & Error Text

Helper and error text can be used inside of an input with the helperText and errorText property. The error text will not be displayed unless the ion-invalid and ion-touched classes are added to the ion-input. This ensures errors are not shown before the user has a chance to enter data.

In Angular, this is done automatically through form validation. In JavaScript, React and Vue, the class needs to be manually added based on your own validation.

Input Counter

The input counter is text that displays under an input to notify the user of how many characters have been entered out of the total that the input will accept. When adding counter, the default behavior is to format the value that gets displayed as inputLength / maxLength. This behavior can be customized by passing in a formatter function to the counterFormatter property.

Filtering User Input

Developers can use the ionInput event to update the input value in response to user input such as a keypress. This is useful for filtering out invalid or unwanted characters.

When storing the value in a state variable, we recommend updating both the state variable and the ion-input component value. This ensures that the state variable and the ion-input component value remain in sync.

Theming

Colors

Setting the color property changes the color palette for each input. On ios mode, this property changes the caret color. On md mode, this property changes the caret color and the highlight/underline color.

CSS Custom Properties

Input uses scoped encapsulation, which means it will automatically scope its CSS by appending each of the styles with an additional class at runtime. Overriding scoped selectors in CSS requires a higher specificity selector. Targeting the ion-input for customization will not work; therefore we recommend adding a class and customizing it that way.

Migrating from Legacy Input Syntax

A simpler input syntax was introduced in Ionic 7.0. This new syntax reduces the boilerplate required to setup an input, resolves accessibility issues, and improves the developer experience.

Developers can perform this migration one input at a time. While developers can continue using the legacy syntax, we recommend migrating as soon as possible.

Using the Modern Syntax

Using the modern syntax involves three steps:

  1. Remove ion-label and use the label property on ion-input instead. The placement of the label can be configured using the labelPlacement property on ion-input.
  2. Move input-specific properties from ion-item on to ion-input. This includes the counter, counterFormatter, fill, and shape properties.
  3. Remove usages of the helper and error slots on ion-item and use the helperText and errorText properties on ion-input instead.
<!-- Label and Label Position -->

<!-- Before -->
<ion-item>
<ion-label position="floating">Email:</ion-label>
<ion-input></ion-input>
</ion-item>

<!-- After -->
<ion-item>
<ion-input label="Email:" label-placement="floating"></ion-input>
</ion-item>


<!-- Fill -->

<!-- Before -->
<ion-item fill="outline" shape="round">
<ion-label position="floating">Email:</ion-label>
<ion-input></ion-input>
</ion-item>

<!-- After -->

<!-- Inputs using `fill` should not be placed in ion-item -->
<ion-input fill="outline" shape="round" label="Email:" label-placement="floating"></ion-input>

<!-- Input-specific features on ion-item -->

<!-- Before -->
<ion-item counter="true">
<ion-label position="floating">Email:</ion-label>
<ion-input maxlength="100"></ion-input>
<div slot="helper">Enter an email</div>
<div slot="error">Please enter a valid email</div>
</ion-item>

<!-- After -->

<!--
Metadata such as counters and helper text should not
be used when an input is in an item/list. If you need to
provide more context on a input, consider using an ion-note
underneath the ion-list.
-->

<ion-input
label="Email:"
counter="true"
maxlength="100"
helper-text="Enter an email"
error-text="Please enter a valid email"
></ion-input>

Using the Legacy Syntax

Ionic uses heuristics to detect if an app is using the modern input syntax. In some instances, it may be preferable to continue using the legacy syntax. Developers can set the legacy property on ion-input to true to force that instance of the input to use the legacy syntax.

Interfaces

InputChangeEventDetail

interface InputChangeEventDetail {
value: string | undefined | null;
}

InputCustomEvent

While not required, this interface can be used in place of the CustomEvent interface for stronger typing with Ionic events emitted from this component.

interface InputCustomEvent extends CustomEvent {
detail: InputChangeEventDetail;
target: HTMLIonInputElement;
}

Properties

accept (deprecated)

DescriptionThis attribute is ignored. Deprecated
Attributeaccept
Typestring | undefined
Defaultundefined

autocapitalize

DescriptionIndicates 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".
Attributeautocapitalize
Typestring
Default'off'

autocomplete

DescriptionIndicates whether the value of the control can be automatically completed by the browser.
Attributeautocomplete
Type"name" | "email" | "tel" | "url" | "on" | "off" | "honorific-prefix" | "given-name" | "additional-name" | "family-name" | "honorific-suffix" | "nickname" | "username" | "new-password" | "current-password" | "one-time-code" | "organization-title" | "organization" | "street-address" | "address-line1" | "address-line2" | "address-line3" | "address-level4" | "address-level3" | "address-level2" | "address-level1" | "country" | "country-name" | "postal-code" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-number" | "cc-exp" | "cc-exp-month" | "cc-exp-year" | "cc-csc" | "cc-type" | "transaction-currency" | "transaction-amount" | "language" | "bday" | "bday-day" | "bday-month" | "bday-year" | "sex" | "tel-country-code" | "tel-national" | "tel-area-code" | "tel-local" | "tel-extension" | "impp" | "photo"
Default'off'

autocorrect

DescriptionWhether auto correction should be enabled when the user is entering/editing the text value.
Attributeautocorrect
Type"off" | "on"
Default'off'

autofocus

DescriptionThis Boolean attribute lets you specify that a form control should have input focus when the page loads.
Attributeautofocus
Typeboolean
Defaultfalse

clearInput

DescriptionIf true, a clear icon will appear in the input when there is a value. Clicking it clears the input.
Attributeclear-input
Typeboolean
Defaultfalse

clearOnEdit

DescriptionIf true, the value will be cleared after focus upon edit. Defaults to true when type is "password", false for all other types.
Attributeclear-on-edit
Typeboolean | undefined
Defaultundefined

color

DescriptionThe color to use from your application's color palette. Default options are: "primary", "secondary", "tertiary", "success", "warning", "danger", "light", "medium", and "dark". For more information on colors, see theming.
Attributecolor
Type"danger" | "dark" | "light" | "medium" | "primary" | "secondary" | "success" | "tertiary" | "warning" | string & Record<never, never> | undefined
Defaultundefined

counter

DescriptionIf 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.
Attributecounter
Typeboolean
Defaultfalse

counterFormatter

DescriptionA callback used to format the counter text. By default the counter text is set to "itemLength / maxLength".
Attributeundefined
Type((inputLength: number, maxLength: number) => string) | undefined
Defaultundefined

debounce

DescriptionSet the amount of time, in milliseconds, to wait to trigger the ionInput event after each keystroke.
Attributedebounce
Typenumber | undefined
Defaultundefined

disabled

DescriptionIf true, the user cannot interact with the input.
Attributedisabled
Typeboolean
Defaultfalse

enterkeyhint

DescriptionA hint to the browser for which enter key to display. Possible values: "enter", "done", "go", "next", "previous", "search", and "send".
Attributeenterkeyhint
Type"done" | "enter" | "go" | "next" | "previous" | "search" | "send" | undefined
Defaultundefined

errorText

DescriptionText that is placed under the input and displayed when an error is detected.
Attributeerror-text
Typestring | undefined
Defaultundefined

fill

DescriptionThe fill for the item. If "solid" the item will have a background. If "outline" the item will be transparent with a border. Only available in md mode.
Attributefill
Type"outline" | "solid" | undefined
Defaultundefined

helperText

DescriptionText that is placed under the input and displayed when no error is detected.
Attributehelper-text
Typestring | undefined
Defaultundefined

inputmode

DescriptionA hint to the browser for which keyboard to display. Possible values: "none", "text", "tel", "url", "email", "numeric", "decimal", and "search".
Attributeinputmode
Type"decimal" | "email" | "none" | "numeric" | "search" | "tel" | "text" | "url" | undefined
Defaultundefined

label

DescriptionThe visible label associated with the input.
Attributelabel
Typestring | undefined
Defaultundefined

labelPlacement

DescriptionWhere 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 ("...").
Attributelabel-placement
Type"end" | "fixed" | "floating" | "stacked" | "start"
Default'start'

legacy

DescriptionSet the legacy property to true to forcibly use the legacy form control markup. Ionic will only opt components in to the modern form markup when they are using either the aria-label attribute or the label property. As a result, the legacy property should only be used as an escape hatch when you want to avoid this automatic opt-in behavior. Note that this property will be removed in an upcoming major release of Ionic, and all form components will be opted-in to using the modern form markup.
Attributelegacy
Typeboolean | undefined
Defaultundefined

max

DescriptionThe maximum value, which must not be less than its minimum (min attribute) value.
Attributemax
Typenumber | string | undefined
Defaultundefined

maxlength

DescriptionIf 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.
Attributemaxlength
Typenumber | undefined
Defaultundefined

min

DescriptionThe minimum value, which must not be greater than its maximum (max attribute) value.
Attributemin
Typenumber | string | undefined
Defaultundefined

minlength

DescriptionIf 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.
Attributeminlength
Typenumber | undefined
Defaultundefined

mode

DescriptionThe mode determines which platform styles to use.
Attributemode
Type"ios" | "md"
Defaultundefined

multiple

DescriptionIf true, the user can enter more than one value. This attribute applies when the type attribute is set to "email", otherwise it is ignored.
Attributemultiple
Typeboolean | undefined
Defaultundefined

name

DescriptionThe name of the control, which is submitted with the form data.
Attributename
Typestring
Defaultthis.inputId

pattern

DescriptionA 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.
Attributepattern
Typestring | undefined
Defaultundefined

placeholder

DescriptionInstructional text that shows before the input has a value. This property applies only when the type property is set to "email", "number", "password", "search", "tel", "text", or "url", otherwise it is ignored.
Attributeplaceholder
Typestring | undefined
Defaultundefined

readonly

DescriptionIf true, the user cannot modify the value.
Attributereadonly
Typeboolean
Defaultfalse

required

DescriptionIf true, the user must fill in a value before submitting a form.
Attributerequired
Typeboolean
Defaultfalse

shape

DescriptionThe shape of the input. If "round" it will have an increased border radius.
Attributeshape
Type"round" | undefined
Defaultundefined

size

DescriptionThe initial size of the control. This value is in pixels unless the value of the type attribute is "text" or "password", in which case it is an integer number of characters. This attribute applies only when the type attribute is set to "text", "search", "tel", "url", "email", or "password", otherwise it is ignored.
Attributesize
Typenumber | undefined
Defaultundefined

spellcheck

DescriptionIf true, the element will have its spelling and grammar checked.
Attributespellcheck
Typeboolean
Defaultfalse

step

DescriptionWorks with the min and max attributes to limit the increments at which a value can be set. Possible values are: "any" or a positive floating point number.
Attributestep
Typestring | undefined
Defaultundefined

type

DescriptionThe type of control to display. The default type is text.
Attributetype
Type"date" | "datetime-local" | "email" | "month" | "number" | "password" | "search" | "tel" | "text" | "time" | "url" | "week"
Default'text'

value

DescriptionThe value of the input.
Attributevalue
Typenull | number | string | undefined
Default''

Events

NameDescription
ionBlurEmitted when the input loses focus.
ionChangeThe ionChange event is fired for <ion-input> elements when the user modifies the element's value. Unlike the ionInput event, the ionChange event is not necessarily fired for each alteration to an element's value.

Depending on the way the users interacts with the element, the ionChange event fires at a different moment: - When the user commits the change explicitly (e.g. by selecting a date from a date picker for <ion-input type="date">, pressing the "Enter" key, etc.). - When the element loses focus after its value has changed: for elements where the user's interaction is typing.
ionFocusEmitted when the input has focus.
ionInputThe ionInput event fires when the value of an <ion-input> element has been changed.

For elements that accept text input (type=text, type=tel, etc.), the interface is InputEvent; for others, the interface is Event. If the input is cleared on edit, the type is null.

Methods

getInputElement

DescriptionReturns the native <input> element used under the hood.
SignaturegetInputElement() => Promise<HTMLInputElement>

setFocus

DescriptionSets focus on the native input in ion-input. Use this method instead of the global input.focus().

Developers who wish to focus an input when a page enters should call setFocus() in the ionViewDidEnter() lifecycle method.
SignaturesetFocus() => Promise<void>

CSS Shadow Parts

No CSS shadow parts available for this component.

CSS Custom Properties

NameDescription
--backgroundBackground of the input
--border-colorColor of the border below the input when using helper text, error text, or counter
--border-radiusRadius of the input
--border-styleStyle of the border below the input when using helper text, error text, or counter
--border-widthWidth of the border below the input when using helper text, error text, or counter
--colorColor of the input text
--highlight-color-focusedThe color of the highlight on the input when focused
--highlight-color-invalidThe color of the highlight on the input when invalid
--highlight-color-validThe color of the highlight on the input when valid
--padding-bottomBottom padding of the input
--padding-endRight padding if direction is left-to-right, and left padding if direction is right-to-left of the input
--padding-startLeft padding if direction is left-to-right, and right padding if direction is right-to-left of the input
--padding-topTop padding of the input
--placeholder-colorColor of the input placeholder text
--placeholder-font-styleFont style of the input placeholder text
--placeholder-font-weightFont weight of the input placeholder text
--placeholder-opacityOpacity of the input placeholder text

Slots

No slots available for this component.