TextArea

A general purpose muli-line text input field that is used with controlled state manangement.

API Reference

Prop
Type
Default
Description
onChange
React.ChangeEventHandler<HTMLTextAreaElement>
name
string
autoSize
boolean
false
data-test
string
description
string
disabled
boolean
false
errorMessage
string
id
string
isEmpty
(value: string | number) => boolean
isValid
boolean
true
label
string
loading
boolean
maxlength
number
mode
'compact'
onBlur
React.FocusEventHandler<HTMLTextAreaElement>
onFocus
React.FocusEventHandler<HTMLTextAreaElement>
placeholder
string
required
boolean
false
resize
'both' | 'horizontal' | 'vertical' | 'none'
vertical
rows
number
textareaRef
React.Ref<HTMLTextAreaElement>
value
string

Examples

Description & Error Message

Max length

Rows

Disabled

Loading

Autosize

Unlabelled

Compact Mode