Labels should be used to describe the textarea. They can be used visually, and they will also be read out by screen readers when the user is focused on the textarea. This makes it easy for the user to understand the intent of the textarea. Textarea has several ways to assign a label:
label property: used for plaintext labels
label slot: used for custom HTML labels (experimental)
aria-label: used to provide a label for screen readers but adds no visible label
<!-- 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 --> <!-- Metadata such as counters and helper text should not be used when a textarea is in an item/list. If you need to provide more context on a textarea, consider using an ion-note underneath the ion-list. --> <ion-textarea label="Label:" counter="true" maxlength="100" helper-text="Enter text" error-text="Please enter text" ></ion-textarea>
<!-- 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 --> <!-- Metadata such as counters and helper text should not be used when a textarea is in an item/list. If you need to provide more context on a textarea, consider using an ion-note underneath the ion-list. --> <ion-textarea label="Label:" [counter]="true" maxlength="100" helperText="Enter text" errorText="Please enter text" ></ion-textarea>
{/* 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 */} {/* Metadata such as counters and helper text should not be used when a textarea is in an item/list. If you need to provide more context on a textarea, consider using an IonNote underneath the IonList. */} <IonTextarea label="Label:" counter={true} maxlength="100" helperText="Enter text" errorText="Please enter text" ></IonTextarea>
<!-- 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 --> <!-- Metadata such as counters and helper text should not be used when a textarea is in an item/list. If you need to provide more context on a textarea, consider using an ion-note underneath the ion-list. --> <ion-textarea label="Label:" :counter="true" maxlength="100" helper-text="Enter text" error-text="Please enter text" ></ion-textarea>
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.
If true, a character counter will display the ratio of characters used and the total character limit. Developers must also set the maxlength property for the counter to be calculated correctly.
Where to place the label relative to the textarea. "start": The label will appear to the left of the textarea in LTR and to the right in RTL. "end": The label will appear to the right of the textarea in LTR and to the left in RTL. "floating": The label will appear smaller and above the textarea when the textarea is focused or it has a value. Otherwise it will appear on top of the textarea. "stacked": The label will appear smaller and above the textarea regardless even when the textarea is blurred or has no value. "fixed": The label has the same behavior as "start" except it also has a fixed width. Long text will be truncated with ellipses ("...").
Set the legacy property to true to forcibly use the legacy form control markup. Ionic will only opt components in to the modern form markup when they are using either the aria-label attribute or the default slot that contains the label text. As a result, the legacy property should only be used as an escape hatch when you want to avoid this automatic opt-in behavior. Note that this property will be removed in an upcoming major release of Ionic, and all form components will be opted-in to using the modern form markup.
The ionChange event is fired when the user modifies the textarea's value. Unlike the ionInput event, the ionChange event is fired when the element loses focus after its value has been modified.
ionFocus
Emitted when the input has focus.
ionInput
The ionInput event is fired each time the user modifies the textarea's value. Unlike the ionChange event, the ionInput event is fired for each alteration to the textarea's value. This typically happens for each keystroke as the user types.
When clearOnEdit is enabled, the ionInput event will be fired when the user clears the textarea by performing a keydown event.
The label text to associate with the textarea. Use the labelPlacement property to control where the label is placed relative to the textarea. Use this if you need to render a label with custom HTML. (EXPERIMENTAL)