tpl
/
obsidian-sample-plugin
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add `add...Setting` methods

This commit is contained in:
Ryota Ushio 2023-12-15 18:10:14 +09:00 committed by GitHub
parent 6cab764833
commit fd2c12460f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 80 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
src/settings.ts
View File

@ -10,24 +10,93 @@ export const DEFAULT_SETTINGS: MyPluginSettings = {
mySetting: 'default' mySetting: 'default'
} }
// Inspired by https://stackoverflow.com/a/50851710/13613783
export type KeysOfType<Obj, Type> = NonNullable<{ [k in keyof Obj]: Obj[k] extends Type ? k : never }[keyof Obj]>;
export class SampleSettingTab extends PluginSettingTab { export class SampleSettingTab extends PluginSettingTab {
constructor(public plugin: MyPlugin) { constructor(public plugin: MyPlugin) {
super(plugin.app, plugin); super(plugin.app, plugin);
} }
addHeading(heading: string) {
return new Setting(this.containerEl).setName(heading).setHeading();
}
addTextSetting(settingName: KeysOfType<MyPluginSettings, string>) {
return new Setting(this.containerEl)
.addText((text) => {
text.setValue(this.plugin.settings[settingName])
.setPlaceholder(DEFAULT_SETTINGS[settingName])
.onChange(async (value) => {
// @ts-ignore
this.plugin.settings[settingName] = value;
await this.plugin.saveSettings();
});
});
}
addNumberSetting(settingName: KeysOfType<MyPluginSettings, number>) {
return new Setting(this.containerEl)
.addText((text) => {
text.setValue('' + this.plugin.settings[settingName])
.setPlaceholder('' + DEFAULT_SETTINGS[settingName])
.then((text) => text.inputEl.type = "number")
.onChange(async (value) => {
this.plugin.settings[settingName] = value === '' ? DEFAULT_SETTINGS[settingName] : +value;
await this.plugin.saveSettings();
});
});
}
addToggleSetting(settingName: KeysOfType<MyPluginSettings, boolean>, extraOnChange?: (value: boolean) => void) {
return new Setting(this.containerEl)
.addToggle((toggle) => {
toggle.setValue(this.plugin.settings[settingName])
.onChange(async (value) => {
this.plugin.settings[settingName] = value;
await this.plugin.saveSettings();
extraOnChange?.(value);
});
});
}
addDropdowenSetting(settingName: KeysOfType<MyPluginSettings, string>, options: readonly string[], display?: (option: string) => string, extraOnChange?: (value: string) => void) {
return new Setting(this.containerEl)
.addDropdown((dropdown) => {
const displayNames = new Set<string>();
for (const option of options) {
const displayName = display?.(option) ?? option;
if (!displayNames.has(displayName)) {
dropdown.addOption(option, displayName);
displayNames.add(displayName);
}
};
dropdown.setValue(this.plugin.settings[settingName])
.onChange(async (value) => {
// @ts-ignore
this.plugin.settings[settingName] = value;
await this.plugin.saveSettings();
extraOnChange?.(value);
});
});
}
addSliderSetting(settingName: KeysOfType<MyPluginSettings, number>, min: number, max: number, step: number) {
return new Setting(this.containerEl)
.addSlider((slider) => {
slider.setLimits(min, max, step)
.setValue(this.plugin.settings[settingName])
.setDynamicTooltip()
.onChange(async (value) => {
// @ts-ignore
this.plugin.settings[settingName] = value;
await this.plugin.saveSettings();
});
});
}
display(): void { display(): void {
const {containerEl} = this; const {containerEl} = this;
containerEl.empty(); containerEl.empty();
new Setting(containerEl)
.setName('Setting #1')
.setDesc('It\'s a secret')
.addText(text => text
.setPlaceholder('Enter your secret')
.setValue(this.plugin.settings.mySetting)
.onChange(async (value) => {
this.plugin.settings.mySetting = value;
await this.plugin.saveSettings();
}));
} }
} }