跳到内容跳到内容

TextareaAPI

React Textarea 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。

演示

导入

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

阅读关于最小化 bundle 大小的指南,了解它们之间的区别。

Props

名称类型默认值描述
color'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
'neutral'

组件的颜色。它支持对该组件有意义的主题颜色。

要了解如何添加您自己的颜色,请查看主题组件—扩展颜色

endDecoratornode-

此输入的尾部装饰。

errorboolfalse

如果为 true,则 input 将指示错误。该 prop 默认为从父 FormControl 组件继承的值(false)。

maxRowsnumber
| string
-

要显示的最大行数。

minRowsnumber
| string
1

要显示的最小行数。

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

组件的大小。

要了解如何向组件添加自定义尺寸,请查看主题组件—扩展尺寸

startDecoratornode-

此输入的首部装饰。

sxArray<func
| object
| bool>
| func
| object
-

允许定义系统覆盖以及其他 CSS 样式的系统属性。

有关更多详细信息,请参阅 `sx` 页面

variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
'outlined'

要使用的全局 variant

要了解如何添加您自己的 variants,请查看主题组件—扩展 variants

ref 被转发到根元素。

主题默认 props

您可以使用 JoyTextarea 通过主题更改此组件的默认 props。

Slots

要了解如何自定义 slot,请查看覆盖组件结构指南。

Slot 名称类名默认组件描述
root.MuiTextarea-root'div'渲染根元素的组件。
textarea.MuiTextarea-textarea'textarea'渲染 textarea 的组件。
startDecorator.MuiTextarea-startDecorator'div'渲染 start decorator 的组件。
endDecorator.MuiTextarea-endDecorator'div'渲染 end decorator 的组件。

CSS 类

这些类名对于使用 CSS 进行样式设置很有用。当触发特定状态时,它们会应用于组件的 slots。

类名规则名称描述
.Mui-disabled如果 disabled={true},则应用于根元素的类名。
.Mui-error如果 error={true},则应用于根元素的状态类。
.Mui-focused如果组件获得焦点,则应用于根元素的类名。
.MuiTextarea-colorContextcolorContext当颜色反转被触发时,应用于根元素的类名。
.MuiTextarea-colorDangercolorDanger如果 color="danger",则应用于根元素的类名。
.MuiTextarea-colorNeutralcolorNeutral如果 color="neutral",则应用于根元素的类名。
.MuiTextarea-colorPrimarycolorPrimary如果 color="primary",则应用于根元素的类名。
.MuiTextarea-colorSuccesscolorSuccess如果 color="success",则应用于根元素的类名。
.MuiTextarea-colorWarningcolorWarning如果 color="warning",则应用于根元素的类名。
.MuiTextarea-formControlformControl如果组件是 FormControl 的后代,则应用于根元素的类名。
.MuiTextarea-sizeLgsizeLg如果 size="lg",则应用于根元素的类名。
.MuiTextarea-sizeMdsizeMd如果 size="md",则应用于根元素的类名。
.MuiTextarea-sizeSmsizeSm如果 size="sm",则应用于根元素的类名。
.MuiTextarea-variantOutlinedvariantOutlined如果 variant="outlined",则应用于根元素的类名。
.MuiTextarea-variantPlainvariantPlain如果 variant="plain",则应用于根元素的类名。
.MuiTextarea-variantSoftvariantSoft如果 variant="soft",则应用于根元素的类名。

您可以使用以下自定义选项之一覆盖组件的样式

源代码

如果您在此页面中找不到所需的信息,请考虑查看组件的实现以获取更多详细信息。