FormControlLabel

FormControlLabel

The API documentation of the FormControlLabel React component.

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 union: bool |
 string
  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 union: func |
 object
  Use that property to pass a ref callback to the native input component.
label node   The text to be used in an enclosing label element.
labelPlacement enum: 'end' |
 'start'
'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 string   The value of the component.

Any other properties supplied will be spread to the root element (native element).

CSS API

You can override all the class names injected by Material-UI thanks to the classes property. This property accepts the following keys:

Name Description
root Styles applied to the root element.
labelPlacementStart Styles applied to the root element if labelPlacement="start".
disabled Styles applied to the root element if disabled={true}.
label Styles applied to the label's Typography component.

Have a look at overriding with classes section and the implementation of the component for more detail.

If using the overrides key of the theme as documented here, you need to use the following style sheet name: MuiFormControlLabel.

Demos