Setting
Constructors
new Setting()
new Setting(
containerEl):Setting
Parameters
• containerEl: HTMLElement
Returns
Properties
components
components:
BaseComponent[]
controlEl
controlEl:
HTMLElement
descEl
descEl:
HTMLElement
infoEl
infoEl:
HTMLElement
nameEl
nameEl:
HTMLElement
settingEl
settingEl:
HTMLElement
Methods
addButton()
addButton(
cb):this
Parameters
• cb
Returns
this
addColorPicker()
addColorPicker(
cb):this
Parameters
• cb
Returns
this
addDropdown()
addDropdown(
cb):this
Parameters
• cb
Returns
this
addExtraButton()
addExtraButton(
cb):this
Parameters
• cb
Returns
this
addMomentFormat()
addMomentFormat(
cb):this
Parameters
• cb
Returns
this
addProgressBar()
addProgressBar(
cb):this
Parameters
• cb
Returns
this
addSearch()
addSearch(
cb):this
Parameters
• cb
Returns
this
addSlider()
addSlider(
cb):this
Parameters
• cb
Returns
this
addText()
addText(
cb):this
Parameters
• cb
Returns
this
addTextArea()
addTextArea(
cb):this
Parameters
• cb
Returns
this
addToggle()
addToggle(
cb):this
Parameters
• cb
Returns
this
clear()
clear():
this
Returns
this
setClass()
setClass(
cls):this
Parameters
• cls: string
Returns
this
setDesc()
setDesc(
desc):this
Parameters
• desc: string | DocumentFragment
Returns
this
setDisabled()
setDisabled(
disabled):this
Parameters
• disabled: boolean
Returns
this
setHeading()
setHeading():
this
Returns
this
setName()
setName(
name):this
Parameters
• name: string | DocumentFragment
Returns
this
setNoInfo()
setNoInfo():
this
Hide the info section of the setting
Returns
this
setTooltip()
setTooltip(
tooltip,options?):this
Parameters
• tooltip: string
• options?: TooltipOptions
Returns
this
setVisibility()
setVisibility(
visible):this
Shows/hides the setting
Parameters
• visible: boolean
Whether the setting should be visible
Returns
this
then()
then(
cb):this
Facilitates chaining
Parameters
• cb
Returns
this