Input fields

Input fields are where users enter and edit text. It is usually part of the form components.

Textarea Input

State
Source code

Component props

NameDefault valueTypeIs required?Description
label
stringYesHuman-readable label
hideLabel
booleanNoIs the label hidden? (Usually false)
name
stringNoInput name
helperText
stringNoInformative text to render below input
size
"small" | "medium" | "large"NoSize variant
errorText
stringNoError text relevant to input
className
stringNoCSS class
orientation
"vertical" | "horizontal"NoOrientation of label relative to input
isDisabled
booleanNoIs input disabled?
isReadonly
booleanNoIs input read-only?
isRequired
booleanNoIs input required?
placeholder
stringNoPlaceholder for input
labelColumnStart
1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13NoLabel column's beginning (horizontal orientation only)
labelColumnEnd
1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13NoLabel column's ending (horizontal orientation only)
inputColumnStart
1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13NoInput column's beginning (horizontal orientation only)
inputColumnEnd
1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13NoInput column's ending (horizontal orientation only)
id
stringNoID of input
hasMinimumWidth
booleanNoAssigns a min-width to the input when true
testId
stringNoID for automated testing
backgroundStyle
"transparent" | "filled"NoSet the background style for an input
onChange
ChangeEventHandler<HTMLTextAreaElement>NoChange handler
value
stringNoInput value
rows
numberNoTextarea's rows (height)