Create src/page/SampleSettingTab.ts
This commit is contained in:
Jiean Yang
parent
41a415d0c1
commit
2af50b85cf
196
main.ts
196
main.ts
|
|
@ -1,134 +1,114 @@
|
||||||
import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian';
|
import { App, Editor, MarkdownView, Modal, Notice, Plugin } from "obsidian";
|
||||||
|
import { SampleSettingTab } from "./src/page/SampleSettingTab";
|
||||||
|
|
||||||
// Remember to rename these classes and interfaces!
|
// Remember to rename these classes and interfaces!
|
||||||
|
|
||||||
interface MyPluginSettings {
|
interface MyPluginSettings {
|
||||||
mySetting: string;
|
mySetting: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
const DEFAULT_SETTINGS: MyPluginSettings = {
|
const DEFAULT_SETTINGS: MyPluginSettings = {
|
||||||
mySetting: 'default'
|
mySetting: "default",
|
||||||
}
|
};
|
||||||
|
|
||||||
export default class MyPlugin extends Plugin {
|
export default class MyPlugin extends Plugin {
|
||||||
settings: MyPluginSettings;
|
settings: MyPluginSettings;
|
||||||
|
|
||||||
async onload() {
|
async onload() {
|
||||||
await this.loadSettings();
|
await this.loadSettings();
|
||||||
|
|
||||||
// This creates an icon in the left ribbon.
|
// This creates an icon in the left ribbon.
|
||||||
const ribbonIconEl = this.addRibbonIcon('dice', 'Sample Plugin', (evt: MouseEvent) => {
|
const ribbonIconEl = this.addRibbonIcon(
|
||||||
// Called when the user clicks the icon.
|
"dice",
|
||||||
new Notice('This is a notice!');
|
"Sample Plugin",
|
||||||
});
|
(evt: MouseEvent) => {
|
||||||
// Perform additional things with the ribbon
|
// Called when the user clicks the icon.
|
||||||
ribbonIconEl.addClass('my-plugin-ribbon-class');
|
new Notice("This is a notice!");
|
||||||
|
},
|
||||||
|
);
|
||||||
|
// Perform additional things with the ribbon
|
||||||
|
ribbonIconEl.addClass("my-plugin-ribbon-class");
|
||||||
|
|
||||||
// This adds a status bar item to the bottom of the app. Does not work on mobile apps.
|
// This adds a status bar item to the bottom of the app. Does not work on mobile apps.
|
||||||
const statusBarItemEl = this.addStatusBarItem();
|
const statusBarItemEl = this.addStatusBarItem();
|
||||||
statusBarItemEl.setText('Status Bar Text');
|
statusBarItemEl.setText("Status Bar Text");
|
||||||
|
|
||||||
// This adds a simple command that can be triggered anywhere
|
// This adds a simple command that can be triggered anywhere
|
||||||
this.addCommand({
|
this.addCommand({
|
||||||
id: 'open-sample-modal-simple',
|
id: "open-sample-modal-simple",
|
||||||
name: 'Open sample modal (simple)',
|
name: "Open sample modal (simple)",
|
||||||
callback: () => {
|
callback: () => {
|
||||||
new SampleModal(this.app).open();
|
new SampleModal(this.app).open();
|
||||||
}
|
},
|
||||||
});
|
});
|
||||||
// This adds an editor command that can perform some operation on the current editor instance
|
// This adds an editor command that can perform some operation on the current editor instance
|
||||||
this.addCommand({
|
this.addCommand({
|
||||||
id: 'sample-editor-command',
|
id: "sample-editor-command",
|
||||||
name: 'Sample editor command',
|
name: "Sample editor command",
|
||||||
editorCallback: (editor: Editor, view: MarkdownView) => {
|
editorCallback: (editor: Editor, view: MarkdownView) => {
|
||||||
console.log(editor.getSelection());
|
console.log(editor.getSelection());
|
||||||
editor.replaceSelection('Sample Editor Command');
|
editor.replaceSelection("Sample Editor Command");
|
||||||
}
|
},
|
||||||
});
|
});
|
||||||
// This adds a complex command that can check whether the current state of the app allows execution of the command
|
// This adds a complex command that can check whether the current state of the app allows execution of the command
|
||||||
this.addCommand({
|
this.addCommand({
|
||||||
id: 'open-sample-modal-complex',
|
id: "open-sample-modal-complex",
|
||||||
name: 'Open sample modal (complex)',
|
name: "Open sample modal (complex)",
|
||||||
checkCallback: (checking: boolean) => {
|
checkCallback: (checking: boolean) => {
|
||||||
// Conditions to check
|
// Conditions to check
|
||||||
const markdownView = this.app.workspace.getActiveViewOfType(MarkdownView);
|
const markdownView =
|
||||||
if (markdownView) {
|
this.app.workspace.getActiveViewOfType(MarkdownView);
|
||||||
// If checking is true, we're simply "checking" if the command can be run.
|
if (markdownView) {
|
||||||
// If checking is false, then we want to actually perform the operation.
|
// If checking is true, we're simply "checking" if the command can be run.
|
||||||
if (!checking) {
|
// If checking is false, then we want to actually perform the operation.
|
||||||
new SampleModal(this.app).open();
|
if (!checking) {
|
||||||
}
|
new SampleModal(this.app).open();
|
||||||
|
}
|
||||||
|
|
||||||
// This command will only show up in Command Palette when the check function returns true
|
// This command will only show up in Command Palette when the check function returns true
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
// This adds a settings tab so the user can configure various aspects of the plugin
|
// This adds a settings tab so the user can configure various aspects of the plugin
|
||||||
this.addSettingTab(new SampleSettingTab(this.app, this));
|
this.addSettingTab(new SampleSettingTab(this.app, this));
|
||||||
|
|
||||||
// If the plugin hooks up any global DOM events (on parts of the app that doesn't belong to this plugin)
|
// If the plugin hooks up any global DOM events (on parts of the app that doesn't belong to this plugin)
|
||||||
// Using this function will automatically remove the event listener when this plugin is disabled.
|
// Using this function will automatically remove the event listener when this plugin is disabled.
|
||||||
this.registerDomEvent(document, 'click', (evt: MouseEvent) => {
|
this.registerDomEvent(document, "click", (evt: MouseEvent) => {
|
||||||
console.log('click', evt);
|
console.log("click", evt);
|
||||||
});
|
});
|
||||||
|
|
||||||
// When registering intervals, this function will automatically clear the interval when the plugin is disabled.
|
// When registering intervals, this function will automatically clear the interval when the plugin is disabled.
|
||||||
this.registerInterval(window.setInterval(() => console.log('setInterval'), 5 * 60 * 1000));
|
this.registerInterval(
|
||||||
}
|
window.setInterval(() => console.log("setInterval"), 5 * 60 * 1000),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
onunload() {
|
onunload() {}
|
||||||
|
|
||||||
}
|
async loadSettings() {
|
||||||
|
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
|
||||||
|
}
|
||||||
|
|
||||||
async loadSettings() {
|
async saveSettings() {
|
||||||
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
|
await this.saveData(this.settings);
|
||||||
}
|
}
|
||||||
|
|
||||||
async saveSettings() {
|
|
||||||
await this.saveData(this.settings);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
class SampleModal extends Modal {
|
class SampleModal extends Modal {
|
||||||
constructor(app: App) {
|
constructor(app: App) {
|
||||||
super(app);
|
super(app);
|
||||||
}
|
}
|
||||||
|
|
||||||
onOpen() {
|
onOpen() {
|
||||||
const {contentEl} = this;
|
const { contentEl } = this;
|
||||||
contentEl.setText('Woah!');
|
contentEl.setText("Woah!");
|
||||||
}
|
}
|
||||||
|
|
||||||
onClose() {
|
onClose() {
|
||||||
const {contentEl} = this;
|
const { contentEl } = this;
|
||||||
contentEl.empty();
|
contentEl.empty();
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
class SampleSettingTab extends PluginSettingTab {
|
|
||||||
plugin: MyPlugin;
|
|
||||||
|
|
||||||
constructor(app: App, plugin: MyPlugin) {
|
|
||||||
super(app, plugin);
|
|
||||||
this.plugin = plugin;
|
|
||||||
}
|
|
||||||
|
|
||||||
display(): void {
|
|
||||||
const {containerEl} = this;
|
|
||||||
|
|
||||||
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();
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
import { PluginSettingTab, App, Setting } from "obsidian";
|
||||||
|
import MyPlugin from "./main";
|
||||||
|
|
||||||
|
export class SampleSettingTab extends PluginSettingTab {
|
||||||
|
plugin: MyPlugin;
|
||||||
|
|
||||||
|
constructor(app: App, plugin: MyPlugin) {
|
||||||
|
super(app, plugin);
|
||||||
|
this.plugin = plugin;
|
||||||
|
}
|
||||||
|
|
||||||
|
display(): void {
|
||||||
|
const { containerEl } = this;
|
||||||
|
|
||||||
|
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();
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue