Geist UI

Toggle

Displays a boolean value.

General

Type

Differentiate states by color.

disabled

get change

APIs

`Toggle.Props`

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', ...`	-

`ToggleEvent`

interface ToggleEventTarget {
  checked: boolean
}

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

`ToggleTypes`

type ToggleTypes = 'default' | 'secondary' | 'success' | 'warning' | 'error'

Contributors