ion-textarea
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.
Basic Usage
Autogrow
When the autoGrow property is set to true, the textarea will grow and shrink based on its contents.
Clear on Edit
Setting the clearOnEdit property to true will clear the textarea after it has been blurred and then typed in again.
Theming
Interfaces
TextareaChangeEventDetail
interfaceTextareaChangeEventDetail{
value?:string|null;
}
TextareaCustomEvent
While not required, this interface can be used in place of the CustomEvent interface for stronger typing with Ionic events emitted from this component.
interfaceTextareaCustomEventextendsCustomEvent{
detail: TextareaChangeEventDetail;
target: HTMLIonTextareaElement;
}
Properties
autoGrow
true, the textarea container will grow and shrink based on the contents of the textarea.auto-growbooleanfalseautocapitalize
"off", "none", "on", "sentences", "words", "characters".autocapitalizestring'none'autofocus
autofocusbooleanfalseclearOnEdit
true, the value will be cleared after focus upon edit. Defaults to true when type is "password", false for all other types.clear-on-editbooleanfalsecolor
"primary", "secondary", "tertiary", "success", "warning", "danger", "light", "medium", and "dark". For more information on colors, see theming.color"danger" | "dark" | "light" | "medium" | "primary" | "secondary" | "success" | "tertiary" | "warning" | string | undefinedundefinedcols
colsnumber | undefinedundefineddebounce
ionChange event after each keystroke. This also impacts form bindings such as ngModel or v-model.debouncenumber0disabled
true, the user cannot interact with the textarea.disabledbooleanfalseenterkeyhint
"enter", "done", "go", "next", "previous", "search", and "send".enterkeyhint"done" | "enter" | "go" | "next" | "previous" | "search" | "send" | undefinedundefinedinputmode
"none", "text", "tel", "url", "email", "numeric", "decimal", and "search".inputmode"decimal" | "email" | "none" | "numeric" | "search" | "tel" | "text" | "url" | undefinedundefinedmaxlength
text, email, search, password, tel, or url, this attribute specifies the maximum number of characters that the user can enter.maxlengthnumber | undefinedundefinedminlength
text, email, search, password, tel, or url, this attribute specifies the minimum number of characters that the user can enter.minlengthnumber | undefinedundefinedmode
mode"ios" | "md"undefinedname
namestringthis.inputIdplaceholder
placeholderstring | undefinedundefinedreadonly
true, the user cannot modify the value.readonlybooleanfalserequired
true, the user must fill in a value before submitting a form.requiredbooleanfalserows
rowsnumber | undefinedundefinedspellcheck
true, the element will have its spelling and grammar checked.spellcheckbooleanfalsevalue
valuenull | string | undefined''wrap
wrap"hard" | "off" | "soft" | undefinedundefinedEvents
| Name | Description | Bubbles |
|---|---|---|
ionBlur | Emitted when the input loses focus. | true |
ionChange | Emitted when the input value has changed. | true |
ionFocus | Emitted when the input has focus. | true |
ionInput | Emitted when a keyboard input occurred. | true |
Methods
getInputElement
<textarea> element used under the hood.getInputElement() => Promise<HTMLTextAreaElement>setFocus
textarea in ion-textarea. Use this method instead of the global textarea.focus().setFocus() => Promise<void>CSS Shadow Parts
No CSS shadow parts available for this component.
CSS Custom Properties
| Name | Description |
|---|---|
--background | Background of the textarea |
--border-radius | Border radius of the textarea |
--color | Color of the text |
--padding-bottom | Bottom padding of the textarea |
--padding-end | Right padding if direction is left-to-right, and left padding if direction is right-to-left of the textarea |
--padding-start | Left padding if direction is left-to-right, and right padding if direction is right-to-left of the textarea |
--padding-top | Top padding of the textarea |
--placeholder-color | Color of the placeholder text |
--placeholder-font-style | Style of the placeholder text |
--placeholder-font-weight | Weight of the placeholder text |
--placeholder-opacity | Opacity of the placeholder text |
Slots
No slots available for this component.