Version: 1.x

ToggleControl

Type: Component

A Control which toggles between an active and inactive state when clicked.

Props#

info

Any unlisted props are passed to the underlying Control instance.

activeTitle#

Type: string|undefined | Default: undefined

The Control title when the control is in an active state.

inactiveTitle#

Type: string|undefined | Default: undefined

The Control title when the control is in an inactive state.

activeIcon#

Type: string|undefined | Default: undefined

The icon to use when the control is in an active state.

inactiveIcon#

Type: string|undefined | Default: undefined

The icon to use when the control is in an inactive state.

isEnabled#

Type: boolean | Default: true

Whether to render the control in the DOM or not.

isActive#

Type: boolean | Default: false

Whether the control is in an active state or not.

Methods#

getControl#

Return Type: Control

The underlying Control instance.

Events#

Control#

Forwards all Control events.