Toggle

Contents

• Overview
• Fields
• Simple DB Toggle
• Explicit Getter and Setter
• Common Mistakes

Overview

A toggle stores a boolean value. Use type = "toggle" or type = "checkbox".

Fields

Field	Type	Description
id	string	Stable control id.
key / var	string	DB key for default persistence.
label / text	string	Row label.
description / desc	string	Short explanation.
default	boolean/function	Default value.
getValue / get	function	Explicit value reader.
setValue / set	function	Explicit value writer.
isEnabled	function	Disabled-state gate.
parentCheck	function	Parent enabled-state gate.

Simple DB Toggle

app:RegisterControl("general.core", {
  id = "enabled",
  key = "enabled",
  type = "toggle",
  label = ENABLE or "Enable",
  description = "Enable this feature.",
  default = true,
})

Explicit Getter and Setter

app:RegisterControl("general.core", {
  id = "privateMode",
  type = "toggle",
  label = "Private mode",
  default = false,
  getValue = function()
    return MyAddonPrivateDB.privateMode == true
  end,
  setValue = function(value)
    MyAddonPrivateDB.privateMode = value == true
    MyAddon.RefreshPrivateMode()
  end,
})

Common Mistakes

• Do not store string values like "true" or "false".
• Do not rebuild the settings frame from the setter.
• Use explicit getters/setters for nested DB values.