ion-input

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 Positioning​

Labels will take up the width of their content by default. This positioning can be changed to be a fixed width, stacked, or floating label.

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 when it is inside of an item. The fill property on the item can be set to either "solid" or "outline".

Helper & Error Text​

Helper & error text can be used inside of an item with an input by slotting a note in the "helper" and "error" slots. The error slot will not be displayed unless the ion-invalid class is added to the ion-item. 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.

Item Counter​

The item counter is helper 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​

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.

Interfaces​

InputChangeEventDetail​

interfaceInputChangeEventDetail{
 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.

interfaceInputCustomEventextendsCustomEvent{
 detail: InputChangeEventDetail;
 target: HTMLIonInputElement;
}

Properties​

accept (deprecated)​

autocapitalize​

autocomplete​

autocorrect​

autofocus​

clearInput​

clearOnEdit​

color​

debounce​

disabled​

enterkeyhint​

inputmode​

max​

maxlength​

min​

minlength​

mode​

multiple​

name​

pattern​

placeholder​

readonly​

required​

size​

spellcheck​

step​

type​

value​

Events​

Methods​

getInputElement​

setFocus​

CSS Shadow Parts​

No CSS shadow parts available for this component.

CSS Custom Properties​

Slots​

No slots available for this component.