SwitchBase

SwitchBase

Props

Name Type Default Description
checked union: bool |
 string
  If true, the component is checked.
checkedIcon * node   The icon to display when the component is checked.
classes object   Override or extend the styles applied to the component. See CSS API below for more details.
disabled bool   If true, the switch will be disabled.
disableRipple bool   If true, the ripple effect will be disabled.
icon * node   The icon to display when the component is unchecked.
id string   The id of the input element.
indeterminate bool   If true, the component appears indeterminate.
indeterminateIcon node   The icon to display when the component is indeterminate.
inputProps object   Attributes applied to the input element.
inputRef union: func |
 object
  Use that property to pass a ref callback to the native input component.
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
type string 'checkbox' The input component property type.
value string   The value of the component.

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

CSS API

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

  • root
  • checked
  • disabled
  • input

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: MuiSwitchBase.

Inheritance

The properties of the IconButton component are also available. You can take advantage of this behavior to target nested components.