Displays a boolean value.
The basic Toggle
usage.
Differentiate states by color.
You can change disabled Toggle
with the property disabled
.
Capture changes in Toggle
.
Attribute | Description | Type | Accepted values | Default |
---|---|---|---|---|
checked | checked or not | boolean | - | - |
initialChecked | checked or not on initial | boolean | - | false |
onChange | change event handler | ToggleEvent | - | - |
type | current type | ToggleTypes | ToggleTypes | default |
disabled | disable toggle | boolean | - | false |
... | native props | LabelHTMLAttributes | 'from', 'name', 'className', ... | - |
interface ToggleEventTarget {
checked: boolean
}
export interface ToggleEvent {
target: ToggleEventTarget
stopPropagation: () => void
preventDefault: () => void
nativeEvent: React.ChangeEvent
}
type ToggleTypes =
| 'default'
| 'primary'
| 'secondary'
| 'success'
| 'warning'
| 'error'
| 'info'
Previous
Textarea
Next
Tooltip