Skip to content

Textarea API

API reference docs for the React Textarea component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import Textarea from '@mui/joy/Textarea';
// or
import { Textarea } from '@mui/joy';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name JoyTextarea can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
color'danger'
| 'info'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
The color of the component. It supports those theme colors that make sense for this component.
endDecoratornode
Trailing adornment for this input.
errorbool
If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.
maxRowsnumber
| string
Maximum number of rows to display.
minRowsnumber
| string
Minimum number of rows to display.
size'sm'
| 'md'
| 'lg'
| string
The size of the component.
startDecoratornode
Leading adornment for this input.
sxArray<func
| object
| bool>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
The variant to use.

The ref is forwarded to the root element.