1. Home
  2. Classes
  3. Settings.SettingGroup

new SettingGroup( groupName [, options ] )

Description

Grouping of controls for easier management in settings panels.

Parameters
Name Type Attributes Description
groupName string

title for the group of settings
options object <optional>

additional options for the group

Name Type Attributes Default Description
callback callback <optional>

callback called on settings changed
collapsible boolean <optional>
 true

determines if the group should be collapsible
shown boolean <optional>
 false

determines if the group should be expanded by default
Details

ui/settings/settinggroup.js, line 9

Methods

getElement() → {HTMLElement}

Returns
  • root node for the group.
Details

ui/settings/settinggroup.js, line 57

append( ...nodes ) → {module:Settings.SettingGroup}

Description

Adds multiple nodes to this group.

Parameters
Name Type Attributes Description
nodes HTMLElement | jQuery | module:Settings.SettingField | module:Settings.SettingGroup <repeatable>

list of nodes to add to the group container
Returns
  • returns self for chaining
Details

ui/settings/settinggroup.js, line 64

appendTo( node ) → {module:Settings.SettingGroup}

Description

Appends this node to another

Parameters
Name Type Description
node HTMLElement

node to attach the group to.
Returns
  • returns self for chaining
Details

ui/settings/settinggroup.js, line 87

onChange()

Description

Fires onchange to listeners

Details

ui/settings/settinggroup.js, line 93