Toggle

Toggle

new Toggle(initialopt)

Toggle class. Provides generic toggle operations. When status changes to true, 'on' jQuery event is triggered on toggle instance. When status changes to false, 'off' jQuery event is triggered on toggle instance.
Parameters:
Name Type Attributes Description
initial boolean <optional>
The initial status. Default value is false.

Members

status :boolean

The current status.
Type:
  • boolean

Methods

off() → {boolean}

Turns toggle off.
Returns:
previous status.
Type
boolean

on() → {boolean}

Turns toggle on.
Returns:
previous status.
Type
boolean