diff options
| author | lishid <[email protected]> | 2021-10-19 13:34:19 -0400 |
|---|---|---|
| committer | lishid <[email protected]> | 2021-10-19 13:34:58 -0400 |
| commit | 3afc9d78ab809784d8ccf6d17e94c1509330e217 (patch) | |
| tree | 6744ff4b0d179f6b9f497bcc195736ef23cce11a /main.ts | |
| parent | 5f95bce9e1ccfc207addfccd525d6dd93035f20b (diff) | |
| download | ai-pulse-obsidian-plugin-3afc9d78ab809784d8ccf6d17e94c1509330e217.tar.gz ai-pulse-obsidian-plugin-3afc9d78ab809784d8ccf6d17e94c1509330e217.zip | |
Update sample plugin to use ESBuild.
Diffstat (limited to 'main.ts')
| -rw-r--r-- | main.ts | 59 |
1 files changed, 41 insertions, 18 deletions
@@ -1,4 +1,4 @@ -import { App, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian';
+import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian';
interface MyPluginSettings {
mySetting: string;
@@ -12,49 +12,72 @@ export default class MyPlugin extends Plugin { settings: MyPluginSettings;
async onload() {
- console.log('loading plugin');
-
await this.loadSettings();
- this.addRibbonIcon('dice', 'Sample Plugin', () => {
+ // This creates an icon in the left ribbon.
+ let ribbonIconEl = this.addRibbonIcon('dice', 'Sample Plugin', (evt: MouseEvent) => {
+ // Called when the user clicks the icon.
new Notice('This is a notice!');
});
+ // Perform additional things with the ribbon
+ ribbonIconEl.addClass('my-plugin-ribbon-class');
- this.addStatusBarItem().setText('Status Bar Text');
+ // This adds a status bar item to the bottom of the app. Does not work on mobile apps.
+ let statusBarItemEl = this.addStatusBarItem();
+ statusBarItemEl.setText('Status Bar Text');
+ // This adds a simple command that can be triggered anywhere
+ this.addCommand({
+ id: 'open-sample-modal-simple',
+ name: 'Open sample modal (simple)',
+ callback: () => {
+ new SampleModal(this.app).open();
+ }
+ });
+ // This adds an editor command that can perform some operation on the current editor instance
this.addCommand({
- id: 'open-sample-modal',
- name: 'Open Sample Modal',
- // callback: () => {
- // console.log('Simple Callback');
- // },
+ id: 'sample-editor-command',
+ name: 'Sample editor command',
+ editorCallback: (editor: Editor, view: MarkdownView) => {
+ console.log(editor.getSelection());
+ 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.addCommand({
+ id: 'open-sample-modal-complex',
+ name: 'Open sample modal (complex)',
checkCallback: (checking: boolean) => {
- let leaf = this.app.workspace.activeLeaf;
- if (leaf) {
+ // Conditions to check
+ let markdownView = this.app.workspace.getActiveViewOfType(MarkdownView);
+ if (markdownView) {
+ // If checking is true, we're simply "checking" if the command can be run.
+ // If checking is false, then we want to actually perform the operation.
if (!checking) {
new SampleModal(this.app).open();
}
+
+ // This command will only show up in Command Palette when the check function returns true
return true;
}
- return false;
}
});
+ // This adds a settings tab so the user can configure various aspects of the plugin
this.addSettingTab(new SampleSettingTab(this.app, this));
- this.registerCodeMirror((cm: CodeMirror.Editor) => {
- console.log('codemirror', cm);
- });
-
+ // 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.
this.registerDomEvent(document, 'click', (evt: MouseEvent) => {
console.log('click', evt);
});
+ // 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));
}
onunload() {
- console.log('unloading plugin');
+
}
async loadSettings() {
|