跳转到内容

FormControlLabel API

想要学习更多组件属性和 CSS API,可以查阅 React FormControlLabel 组件的 API 文档。

导入

import FormControlLabel from '@mui/material/FormControlLabel';
// 或
import { FormControlLabel } from '@mui/material';
你可以阅读这个关于最小化捆绑包的指南以了解以上二者的差异。

Drop-in replacement of the Radio, Switch and Checkbox component. Use this component if you want to display an extra label.

组件名称

在主题中,名称“MuiFormControlLabel”可用于提供默认属性(props),或者样式覆盖

属性

原生(Native) 组件的属性也是可用的。

名称类型默认值描述
control*element
A control element. For instance, it can be a Radio, a Switch or a Checkbox.
checkedboolfalse
If true, the component appears selected.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
componentsProps{ typography?: object }{}
The props used for each slot inside.
disabledboolfalse
If true, the control is disabled.
disableTypographyboolfalse
If true, the label is rendered as it is passed without an additional typography node.
inputRefref
Pass a ref to the input element.
labelnode
The text to be used in an enclosing label element.
labelPlacement'bottom'
| 'end'
| 'start'
| 'top'
'end'
The position of the label.
onChangefunc
Callback fired when the state is changed.

Signature:
function(event: object) => void
event: The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean).
slotProps{ typography?: object }{}
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.
valueany
The value of the component.

ref 则会被传递到根元素中。

CSS

规则名称全局类名描述
root.MuiFormControlLabel-rootStyles applied to the root element.
labelPlacementStart.MuiFormControlLabel-labelPlacementStartStyles applied to the root element if labelPlacement="start".
labelPlacementTop.MuiFormControlLabel-labelPlacementTopStyles applied to the root element if labelPlacement="top".
labelPlacementBottom.MuiFormControlLabel-labelPlacementBottomStyles applied to the root element if labelPlacement="bottom".
disabled.Mui-disabledPseudo-class applied to the root element if disabled={true}.
label.MuiFormControlLabel-labelStyles applied to the label's Typography component.
error.Mui-errorState class applied to the root element if error={true}.

您可以使用组件自定义选项对组件进行个性化:

演示项目