[component]
Dev Mode
Text area
Description
Use the text area form field to allow the user to enter multiple lines of text.
Usage Guidelines
Do
Allow the user to enter multiple lines of text.
Use this when longform text is allowed or needed.
If an error is returned, tell the user why.
If the field is disabled, tell the user why.
Don't
Do not use if the vast majority of inputs will be shorter strings. For example, a name.
Accessibility
The user should be able to use tab to navigate between elements.
Props
Name
Type
Required
Description
onChange
OnChangeCallback
Required
aiSuggestion
AiSuggestionProps
autoComplete
blurOnSubmit
boolean
disabled
boolean
errorText
string
grow
boolean
helperText
string
iconName
IconName
id
string
inputRef
onBlur
OnChangeCallback
onEnter
onFocus
onIconClick
Status
Documentation:
Figma:
Web:
iOS:
Android:
Related
Text field
Examples
TextArea
WithLabelTextArea
Enter a bunch of text
And some subtext
TextAreaDisabled
TextAreaErrored
Enter a bunch of text
There's been an error
And some subtext