1. Home
  2. Classes
  3. Settings.Switch

new Switch( name, note, isChecked, onChange [, options ] )

Description

Creates a switch using discord's built in switch.

Parameters
Name Type Attributes Description
name string

name label of the setting
note string

help/note to show underneath or above the setting
isChecked boolean

should switch be checked
onChange callable

callback to perform on setting change, callback receives boolean
options object <optional>

object of options to give to the setting

Name Type Attributes Default Description
disabled boolean <optional>
 false

should the setting be disabled
Details

Settings.SettingField

ui/settings/types/switch.js, line 26

Methods

getElement() → {HTMLElement}

Returns
  • root element for setting
Details

module:Settings.SettingField#getElement

module:Settings.SettingField#getElement

ui/settings/settingfield.js, line 33

onChange()

Description

Fires onchange to listeners

Details

module:Settings.SettingField#onChange

module:Settings.SettingField#onChange

ui/settings/settingfield.js, line 36

onAdded()

Description

Fired when root node added to DOM

Details

module:Settings.SettingField#onAdded

module:Settings.SettingField#onAdded

ui/settings/settingfield.js, line 41

onRemoved()

Description

Fired when root node removed from DOM

Details

module:Settings.SettingField#onRemoved

module:Settings.SettingField#onRemoved

ui/settings/settingfield.js, line 53