跳到主要内容跳到主要内容
🚀 影响 Joy UI 2025 年路线图！参与最新的开发者调查

FormControlAPI

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

演示

导入

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

通过阅读这篇关于最小化 bundle 大小的指南，了解它们之间的区别。

Props

原生组件的 Props 也可用。

名称类型默认值描述
childrennode-

组件的内容。

color'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| 字符串		-

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

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

componentelementType-

用于根节点的组件。可以使用字符串来使用 HTML 元素或组件。

disabledboolfalse

如果 true，子组件将处于禁用状态。

errorboolfalse

如果为 true，子组件将指示错误。

orientation'horizontal'
| 'vertical'		'vertical'

内容方向流。

requiredboolfalse

如果为 true，用户必须在提交所属表单之前为输入指定一个值。如果为 true，星号将出现在 FormLabel 上。

size'sm'
| 'md'
| 'lg'
| 字符串		'md'

组件的大小。

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

slotProps{ root?: func
| object }		{}

用于每个 slot 内部的 props。

slots{ root?: elementType }{}

用于每个 slot 内部的组件。

有关更多详细信息，请参阅下面的 Slots API。

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

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

有关更多详细信息，请参阅 sx 页面。

ref 被转发到根元素。

主题默认 props

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

Slots

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

Slot 名称类名默认组件描述
root.MuiFormControl-root'div'渲染根的组件。

CSS 类

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

类名规则名称描述
.Mui-disabled如果 disabled={true}，则应用于根元素的类名。
.Mui-error如果 error={true}，则应用于根元素的状态类。
.MuiFormControl-colorDangercolorDanger如果 color="danger"，则应用于根元素的类名。
.MuiFormControl-colorNeutralcolorNeutral如果 color="neutral"，则应用于根元素的类名。
.MuiFormControl-colorPrimarycolorPrimary如果 color="primary"，则应用于根元素的类名。
.MuiFormControl-colorSuccesscolorSuccess如果 color="success"，则应用于根元素的类名。
.MuiFormControl-colorWarningcolorWarning如果 color="warning"，则应用于根元素的类名。
.MuiFormControl-horizontalhorizontal如果 orientation="horizontal"，则应用于根元素的类名。
.MuiFormControl-sizeLgsizeLg如果 size="lg"，则应用于根元素的类名。
.MuiFormControl-sizeMdsizeMd如果 size="md"，则应用于根元素的类名。
.MuiFormControl-sizeSmsizeSm如果 size="sm"，则应用于根元素的类名。
.MuiFormControl-verticalvertical如果 orientation="vertical"，则应用于根元素的类名。

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

源代码

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