Skip to content

SettingEx

Extends the Setting class with additional methods for adding components.

Import:

import { SettingEx } from 'obsidian-dev-utils/obsidian/setting-ex';

Signature:

export class SettingEx extends Setting

Extends: Setting

Methods

MethodReturnsDescription
addCheckbox(callback)thisAdds a CheckboxComponent to the setting.
addCodeHighlighter(callback)thisAdds a CodeHighlighterComponent to the setting.
addComponentClass(componentClass, callback)thisAdds a component to the setting.
addDate(callback)thisAdds a DateComponent to the setting.
addDateTime(callback)thisAdds a DateTimeComponent to the setting.
addEmail(callback)thisAdds an EmailComponent to the setting.
addFile(callback)thisAdds a FileComponent to the setting.
addMonth(callback)thisAdds a MonthComponent to the setting.
addMultipleDropdown(callback)thisAdds a MultipleDropdownComponent to the setting.
addMultipleEmail(callback)thisAdds a MultipleEmailComponent to the setting.
addMultipleFile(callback)thisAdds a MultipleFileComponent to the setting.
addMultipleText(callback)thisAdds a MultipleTextComponent to the setting.
addNumber(callback)thisAdds a NumberComponent to the setting.
addPassword(callback)thisAdds a PasswordComponent to the setting.
addTelephone(callback)thisAdds a TelephoneComponent to the setting.
addTime(callback)thisAdds a TimeComponent to the setting.
addTriStateCheckbox(callback)thisAdds a TriStateCheckboxComponent to the setting.
addTypedDropdown(callback)thisAdds a TypedDropdownComponent to the setting.
addTypedMultipleDropdown(callback)thisAdds a TypedMultipleDropdownComponent to the setting.
addUrl(callback)thisAdds an UrlComponent to the setting.
addWeek(callback)thisAdds a WeekComponent to the setting.

Links to this page: