Skip to content
Edit this page

FormControlLabel API

The API documentation of the FormControlLabel React component. Learn more about the props and the CSS customization points.

import { FormControlLabel } from '@material-ui/core';

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

Props

Name Type Default Description
checked bool If true, the component appears selected.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
control element A control element. For instance, it can be be a Radio, a Switch or a Checkbox.
disabled bool If true, the control will be disabled.
inputRef func
| object		 This prop can be used to pass a ref callback to the input element.
label node The text to be used in an enclosing label element.
labelPlacement 'end'
| 'start'
| 'top'
| 'bottom'		 'end' The position of the label.
name string
onChange func Callback fired when the state is changed.

Signature:
function(event: object, checked: boolean) => void
event: The event source of the callback. You can pull out the new value by accessing event.target.checked.
checked: The checked value of the switch
value any The value of the component.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

  • Style sheet name: MuiFormControlLabel.
  • Style sheet details:
Rule name Global class Description
root MuiFormControlLabel-root Styles applied to the root element.
labelPlacementStart MuiFormControlLabel-labelPlacementStart Styles applied to the root element if labelPlacement="start".
labelPlacementTop MuiFormControlLabel-labelPlacementTop Styles applied to the root element if labelPlacement="top".
labelPlacementBottom MuiFormControlLabel-labelPlacementBottom Styles applied to the root element if labelPlacement="bottom".
disabled Mui-disabled Pseudo-class applied to the root element if disabled={true}.
label MuiFormControlLabel-label Styles applied to the label's Typography component.

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Notes

The component is fully StrictMode compatible.

Demos