跳转到内容

FormControlLabel API

API documentation for the React FormControlLabel component. Learn about the available props, and the CSS API.

Import

import FormControlLabel from '@mui/material/FormControlLabel';
// 或
import { FormControlLabel } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

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

Component name

The name MuiFormControlLabel can be used when providing default props or style overrides in the theme.

属性

Props of the 原生(Native) component are also available.

名称类型默认值描述
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.
componentsPropsobject{}
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).
sxobject
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

Rule nameGlobal class描述
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.

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

Demos