Switch
Switches toggle the state of a single setting on or off.
Switches are the preferred way to adjust settings on mobile. The option that the switch controls, as well as the state it's in, should be made clear from the corresponding inline label.
Label
You can provide a label to the
Switch thanks to the
FormControlLabel component.
Size
Use the size prop to change the
size of the switch.
Controlled
You can control the switch with the
checked and
onChange props:
Switches with FormGroup
FormGroup is a helpful wrapper
used to group selection controls components
that provides an easier API. However, you
are encouraged to use
Checkboxes
instead if multiple related controls are
required. (See:
When to use).
Customization
Here are some examples of customizing the component. You can learn more about this in the overrides documentation page.
Off
On
🎨 If you are looking for inspiration, you can check MUI Treasury's customization examples.
Label placement
You can change the placement of the label:
When to use
Accessibility
-
All form controls should have labels,
and this includes radio buttons,
checkboxes, and switches. In most cases,
this is done by using the
<label>element (FormControlLabel). -
When a label can't be used, it's
necessary to add an attribute directly
to the input component. In this case,
you can apply the additional attribute
(for example
aria-label,aria-labelledby,title) via theslotProps.inputprop.
<Switch value="checkedA" slotProps={{ input: { 'aria-label': 'Switch A' } }} />
API
See the documentation below for a complete reference to all of the props and classes available to the components mentioned here.