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