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.

Basic switches

Label

You can provide a label to theSwitch thanks to theFormControlLabel component.

Size

Use thesize prop to change the size of the switch.

Color

Controlled

You can control the switch with thechecked andonChange 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 useCheckboxes 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 theoverrides documentation page.

🎨 If you are looking for inspiration, you can checkMUI Treasury's customization examples.

Label placement

You can change the placement of the label:

When to use

• Checkboxes vs. Switches

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 examplearia-label,aria-labelledby,title) via theinputProps prop.

<Switchvalue="checkedA"inputProps={{'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.

• <FormControl />
• <FormControlLabel />
• <FormGroup />
• <FormLabel />
• <Switch />