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.

Component 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

color

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.

Type:'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string

Default:'neutral'

endDecorator

Trailing adornment for this input.

Type:node

error

If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.

Type:bool

Default:false

maxRows

Maximum number of rows to display.

Type:number
| string

minRows

Minimum number of rows to display.

Type:number
| string

Default:1

size

The size of the component.

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

Type:'sm'
| 'md'
| 'lg'
| string

Default:'md'

startDecorator

Leading adornment for this input.

Type:node

sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func
| object
| bool>
| func
| object

variant

The global variant to use.

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

Type:'outlined'
| 'plain'
| 'soft'
| 'solid'
| string

Default:'outlined'

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.

root

The component that renders the root.

Class name: .MuiTextarea-root

Default component: 'div'

textarea

The component that renders the textarea.

Class name: .MuiTextarea-textarea

Default component: 'textarea'

startDecorator

The component that renders the start decorator.

Class name: .MuiTextarea-startDecorator

Default component: 'div'

endDecorator

The component that renders the end decorator.

Class name: .MuiTextarea-endDecorator

Default component: 'div'

CSS classes

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

.Mui-disabledSTATE

Class name applied to the root element if disabled={true}.

.Mui-errorSTATE

State class applied to the root element if error={true}.

.Mui-focusedSTATE

Class name applied to the root element if the component is focused.

.MuiTextarea-colorContext

Class name applied to the root element when color inversion is triggered.

Rule name:colorContext

.MuiTextarea-colorDanger

Class name applied to the root element if color="danger".

Rule name:colorDanger

.MuiTextarea-colorNeutral

Class name applied to the root element if color="neutral".

Rule name:colorNeutral

.MuiTextarea-colorPrimary

Class name applied to the root element if color="primary".

Rule name:colorPrimary

.MuiTextarea-colorSuccess

Class name applied to the root element if color="success".

Rule name:colorSuccess

.MuiTextarea-colorWarning

Class name applied to the root element if color="warning".

Rule name:colorWarning

.MuiTextarea-formControl

Class name applied to the root element if the component is a descendant of FormControl.

Rule name:formControl

.MuiTextarea-sizeLg

Class name applied to the root element if size="lg".

Rule name:sizeLg

.MuiTextarea-sizeMd

Class name applied to the root element if size="md".

Rule name:sizeMd

.MuiTextarea-sizeSm

Class name applied to the root element if size="sm".

Rule name:sizeSm

.MuiTextarea-variantOutlined

Class name applied to the root element if variant="outlined".

Rule name:variantOutlined

.MuiTextarea-variantPlain

Class name applied to the root element if variant="plain".

Rule name:variantPlain

.MuiTextarea-variantSoft

Class name applied to the root element if variant="soft".

Rule name:variantSoft


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