Input Text Area (Deprecated)

ui:inputTextArea

Deprecated as of API version 47.0. We recommend migrating to Lightning Web Components and using the lightning-textarea component.

For Use In

Lightning Experience, Experience Builder Sites, Salesforce Mobile App, Lightning Out (Beta), Standalone Lightning App

Deprecation Guidelines

We recommend using Lightning Web Components whenever possible. When migrating to Lightning Web Components, use lightning-textarea.

For more information, see Aura Components in the ui Namespace Are Deprecated.

Usage Overview (Deprecated)

A ui:inputTextArea component represents a multi-line text input control, which is rendered as an HTML textarea tag. To apply Lightning Design System styling, we recommend that you use lightning:textarea instead of ui:inputTextArea.

This is a basic set up of a ui:inputTextArea component.

1<ui:inputTextArea aura:id="comments" label="Comments" value="My comments" rows="5" />

This example results in the following HTML.

1<div class="uiInput uiInputTextArea uiInput--default uiInput--textarea">
2  <label class="uiLabel-left form-element__label uiLabel">
3    <span>Comments</span>
4  </label>
5
6  <textarea class="textarea" cols="20" rows="5"> </textarea>
7</div>

To create forms for Salesforce objects without using Apex controllers, use lightning:inputField with lightning:recordEditForm, or use lightning:recordForm. To create an input field for different data types, use lightning:input.

Note

Attributes

Name	Description	Type	Default
body	The body of the component. In markup, this is everything in the body of the tag.	Aura.Component[]
class	A CSS style to be attached to the component. This style is added in addition to base styles output by the component.	String
cols	The width of the text area, which is defined by the number of characters to display in a single row at a time. Default value is “20”.	Integer	20
disabled	Specifies whether the component should be displayed in a disabled state. Default value is "false".	Boolean	false
errors	The list of errors to be displayed.	Object[]
label	The text of the label component	String
labelClass	The CSS class of the label component	String
maxlength	The maximum number of characters that can be typed into the input field. Corresponds to the maxlength attribute of the rendered HTML textarea element.	Integer
placeholder	The text that is displayed by default.	String
readonly	Specifies whether the text area should be rendered as read-only. Default value is “false”.	Boolean	false
required	Specifies whether the input is required. Default value is "false".	Boolean	false
requiredIndicatorClass	The CSS class of the required indicator component	String
resizable	Specifies whether or not the textarea should be resizable. Defaults to true.	Boolean	true
rows	The height of the text area, which is defined by the number of rows to display at a time. Default value is “2”.	Integer	2
updateOn	Updates the component's value binding if the updateOn attribute is set to the handled event. Default value is "change".	String	change
value	The value currently in the input field.	String

Input Text Area (Deprecated)

Deprecation Guidelines

Usage Overview (Deprecated)

Attributes

Lightning Component Reference

Contents