A text area serves as a multi-line, plain-text editing interface.
A text area in a disabled state shows that an input field exists, but is not available in that circumstance. This can be used to maintain layout continuity and communicate that a field may become available later.
The isReadOnly prop makes the text area's text content immutable. Unlike isDisabled, the text area remains focusable and the contents can still be copied. See the MDN docs for more information.
A text area can be displayed in an error state to indicate that the user input is invalid.
A text area can vary in size. The height is determined by the number of rows. Each size has a unique font size, resulting in varying heights across different sizes.
If a visible label isn't specified, an aria-label must be provided to the text area for accessibility. If the field is labeled by a separate element, an aria-labelledby prop must be provided using the ID of the labeling element instead.
A text area can have a description using the HelperMessage component to provide additional context to the user.
A character count can be displayed below the input. The character count is based on the maxLength prop. If the maxLength prop is not set, the character count will not be displayed.
To exceed the max length, set the allowExceedingMaxLength prop to true – default is false. When the character count is displayed, it turns red if the max length is exceeded.
Note: If allowExceedingMaxLength is set, a character count is required to be set as well.
The rows prop can be used to set the height of the text area and should be used in favor of the height prop. One row is equivalent to the height of one line of text.
The minRows prop can be used to set the minimum height of the text area and should be used in favor of the minHeight prop.
Defaults to 3.
The maxRows prop can be used to set the maximum height of the text area and should be used in favor of the maxHeight prop.
It differs from the rows prop in that it will not set the initial height of the text area.
The resizeMode prop can be used to set the resize behavior of the text area.
The default behavior is none, which prevents the user from resizing the text area.
The vertical behavior allows the user to resize the text area vertically.
A ContextualHelp element may be placed next to the label to provide additional information or help about a TextArea.
Use a text area when the expected user input is more than a few words and could span multiple lines. It is commonly used for features like commentary or descriptions. It supports all the same states and functionality as text fields, except for the password functionality. A text area has several unique functionality not included in the text field, like the resize handle, character counter and text formatting tool bar.
True to display the number of remaining allowed characters on the right of the input. Requires a valid value in the "maxLength" prop.
The minimum number of visible text lines.
The maximum number of visible text lines before displaying a scrollbar.
The placeholder text when the TextArea is empty.
See MDN.
See MDN.
If true, the TextArea will take all available width.
This should only be used with the showCharacterCount prop.
If true, the TextArea will allow the text to go over the max length, but it will add an error look to the character count.
The resize mode value of the TextArea. It's equivalent to the CSS resize property.
A ref for the HTML textarea element.
The props for the InputGroup.
The props for the RemainingCharacterCount.
The element to associate the input with. The value of this attribute must be the id of a in the same document.
See MDN.
The inline style for the element. A function may be provided to compute the style based on component state.
Regex pattern that the value of the input must match to be valid. See MDN.
Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.
An enumerated attribute that defines what action label or icon to preset for the enter key on virtual keyboards. See MDN.
Whether the input is disabled.
Whether the input can be selected but not changed by the user.
Whether user input is required on the input before form submission.
Whether the value is invalid.
A function that returns an error message if a given value is invalid.
Validation errors are displayed to the user when the form is submitted
if validationBehavior="native". For realtime validation, use the isInvalid
prop instead.
Whether the element should receive focus on render.
The current value (controlled).
The default value (uncontrolled).
Describes the type of autocomplete functionality the input should provide if any. See MDN.
The maximum number of characters supported by the input. See MDN.
The minimum number of characters required by the input. See MDN.
The type of input to render. See MDN.
Hints at the type of data that might be entered by the user while editing the element or its contents. See MDN.
An attribute that takes as its value a space-separated string that describes what, if any, type of autocomplete functionality the input should provide. See MDN.
An enumerated attribute that defines whether the element may be checked for spelling errors. See MDN.
The name of the input element, used when submitting an HTML form. See MDN.
The CSS className for the element. A function may be provided to compute the class based on component state.
The helper message of the field.
The error message of the field.
The label of the field.
Whether the required state should be shown as an asterisk or a label, which would display (Optional) on all non required field labels.
A Field can vary in size.
A ContextualHelp element to place next to the label.
Handler that is called when the element receives focus.
Handler that is called when the element loses focus.
Handler that is called when the element's focus status changes.
Handler that is called when a key is pressed.
Handler that is called when a key is released.
Handler that is called when the value changes.
Handler that is called when the user copies text. See MDN.
Handler that is called when the user cuts text. See MDN.
Handler that is called when the user pastes text. See MDN.
Handler that is called when a text composition system starts a new text composition session. See MDN.
Handler that is called when a text composition system completes or cancels the current text composition session. See MDN.
Handler that is called when a new character is received in the current text composition session. See MDN.
Handler that is called when text in the input is selected. See MDN.
Handler that is called when the input value is about to be modified. See MDN.
Handler that is called when the input value is modified. See MDN.
A slot name for the component. Slots allow the component to receive props from a parent component.
An explicit null value indicates that the local props completely override all props received from a parent.
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Identifies the element (or elements) whose contents or presence are controlled by the current element.
Defines a string value that labels the current element.
Identifies the element (or elements) that labels the current element.
Identifies the element (or elements) that describes the object.
Identifies the element (or elements) that provide a detailed, extended description for the object.
Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.
The element's unique identifier. See MDN.
Identifies the element that provides an error message for the object.
Coming from Orbiter, you should be aware of the following changes:
is.icon prop has been removed since it is not used in a TextArea.button prop has been removed.wrapperProps no longer exists.validationState has been changed to isInvalid.showCharacterCount has been added.