Skip to main content

ion-textarea

scoped

Contents

The textarea component is used for multi-line text input. A native textarea element is rendered inside of the component. The user experience and interactivity of the textarea component is improved by having control over the native textarea.

Unlike the native textarea element, the Ionic textarea does not support loading its value from the inner content. The textarea value should be set in the value attribute.

The textarea component accepts the native textarea attributes in addition to the Ionic properties.

Usage#

<!-- Default textarea --><ion-textarea></ion-textarea>
<!-- Textarea in an item with a placeholder --><ion-item>  <ion-textarea placeholder="Enter more information here..."></ion-textarea></ion-item>
<!-- Textarea in an item with a floating label --><ion-item>  <ion-label position="floating">Description</ion-label>  <ion-textarea></ion-textarea></ion-item>
<!-- Disabled and readonly textarea in an item with a stacked label --><ion-item>  <ion-label position="stacked">Summary</ion-label>  <ion-textarea    disabled    readonly    value="Ionic enables developers to build performant, high-quality mobile apps.">  </ion-textarea></ion-item>
<!-- Textarea that clears the value on edit --><ion-item>  <ion-label>Comment</ion-label>  <ion-textarea clearOnEdit="true"></ion-textarea></ion-item>
<!-- Textarea with custom number of rows and cols --><ion-item>  <ion-label>Notes</ion-label>  <ion-textarea rows="6" cols="20" placeholder="Enter any notes here..."></ion-textarea></ion-item>

Properties#

autoGrow#

DescriptionIf true, the element height will increase based on the value.
Attributeauto-grow
Typeboolean
Defaultfalse

autocapitalize#

DescriptionIndicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.
Attributeautocapitalize
Typestring
Default'none'

autofocus#

DescriptionThis Boolean attribute lets you specify that a form control should have input focus when the page loads.
Attributeautofocus
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
Defaultfalse

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

cols#

DescriptionThe visible width of the text control, in average character widths. If it is specified, it must be a positive integer.
Attributecols
Typenumber | 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 textarea.
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

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

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

name#

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

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

rows#

DescriptionThe number of visible text lines for the control.
Attributerows
Typenumber | undefined
Defaultundefined

spellcheck#

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

value#

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

wrap#

DescriptionIndicates how the control wraps text.
Attributewrap
Type"hard" | "off" | "soft" | undefined
Defaultundefined

Events#

NameDescription
ionBlurEmitted when the input loses focus.
ionChangeEmitted when the input value has changed.
ionFocusEmitted when the input has focus.
ionInputEmitted when a keyboard input occurred.

Methods#

getInputElement#

DescriptionReturns the native <textarea> element used under the hood.
SignaturegetInputElement() => Promise<HTMLTextAreaElement>

setFocus#

DescriptionSets focus on the native textarea in ion-textarea. Use this method instead of the global
textarea.focus().
SignaturesetFocus() => Promise<void>

CSS Custom Properties#

NameDescription
--backgroundBackground of the textarea
--border-radiusBorder radius of the textarea
--colorColor of the text
--padding-bottomBottom padding of the textarea
--padding-endRight padding if direction is left-to-right, and left padding if direction is right-to-left of the textarea
--padding-startLeft padding if direction is left-to-right, and right padding if direction is right-to-left of the textarea
--padding-topTop padding of the textarea
--placeholder-colorColor of the placeholder text
--placeholder-font-styleStyle of the placeholder text
--placeholder-font-weightWeight of the placeholder text
--placeholder-opacityOpacity of the placeholder text