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.
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.
Helper and error text can be used inside of a textarea with the helperText and errorText property. The error text will not be displayed unless the ion-invalid class is added to the ion-textarea. 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.
The textarea counter is text that displays under a textarea to notify the user of how many characters have been entered out of the total that the textarea 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.
A simpler textarea syntax was introduced in Ionic 7.0. This new syntax reduces the boilerplate required to setup an textarea, resolves accessibility issues, and improves the developer experience.
Developers can perform this migration one textarea at a time. While developers can continue using the legacy syntax, we recommend migrating as soon as possible.
Remove ion-label and use the label property on ion-textarea instead. The placement of the label can be configured using the labelPlacement property on ion-textarea.
Move textarea-specific properties from ion-item on to ion-textarea. This includes the counter, counterFormatter, fill, and shape properties.
Remove usages of the helper and error slots on ion-item and use the helperText and errorText properties on ion-textarea instead.
JavaScript
Angular
React
Vue
<!-- Label and Label Position --> <!-- Before --> <ion-item> <ion-labelposition="floating">Label:</ion-label> <ion-textarea></ion-textarea> </ion-item> <!-- After --> <ion-item> <ion-textarealabel="Label:"label-placement="floating"></ion-textarea> </ion-item> <!-- Fill --> <!-- Before --> <ion-itemfill="outline"shape="round"> <ion-labelposition="floating">Label:</ion-label> <ion-textarea></ion-textarea> </ion-item> <!-- After --> <!-- Textareas using `fill` should not be placed in ion-item --> <ion-textareafill="outline"shape="round"label="Label:"label-placement="floating"></ion-textarea> <!-- Textarea-specific features on ion-item --> <!-- Before --> <ion-itemcounter="true"> <ion-labelposition="floating">Label:</ion-label> <ion-textareamaxlength="100"></ion-textarea> <divslot="helper">Enter text</div> <divslot="error">Please enter text</div> </ion-item> <!-- After --> <ion-item> <ion-textarea label="Label:" counter="true" maxlength="100" helper-text="Enter text" error-text="Please enter text" ></ion-textarea> </ion-item>
<!-- Label and Label Position --> <!-- Before --> <ion-item> <ion-labelposition="floating">Label:</ion-label> <ion-textarea></ion-textarea> </ion-item> <!-- After --> <ion-item> <ion-textarealabel="Label:"labelPlacement="floating"></ion-textarea> </ion-item> <!-- Fill --> <!-- Before --> <ion-itemfill="outline"shape="round"> <ion-labelposition="floating">Label:</ion-label> <ion-textarea></ion-textarea> </ion-item> <!-- After --> <!-- Textareas using `fill` should not be placed in ion-item --> <ion-textareafill="outline"shape="round"label="Label:"labelPlacement="floating"></ion-textarea> <!-- Textarea-specific features on ion-item --> <!-- Before --> <ion-item[counter]="true"> <ion-labelposition="floating">Label:</ion-label> <ion-textareamaxlength="100"></ion-textarea> <divslot="helper">Enter text</div> <divslot="error">Please enter text</div> </ion-item> <!-- After --> <ion-item> <ion-textarea label="Label:" [counter]="true" maxlength="100" helperText="Enter text" errorText="Please enter text" ></ion-textarea> </ion-item>
{/* Label and Label Position */} {/* Before */} <IonItem> <IonLabelposition="floating">Label:</IonLabel> <IonTextarea></IonTextarea> </IonItem> {/* After */} <IonItem> <IonTextarealabel="Label:"labelPlacement="floating"></IonTextarea> </IonItem> {/* Fill */} {/* Before */} <IonItemfill="outline"shape="round"> <IonLabelposition="floating">Label:</IonLabel> <IonTextarea></IonTextarea> </IonItem> {/* After */} {/* Textareas using `fill` should not be placed in IonItem */} <IonTextareafill="outline"shape="round"label="Label:"labelPlacement="floating"></IonTextarea> {/* Textarea-specific features on IonItem */} {/* Before */} <IonItemcounter={true}> <IonLabelposition="floating">Label:</IonLabel> <IonTextareamaxlength="100"></IonTextarea> <divslot="helper">Enter text</div> <divslot="error">Please enter text</div> </IonItem> {/* After */} <IonItem> <IonTextarea label="Label:" counter={true} maxlength="100" helperText="Enter text" errorText="Please enter text" ></IonTextarea> </IonItem>
<!-- Label and Label Position --> <!-- Before --> <ion-item> <ion-labelposition="floating">Label:</ion-label> <ion-textarea></ion-textarea> </ion-item> <!-- After --> <ion-item> <ion-textarealabel="Label:"label-placement="floating"></ion-textarea> </ion-item> <!-- Fill --> <!-- Before --> <ion-itemfill="outline"shape="round"> <ion-labelposition="floating">Label:</ion-label> <ion-textarea></ion-textarea> </ion-item> <!-- After --> <!-- Textareas using `fill` should not be placed in ion-item --> <ion-textareafill="outline"shape="round"label="Label:"label-placement="floating"></ion-textarea> <!-- Textarea-specific features on ion-item --> <!-- Before --> <ion-item:counter="true"> <ion-labelposition="floating">Label:</ion-label> <ion-textareamaxlength="100"></ion-textarea> <divslot="helper">Enter text</div> <divslot="error">Please enter text</div> </ion-item> <!-- After --> <ion-item> <ion-textarea label="Label:" :counter="true" maxlength="100" helper-text="Enter text" error-text="Please enter text" ></ion-textarea> </ion-item>
Ionic uses heuristics to detect if an app is using the modern textarea syntax. In some instances, it may be preferable to continue using the legacy syntax. Developers can set the legacy property on ion-textarea to true to force that instance of the textarea to use the legacy syntax.
While not required, this interface can be used in place of the CustomEvent interface for stronger typing with Ionic events emitted from this component.
Indicates 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".
The 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.
Set 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.
If 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.
If 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.