Switch API - Joy UI

Switch API - Joy UISkip to contentSkip to content🚀 Influence MUI's 2026 roadmap! Take our latest Developer SurveySearch…

Joy UIv5.0.0-beta.49Getting startedComponentsAPIsAccordionAccordionDetailsAccordionGroupAccordionSummaryAlertAspectRatioAutocompleteAutocompleteListboxAutocompleteOptionAvatarAvatarGroupBadgeBoxBreadcrumbsButtonButtonGroupCardCardActionsCardContentCardCoverCardOverflowCheckboxChipChipDeleteCircularProgressCssBaselineDialogActionsDialogContentDialogTitleDividerDrawerFormControlFormHelperTextFormLabelGridIconButtonInputLinearProgressLinkListListDividerListItemListItemButtonListItemContentListItemDecoratorListSubheaderMenuMenuButtonMenuItemMenuListModalModalCloseModalDialogModalOverflowOptionRadioRadioGroupScopedCssBaselineSelectSheetSkeletonSliderSnackbarStackStepStepButtonStepIndicatorStepperSvgIconSwitchTabTableTabListTabPanelTabsTextareaToggleButtonGroupTooltipTypographyCustomizationIntegrationsMigrationSwitch API

API reference docs for the React Switch component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

SwitchImport

import Switch from '@mui/joy/Switch';
// or
import { Switch } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

PropsView:table

Props of the native component are also available.

NameTypeDefaultDescriptioncheckedbool-

If true, the component is checked.

color'danger'
| 'primary'
| 'success'
| 'warning'
| string'neutral'

The color of the component. It supports those theme colors that make sense for this component.

To learn how to add your own colors, check out Themed components—Extend colors.

componentelementType-

The component used for the root node. Either a string to use a HTML element or a component.

defaultCheckedbool-

The default checked state. Use when the component is not controlled.

disabledbool-

If true, the component is disabled.

endDecoratornode
| func-

The element that appears at the end of the switch.

onChangefunc-

Callback fired when the state is changed.

Signature:function(event: React.ChangeEvent) => voidevent The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).readOnlybool-

If true, the component is read only.

requiredbool-

If true, the input element is required.

size'sm'
| 'md'
| 'lg'
| string'md'

The size of the component.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

slotProps{ action?: func
| object, endDecorator?: func
| object, input?: func
| object, root?: func
| object, startDecorator?: func
| object, thumb?: func
| object, track?: func
| object }{}

The props used for each slot inside.

slots{ action?: elementType, endDecorator?: elementType, input?: elementType, root?: elementType, startDecorator?: elementType, thumb?: elementType, track?: elementType }{}

The components used for each slot inside.

See Slots API below for more details.

startDecoratornode
| func-

The element that appears at the end of the switch.

sxArray| object
| bool>
| func
| object-

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string'solid'

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.Theme default props

You can use JoySwitch to change the default props of this component with the theme.

SlotsView:table

To learn how to customize the slot, check out the Overriding component structure guide.

Slot nameClass nameDefault componentDescriptionroot.MuiSwitch-root'div'The component that renders the root.thumb.MuiSwitch-thumb'span'The component that renders the thumb.action.MuiSwitch-action'div'The component that renders the action.input.MuiSwitch-input'input'The component that renders the input.track.MuiSwitch-track'span'The component that renders the track.startDecorator.MuiSwitch-startDecorator'span'The component that renders the start decorator.endDecorator.MuiSwitch-endDecorator'span'The component that renders the end decorator.CSS classesView:table

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription.Mui-checkedState class applied to the root checked class..Mui-disabledState class applied to the root disabled class..Mui-focusVisibleState class applied to the root element if the switch has visible focus.Mui-readOnlyClass name applied to the root element if the switch is read-only.MuiSwitch-colorContextcolorContextClass name applied to the root element when color inversion is triggered..MuiSwitch-colorDangercolorDangerClass name applied to the root element if color="danger"..MuiSwitch-colorPrimarycolorPrimaryClass name applied to the root element if color="primary"..MuiSwitch-colorSuccesscolorSuccessClass name applied to the root element if color="success"..MuiSwitch-colorWarningcolorWarningClass name applied to the root element if color="warning"..MuiSwitch-sizeLgsizeLgClass name applied to the root element if size="lg"..MuiSwitch-sizeMdsizeMdClass name applied to the root element if size="md"..MuiSwitch-sizeSmsizeSmClass name applied to the root element if size="sm"..MuiSwitch-variantOutlinedvariantOutlinedClass name applied to the root element if variant="outlined"..MuiSwitch-variantSoftvariantSoftClass name applied to the root element if variant="soft"..MuiSwitch-variantSolidvariantSolidClass name applied to the root element if variant="solid".

You can override the style of the component using one of these customization options:

With a global class name. With a rule name as part of the component's styleOverrides property in a custom theme. Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.

Edit this page

Was this page helpful?

SvgIconTab

•

Blog

•

Store

Contents

DemosImportPropscheckedcolorcomponentdefaultCheckeddisabledendDecoratoronChangereadOnlyrequiredsizeslotPropsslotsstartDecoratorsxvariantSlotsrootthumbactioninputtrackstartDecoratorendDecoratorCSS classescheckeddisabledfocusVisiblereadOnlycolorContextcolorDangercolorPrimarycolorSuccesscolorWarningsizeLgsizeMdsizeSmvariantOutlinedvariantSoftvariantSolidSource codeBecome a Diamond sponsorMUI stands in solidarity with Ukraine.Search…