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

Import

import Textarea from '@mui/joy/Textarea';
// or
import { Textarea } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

Props

NameTypeDefaultDescription
color'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string		'neutral'

The color of the component. It supports those theme colors that make sense for this component.

To learn how to add your own colors, check out Themed components—Extend colors.

endDecoratornode-

Trailing adornment for this input.

errorboolfalse

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		1

Minimum number of rows to display.

size'sm'
| 'md'
| 'lg'
| string		'md'

The size of the component.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

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		'outlined'

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

You can use JoyTextarea to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

Slot nameClass nameDefault componentDescription
root.MuiTextarea-root'div'The component that renders the root.
textarea.MuiTextarea-textarea'textarea'The component that renders the textarea.
startDecorator.MuiTextarea-startDecorator'div'The component that renders the start decorator.
endDecorator.MuiTextarea-endDecorator'div'The component that renders the end decorator.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.Mui-disabledClass name applied to the root element if disabled={true}.
.Mui-errorState class applied to the root element if error={true}.
.Mui-focusedClass name applied to the root element if the component is focused.
.MuiTextarea-colorContextcolorContextClass name applied to the root element when color inversion is triggered.
.MuiTextarea-colorDangercolorDangerClass name applied to the root element if color="danger".
.MuiTextarea-colorNeutralcolorNeutralClass name applied to the root element if color="neutral".
.MuiTextarea-colorPrimarycolorPrimaryClass name applied to the root element if color="primary".
.MuiTextarea-colorSuccesscolorSuccessClass name applied to the root element if color="success".
.MuiTextarea-colorWarningcolorWarningClass name applied to the root element if color="warning".
.MuiTextarea-formControlformControlClass name applied to the root element if the component is a descendant of FormControl.
.MuiTextarea-sizeLgsizeLgClass name applied to the root element if size="lg".
.MuiTextarea-sizeMdsizeMdClass name applied to the root element if size="md".
.MuiTextarea-sizeSmsizeSmClass name applied to the root element if size="sm".
.MuiTextarea-variantOutlinedvariantOutlinedClass name applied to the root element if variant="outlined".
.MuiTextarea-variantPlainvariantPlainClass name applied to the root element if variant="plain".
.MuiTextarea-variantSoftvariantSoftClass name applied to the root element if variant="soft".

You can override the style of the component using one of these customization options: