DooPage - React UI Kit
Edit page
Getting Started
Theme
Components
AutoComplete
Button
Checkbox
Checkbox
Chip Input
Date Range Input
DateTime Input
Input
Radio
Select
Select Locale
Switch

Switch

Base on https://material-ui.com/components/switches/

Related component

Icon

Basic usage

import { Switch } from '@doopage/react-ui-kit'


const Example = () => <Switch />;


export default Example;

Playground

Basic

With label

Size

With helperText

Label placement

Properties

Prop nameTypeDefaultRequiredDescription
hideboolean | undefined—false
color"info" | "success" | "danger" | "warning" | "primary" | "white" | "rose" | "gray" | undefined—false
helperTextstring | undefined—false
labelstring | undefined—false
stylesany—false
formPropsFormControlLabelProps | undefined—false
labelPlacement"bottom" | "top" | "start" | "end" | undefined—false
titlestring | undefined—false
disabledboolean | undefined—false

If true, the switch will be disabled.

onChange((event: ChangeEvent<HTMLInputElement>, checked: boolean) => void) | undefined—false

Callback fired when the state is changed. @param event 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).

classesPartial<Record<SwitchClassKey, string>> | undefined—false

Override or extend the styles applied to the component.

defaultCheckedboolean | undefined—false
defaultValuestring | number | readonly string[] | undefined—false
suppressContentEditableWarningboolean | undefined—false
suppressHydrationWarningboolean | undefined—false
accessKeystring | undefined—false
classNamestring | undefined—false
contentEditableboolean | "true" | "false" | "inherit" | undefined—false
contextMenustring | undefined—false
dirstring | undefined—false
draggableboolean | "true" | "false" | undefined—false
hiddenboolean | undefined—false
idstring | undefined—false

The id of the input element.

langstring | undefined—false
placeholderstring | undefined—false
slotstring | undefined—false
spellCheckboolean | "true" | "false" | undefined—false
styleCSSProperties | undefined—false
tabIndexnumber | undefined—false
translate"yes" | "no" | undefined—false
radioGroupstring | undefined—false
rolestring | undefined—false
aboutstring | undefined—false
datatypestring | undefined—false
inlistany—false
prefixstring | undefined—false
propertystring | undefined—false
resourcestring | undefined—false
typeofstring | undefined—false
vocabstring | undefined—false
autoCapitalizestring | undefined—false
autoCorrectstring | undefined—false
autoSavestring | undefined—false
itemPropstring | undefined—false
itemScopeboolean | undefined—false
itemTypestring | undefined—false
itemIDstring | undefined—false
itemRefstring | undefined—false
resultsnumber | undefined—false
securitystring | undefined—false
unselectable"on" | "off" | undefined—false
inputMode"none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefined—false

Hints at the type of data that might be entered by the user while editing the element or its contents @see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

isstring | undefined—false

Specify that a standard HTML element should behave like a defined custom built-in element @see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

aria-activedescendantstring | undefined—false

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

aria-atomicboolean | "true" | "false" | undefined—false

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

aria-autocomplete"none" | "inline" | "list" | "both" | undefined—false

Indicates whether inputting text could trigger display of one or more predictions of the user’s intended value for an input and specifies how predictions would be presented if they are made.

aria-busyboolean | "true" | "false" | undefined—false

Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

aria-checkedboolean | "true" | "false" | "mixed" | undefined—false

Indicates the current “checked” state of checkboxes, radio buttons, and other widgets. @see aria-pressed @see aria-selected.

aria-colcountnumber | undefined—false

Defines the total number of columns in a table, grid, or treegrid. @see aria-colindex.

aria-colindexnumber | undefined—false

Defines an element’s column index or position with respect to the total number of columns within a table, grid, or treegrid. @see aria-colcount @see aria-colspan.

aria-colspannumber | undefined—false

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-colindex @see aria-rowspan.

aria-controlsstring | undefined—false

Identifies the element (or elements) whose contents or presence are controlled by the current element. @see aria-owns.

aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | undefined—false

Indicates the element that represents the current item within a container or set of related elements.

aria-describedbystring | undefined—false

Identifies the element (or elements) that describes the object. @see aria-labelledby

aria-detailsstring | undefined—false

Identifies the element that provides a detailed, extended description for the object. @see aria-describedby.

aria-disabledboolean | "true" | "false" | undefined—false

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. @see aria-hidden @see aria-readonly.

aria-dropeffect"none" | "copy" | "execute" | "link" | "move" | "popup" | undefined—false

Indicates what functions can be performed when a dragged object is released on the drop target. @deprecated in ARIA 1.1

aria-errormessagestring | undefined—false

Identifies the element that provides an error message for the object. @see aria-invalid @see aria-describedby.

aria-expandedboolean | "true" | "false" | undefined—false

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

aria-flowtostring | undefined—false

Identifies the next element (or elements) in an alternate reading order of content which, at the user’s discretion, allows assistive technology to override the general default of reading in document source order.

aria-grabbedboolean | "true" | "false" | undefined—false

Indicates an element’s “grabbed” state in a drag-and-drop operation. @deprecated in ARIA 1.1

aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog" | undefined—false

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

aria-hiddenboolean | "true" | "false" | undefined—false

Indicates whether the element is exposed to an accessibility API. @see aria-disabled.

aria-invalidboolean | "true" | "false" | "grammar" | "spelling" | undefined—false

Indicates the entered value does not conform to the format expected by the application. @see aria-errormessage.

aria-keyshortcutsstring | undefined—false

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

aria-labelstring | undefined—false

Defines a string value that labels the current element. @see aria-labelledby.

aria-labelledbystring | undefined—false

Identifies the element (or elements) that labels the current element. @see aria-describedby.

aria-levelnumber | undefined—false

Defines the hierarchical level of an element within a structure.

aria-live"off" | "assertive" | "polite" | undefined—false

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

aria-modalboolean | "true" | "false" | undefined—false

Indicates whether an element is modal when displayed.

aria-multilineboolean | "true" | "false" | undefined—false

Indicates whether a text box accepts multiple lines of input or only a single line.

aria-multiselectableboolean | "true" | "false" | undefined—false

Indicates that the user may select more than one item from the current selectable descendants.

aria-orientation"horizontal" | "vertical" | undefined—false

Indicates whether the element’s orientation is horizontal, vertical, or unknown/ambiguous.

aria-ownsstring | undefined—false

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. @see aria-controls.

aria-placeholderstring | undefined—false

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

aria-posinsetnumber | undefined—false

Defines an element’s number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-setsize.

aria-pressedboolean | "true" | "false" | "mixed" | undefined—false

Indicates the current “pressed” state of toggle buttons. @see aria-checked @see aria-selected.

aria-readonlyboolean | "true" | "false" | undefined—false

Indicates that the element is not editable, but is otherwise operable. @see aria-disabled.

aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined—false

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. @see aria-atomic.

aria-requiredboolean | "true" | "false" | undefined—false

Indicates that user input is required on the element before a form may be submitted.

aria-roledescriptionstring | undefined—false

Defines a human-readable, author-localized description for the role of an element.

aria-rowcountnumber | undefined—false

Defines the total number of rows in a table, grid, or treegrid. @see aria-rowindex.

aria-rowindexnumber | undefined—false

Defines an element’s row index or position with respect to the total number of rows within a table, grid, or treegrid. @see aria-rowcount @see aria-rowspan.

aria-rowspannumber | undefined—false

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-rowindex @see aria-colspan.

aria-selectedboolean | "true" | "false" | undefined—false

Indicates the current “selected” state of various widgets. @see aria-checked @see aria-pressed.

aria-setsizenumber | undefined—false

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-posinset.

aria-sort"none" | "ascending" | "descending" | "other" | undefined—false

Indicates if items in a table or grid are sorted in ascending or descending order.

aria-valuemaxnumber | undefined—false

Defines the maximum allowed value for a range widget.

aria-valueminnumber | undefined—false

Defines the minimum allowed value for a range widget.

aria-valuenownumber | undefined—false

Defines the current value for a range widget. @see aria-valuetext.

aria-valuetextstring | undefined—false

Defines the human readable text alternative of aria-valuenow for a range widget.

dangerouslySetInnerHTML{ __html: string; } | undefined—false
onCopy((event: ClipboardEvent<HTMLButtonElement>) => void) | undefined—false
onCopyCapture((event: ClipboardEvent<HTMLButtonElement>) => void) | undefined—false
onCut((event: ClipboardEvent<HTMLButtonElement>) => void) | undefined—false
onCutCapture((event: ClipboardEvent<HTMLButtonElement>) => void) | undefined—false
onPaste((event: ClipboardEvent<HTMLButtonElement>) => void) | undefined—false
onPasteCapture((event: ClipboardEvent<HTMLButtonElement>) => void) | undefined—false
onCompositionEnd((event: CompositionEvent<HTMLButtonElement>) => void) | undefined—false
onCompositionEndCapture((event: CompositionEvent<HTMLButtonElement>) => void) | undefined—false
onCompositionStart((event: CompositionEvent<HTMLButtonElement>) => void) | undefined—false
onCompositionStartCapture((event: CompositionEvent<HTMLButtonElement>) => void) | undefined—false
onCompositionUpdate((event: CompositionEvent<HTMLButtonElement>) => void) | undefined—false
onCompositionUpdateCapture((event: CompositionEvent<HTMLButtonElement>) => void) | undefined—false
onFocus((event: FocusEvent<HTMLButtonElement>) => void) | undefined—false
onFocusCapture((event: FocusEvent<HTMLButtonElement>) => void) | undefined—false
onBlur((event: FocusEvent<HTMLButtonElement>) => void) | undefined—false
onBlurCapture((event: FocusEvent<HTMLButtonElement>) => void) | undefined—false
onChangeCapture((event: FormEvent<HTMLButtonElement>) => void) | undefined—false
onBeforeInput((event: FormEvent<HTMLButtonElement>) => void) | undefined—false
onBeforeInputCapture((event: FormEvent<HTMLButtonElement>) => void) | undefined—false
onInput((event: FormEvent<HTMLButtonElement>) => void) | undefined—false
onInputCapture((event: FormEvent<HTMLButtonElement>) => void) | undefined—false
onReset((event: FormEvent<HTMLButtonElement>) => void) | undefined—false
onResetCapture((event: FormEvent<HTMLButtonElement>) => void) | undefined—false
onSubmit((event: FormEvent<HTMLButtonElement>) => void) | undefined—false
onSubmitCapture((event: FormEvent<HTMLButtonElement>) => void) | undefined—false
onInvalid((event: FormEvent<HTMLButtonElement>) => void) | undefined—false
onInvalidCapture((event: FormEvent<HTMLButtonElement>) => void) | undefined—false
onLoad((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onLoadCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onError((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onErrorCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onKeyDown((event: KeyboardEvent<HTMLButtonElement>) => void) | undefined—false
onKeyDownCapture((event: KeyboardEvent<HTMLButtonElement>) => void) | undefined—false
onKeyPress((event: KeyboardEvent<HTMLButtonElement>) => void) | undefined—false
onKeyPressCapture((event: KeyboardEvent<HTMLButtonElement>) => void) | undefined—false
onKeyUp((event: KeyboardEvent<HTMLButtonElement>) => void) | undefined—false
onKeyUpCapture((event: KeyboardEvent<HTMLButtonElement>) => void) | undefined—false
onAbort((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onAbortCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onCanPlay((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onCanPlayCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onCanPlayThrough((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onCanPlayThroughCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onDurationChange((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onDurationChangeCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onEmptied((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onEmptiedCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onEncrypted((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onEncryptedCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onEnded((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onEndedCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onLoadedData((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onLoadedDataCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onLoadedMetadata((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onLoadedMetadataCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onLoadStart((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onLoadStartCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onPause((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onPauseCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onPlay((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onPlayCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onPlaying((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onPlayingCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onProgress((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onProgressCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onRateChange((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onRateChangeCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onSeeked((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onSeekedCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onSeeking((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onSeekingCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onStalled((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onStalledCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onSuspend((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onSuspendCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onTimeUpdate((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onTimeUpdateCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onVolumeChange((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onVolumeChangeCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onWaiting((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onWaitingCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onAuxClick((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onAuxClickCapture((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onClick((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onClickCapture((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onContextMenu((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onContextMenuCapture((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onDoubleClick((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onDoubleClickCapture((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onDrag((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDragCapture((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDragEnd((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDragEndCapture((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDragEnter((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDragEnterCapture((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDragExit((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDragExitCapture((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDragLeave((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDragLeaveCapture((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDragOver((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDragOverCapture((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDragStart((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDragStartCapture((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDrop((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onDropCapture((event: DragEvent<HTMLButtonElement>) => void) | undefined—false
onMouseDown((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onMouseDownCapture((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onMouseEnter((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onMouseLeave((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onMouseMove((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onMouseMoveCapture((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onMouseOut((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onMouseOutCapture((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onMouseOver((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onMouseOverCapture((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onMouseUp((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onMouseUpCapture((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined—false
onSelect((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onSelectCapture((event: SyntheticEvent<HTMLButtonElement, Event>) => void) | undefined—false
onTouchCancel((event: TouchEvent<HTMLButtonElement>) => void) | undefined—false
onTouchCancelCapture((event: TouchEvent<HTMLButtonElement>) => void) | undefined—false
onTouchEnd((event: TouchEvent<HTMLButtonElement>) => void) | undefined—false
onTouchEndCapture((event: TouchEvent<HTMLButtonElement>) => void) | undefined—false
onTouchMove((event: TouchEvent<HTMLButtonElement>) => void) | undefined—false
onTouchMoveCapture((event: TouchEvent<HTMLButtonElement>) => void) | undefined—false
onTouchStart((event: TouchEvent<HTMLButtonElement>) => void) | undefined—false
onTouchStartCapture((event: TouchEvent<HTMLButtonElement>) => void) | undefined—false
onPointerDown((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerDownCapture((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerMove((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerMoveCapture((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerUp((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerUpCapture((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerCancel((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerCancelCapture((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerEnter((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerEnterCapture((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerLeave((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerLeaveCapture((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerOver((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerOverCapture((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerOut((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onPointerOutCapture((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onGotPointerCapture((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onGotPointerCaptureCapture((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onLostPointerCapture((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onLostPointerCaptureCapture((event: PointerEvent<HTMLButtonElement>) => void) | undefined—false
onScroll((event: UIEvent<HTMLButtonElement, UIEvent>) => void) | undefined—false
onScrollCapture((event: UIEvent<HTMLButtonElement, UIEvent>) => void) | undefined—false
onWheel((event: WheelEvent<HTMLButtonElement>) => void) | undefined—false
onWheelCapture((event: WheelEvent<HTMLButtonElement>) => void) | undefined—false
onAnimationStart((event: AnimationEvent<HTMLButtonElement>) => void) | undefined—false
onAnimationStartCapture((event: AnimationEvent<HTMLButtonElement>) => void) | undefined—false
onAnimationEnd((event: AnimationEvent<HTMLButtonElement>) => void) | undefined—false
onAnimationEndCapture((event: AnimationEvent<HTMLButtonElement>) => void) | undefined—false
onAnimationIteration((event: AnimationEvent<HTMLButtonElement>) => void) | undefined—false
onAnimationIterationCapture((event: AnimationEvent<HTMLButtonElement>) => void) | undefined—false
onTransitionEnd((event: TransitionEvent<HTMLButtonElement>) => void) | undefined—false
onTransitionEndCapture((event: TransitionEvent<HTMLButtonElement>) => void) | undefined—false
innerRef((instance: any) => void) | RefObject<any> | null | undefined—false
ref((instance: HTMLButtonElement | null) => void) | RefObject<HTMLButtonElement> | null | undefined—false
formstring | undefined—false
size"small" | "medium" | undefined—false

The size of the switch. small is equivalent to the dense switch styling.

valueunknown—false

The value of the component. The DOM API casts this to a string. The browser uses “on” as the default value.

keystring | number | null | undefined—false
autoFocusboolean | undefined—false
formActionstring | undefined—false
formEncTypestring | undefined—false
formMethodstring | undefined—false
formNoValidateboolean | undefined—false
formTargetstring | undefined—false
namestring | undefined—false

Name attribute of the input element.

typestring | undefined—false
disableFocusRippleboolean | undefined—false
action((instance: ButtonBaseActions | null) => void) | RefObject<ButtonBaseActions> | null | undefined—false

A ref for imperative actions. It currently only supports focusVisible() action.

buttonRef((instance: unknown) => void) | RefObject<unknown> | null | undefined—false

@ignore Use that prop to pass a ref to the native button component. @deprecated Use ref instead.

centerRippleboolean | undefined—false

If true, the ripples will be centered. They won’t start at the cursor interaction position.

disableRippleboolean | undefined—false

If true, the ripple effect will be disabled.

disableTouchRippleboolean | undefined—false

If true, the touch ripple effect will be disabled.

focusRippleboolean | undefined—false

If true, the base button will have a keyboard focus ripple.

focusVisibleClassNamestring | undefined—false

This prop can help a person know which element has the keyboard focus. The class name will be applied when the element gain the focus through a keyboard interaction. It’s a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.

onFocusVisible((event: FocusEvent<any>) => void) | undefined—false

Callback fired when the component is focused with a keyboard. We trigger a onFocus callback too.

TouchRipplePropsPartial<TouchRippleProps> | undefined—false

Props applied to the TouchRipple element.

checkedboolean | undefined—false

If true, the component is checked.

checkedIconReactNode—false

The icon to display when the component is checked.

iconReactNode—false

The icon to display when the component is unchecked.

edgefalse | "start" | "end" | undefined—false

If given, uses a negative margin to counteract the padding on one side (this is often helpful for aligning the left or right side of the icon with content above or below, without ruining the border size and shape).

inputPropsInputHTMLAttributes<HTMLInputElement> | undefined—false

Attributes applied to the input element.

inputRef((instance: any) => void) | RefObject<any> | null | undefined—false

Pass a ref to the input element.

readOnlyboolean | undefined—false
requiredboolean | undefined—false

If true, the input element will be required.