Toggle

Displays a boolean value.

General

The basic Toggle usage.

Preview
See code

Type

Differentiate states by color.

Preview
See code

Disabled

You can change disabled Toggle with the property disabled.

Preview
See code

Get Change

Capture changes in Toggle.

Preview
See code

APIs

Toggle.Props

AttributeDescriptionTypeAccepted valuesDefault
checkedchecked or notboolean--
initialCheckedchecked or not on initialboolean-false
onChangechange event handlerToggleEvent--
typecurrent typeToggleTypesToggleTypesdefault
disableddisable toggleboolean-false
...native propsLabelHTMLAttributes'from', 'name', 'className', ...-

ToggleEvent

interface ToggleEventTarget {
  checked: boolean
}

export interface ToggleEvent {
  target: ToggleEventTarget
  stopPropagation: () => void
  preventDefault: () => void
  nativeEvent: React.ChangeEvent
}

ToggleTypes

type ToggleTypes =
  | 'default'
  | 'primary'
  | 'secondary'
  | 'success'
  | 'warning'
  | 'error'
  | 'info'
Edit this page on GitHub

Previous

Textarea

Next

Tooltip

MADE & DESIGNED WITHBY BRUNO ANDRADE
docs background gradient blue
docs background gradient violet