Toggle

On/off switch control for binary parameters. Click to switch between two states. Essential for bypass, enable/disable, and mode switching.

Overview

PropertyValue
TypeControl
InteractionClick
StatesOn / Off
Styles4 styles available

Styles

Switch

Classic toggle switch that flips left/right. Most versatile style.

  • Size: 2×1 grid units
  • Best for: Bypass, on/off, enable/disable

Button

Pushbutton that lights up when active. Click to toggle state.

  • Size: 2×2 grid units
  • Best for: Trigger actions, mode selection, prominent toggles

LED

LED indicator that shows on/off state. Compact status display.

  • Size: 1.5×1.5 grid units
  • Best for: Status indicators, small spaces, subtle toggles

Checkbox

Traditional checkbox style familiar from software settings.

  • Size: 1.5×1.5 grid units
  • Best for: Settings, options lists, multiple toggles

Properties

PropertyTypeDefaultDescription
defaultValueboolean-Initial state (true = on)
labelPositionstringbelowleft, right, above, below

Sizes

StyleGrid UnitsNotes
Switch2×1Horizontal, compact
Button2×2Square, prominent
LED1.5×1.5Small, indicator-style
Checkbox1.5×1.5Small, settings-style

When to Use Toggles

Use toggles for:

  • Bypass/enable controls
  • Feature on/off switches
  • Mode A/B selection
  • Sync on/off
  • Any binary (two-state) parameter

Don’t use toggles for:

  • Continuous parameters → use Knob
  • More than 2 options → use multiple toggles or knob with steps

Style Selection Guide

Use CaseRecommended Style
BypassSwitch or Button
Feature enableSwitch
Mode selectionButton (lights up when active)
Status indicatorLED
Settings/optionsCheckbox
Prominent toggleButton
Space-limitedLED or Checkbox

Tips

Bypass Controls

  • Use Switch style for classic bypass
  • Place in consistent location (top-right common)
  • Label clearly: “BYPASS” or “ON/OFF”

Mode Selection (2 modes)

  • Use Button style
  • Active mode lights up
  • Clear labels for each mode

Multiple Toggles

When you have several toggles:

  • Use consistent style for all
  • Align vertically or horizontally
  • Group related toggles together

LED as Status Indicator

LED style works when:

  • User doesn’t need to interact (status only)
  • Space is very limited
  • Showing active state is primary purpose

For mode selection with 3+ options, use multiple button toggles:

[CLEAN] [CRUNCH] [LEAD]
   ✓       ○        ○

Only one active at a time (radio-button behavior).

Example Configurations

Bypass Switch

style: switch
defaultValue: false
labelPosition: right
label: "BYPASS"

Sync Toggle

style: button
defaultValue: true
labelPosition: below
label: "SYNC"

Feature Enable

style: led
defaultValue: false
labelPosition: right
label: "Sidechain"

Label Position Tips

PositionBest For
BelowStandalone toggles
RightHorizontal lists
LeftRight-aligned layouts
AboveBottom-positioned toggles

Keep labels short - one word is ideal:

  • “BYPASS” not “Bypass Effect”
  • “SYNC” not “Sync to Host”
  • “ON” not “Enable Feature”