Skip to main content

ion-input

scoped

Contents

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.

It 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.

Usage#

<!-- Default Input --><ion-input></ion-input>
<!-- Input with value --><ion-input value="custom"></ion-input>
<!-- Input with placeholder --><ion-input placeholder="Enter Input"></ion-input>
<!-- Input with clear button when there is a value --><ion-input clearInput value="clear me"></ion-input>
<!-- Number type input --><ion-input type="number" value="333"></ion-input>
<!-- Disabled input --><ion-input value="Disabled" disabled></ion-input>
<!-- Readonly input --><ion-input value="Readonly" readonly></ion-input>
<!-- Inputs with labels --><ion-item>  <ion-label>Default Label</ion-label>  <ion-input></ion-input></ion-item>
<ion-item>  <ion-label position="floating">Floating Label</ion-label>  <ion-input></ion-input></ion-item>
<ion-item>  <ion-label position="fixed">Fixed Label</ion-label>  <ion-input></ion-input></ion-item>
<ion-item>  <ion-label position="stacked">Stacked Label</ion-label>  <ion-input></ion-input></ion-item>

Properties#

accept#

DescriptionIf the value of the type attribute is "file", then this attribute will indicate the types of files that the server accepts, otherwise it will be ignored. The value must be a comma-separated list of unique content type specifiers.
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"on" | "off" | "name" | "honorific-prefix" | "given-name" | "additional-name" | "family-name" | "honorific-suffix" | "nickname" | "email" | "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" | "tel-country-code" | "tel-national" | "tel-area-code" | "tel-local" | "tel-extension" | "impp" | "url" | "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
Typestring | undefined
Defaultundefined

debounce#

DescriptionSet the amount of time, in milliseconds, to wait to trigger the ionChange event after each keystroke. This also impacts form bindings such as ngModel or v-model.
Attributedebounce
Typenumber
Default0

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

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

max#

DescriptionThe maximum value, which must not be less than its minimum (min attribute) value.
Attributemax
Typestring | 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
Typestring | 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" or "file", 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.
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

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.
ionChangeEmitted when the value has changed.
ionFocusEmitted when the input has focus.
ionInputEmitted when a keyboard input occurred.

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().
SignaturesetFocus() => Promise<void>

CSS Custom Properties#

NameDescription
--backgroundBackground of the input
--colorColor of the input text
--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
View Source