TextArea

TextArea enables the user to add longer text to a form. It has textarea, label, and an optional message. It could be disabled or have an error state. The label could be hidden and show if the textarea is required.

Examples

examples

<TextArea
  id="example"
  label="Label"
  name="example"
  validationState="danger"
  validationText="validation failed"
  isRequired
/>

<TextArea id="example" name="example" label="Label" validationState="danger" validationText="validation failed" isRequired />

API

Prop name	Type	Default	Required	Description
`autoResizingMaxHeight`	`number`	`400`	no	Maximum field height with automatic height control
`helperText`	`string`	-	no	Custom helper text
`id`	`string`	-	yes	Textarea and label identification
`isAutoResizing`	`bool`	-	no	Whether is field auto resizing which adjusts its height while typing
`isDisabled`	`bool`	-	no	Whether is field disabled
`isLabelHidden`	`bool`	-	no	Whether is label hidden
`isRequired`	`bool`	-	no	Whether is field required
`label`	`string`	-	no	Label text
`maxLength`	`number`	-	no	Maximum number of characters
`name`	`string`	-	no	Textarea name
`placeholder`	`string`	-	no	Textarea placeholder
`ref`	`ForwardedRef<HTMLTextAreaElement>`	-	no	Textarea element reference
`rows`	`number`	-	no	Number of visible rows
`validationState`	Validation dictionary	-	no	Type of validation state
`validationText`	`string`, `string[]`	-	no	Validation text
`value`	`string`	-	no	Textarea value
`UNSAFE_className`	`string`	-	no	Wrapper custom class name
`UNSAFE_style`	`CSSProperties`	-	no	Wrapper custom style

On this page