[200~trying status bar item with icon

This commit is contained in:
idan.liberman 2024-09-27 19:47:19 +03:00
parent 26f4a43c2d
commit f0ba53e425
6 changed files with 2559 additions and 122 deletions

View file

@ -1,23 +1,21 @@
{
"root": true,
"parser": "@typescript-eslint/parser",
"env": { "node": true },
"plugins": [
"@typescript-eslint"
],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended"
],
"parserOptions": {
"sourceType": "module"
},
"rules": {
"no-unused-vars": "off",
"@typescript-eslint/no-unused-vars": ["error", { "args": "none" }],
"@typescript-eslint/ban-ts-comment": "off",
"no-prototype-builtins": "off",
"@typescript-eslint/no-empty-function": "off"
}
}
"root": true,
"parser": "@typescript-eslint/parser",
"env": { "node": true },
"plugins": ["@typescript-eslint"],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended"
],
"parserOptions": {
"sourceType": "module"
},
"rules": {
"no-unused-vars": "off",
"@typescript-eslint/no-unused-vars": ["warn", { "args": "none" }],
"@typescript-eslint/ban-ts-comment": "off",
"no-prototype-builtins": "off",
"@typescript-eslint/no-empty-function": "off"
}
}

View file

@ -1,4 +1,4 @@
# Obsidian Sample Plugin
<!-- # Obsidian Sample Plugin
This is a sample plugin for Obsidian (https://obsidian.md).
@ -58,7 +58,7 @@ Quick starting guide for new plugin devs:
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
## Improve code quality with eslint (optional)
- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
- To use eslint with this project, make sure to install eslint from terminal:
- `npm install -g eslint`
- To use eslint to analyze this project use this command:
@ -93,4 +93,4 @@ If you have multiple URLs, you can also do:
## API Documentation
See https://github.com/obsidianmd/obsidian-api
See https://github.com/obsidianmd/obsidian-api -->

233
main.ts
View file

@ -1,134 +1,193 @@
import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian';
import {
App,
Editor,
MarkdownView,
Modal,
Plugin,
PluginSettingTab,
setIcon,
Setting,
TFile,
} from "obsidian";
// Remember to rename these classes and interfaces!
interface MyPluginSettings {
interface RedirectSettings {
mySetting: string;
}
const DEFAULT_SETTINGS: MyPluginSettings = {
mySetting: 'default'
}
const DEFAULT_SETTINGS: RedirectSettings = {
mySetting: "EDIT",
};
export default class MyPlugin extends Plugin {
settings: MyPluginSettings;
export default class RedirectPlugin extends Plugin {
settings: RedirectSettings;
addRedirectCount(): string {
const markdownView =
this.app.workspace.getActiveViewOfType(MarkdownView);
console.log(markdownView);
if (!markdownView) {
return "";
}
return "0 redirects";
}
async onload() {
await this.loadSettings();
// This creates an icon in the left ribbon.
const 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...
this.app.workspace.onLayoutReady(() => {
const statusBarItemEl = this.addStatusBarItem();
// setIcon(statusBarItemEl, "corner-up-left");
// This adds a status bar item to the bottom of the app. Does not work on mobile apps.
const statusBarItemEl = this.addStatusBarItem();
statusBarItemEl.setText('Status Bar Text');
this.app.workspace.on("active-leaf-change", (leaf) => {
statusBarItemEl.setText(this.addRedirectCount());
});
// 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.app.workspace.on("editor-change", () => {
setIcon(statusBarItemEl, "corner-up-left");
statusBarItemEl.setText(this.addRedirectCount());
});
});
// // This adds a simple command that can be triggered anywhere
// this.addCommand({
// id: "open-sample-modal-simple",
// name: "Open sample modal (simple)",
// callback: () => {
// new RedirectModal(this.app).open();
// },
// hotkeys: [{ key: "m", modifiers: ["Alt", "Ctrl", "Meta"] }],
// });
// This adds an editor command that can perform some operation on the current editor instance
this.addCommand({
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) => {
// Conditions to check
const 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();
}
id: "paste-your-mama",
name: "Pastes 'your mama!' on a selection.",
// This command will only show up in Command Palette when the check function returns true
return true;
}
}
editorCallback: (editor: Editor, view: MarkdownView) => {
editor.replaceSelection("your mama!");
},
hotkeys: [{ key: "v", modifiers: ["Ctrl", "Alt", "Meta"] }],
});
// 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 RedirectSettingsTab(this.app, this));
// 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);
});
// // 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));
// this.registerInterval(
// window.setInterval(() => console.log("setInterval"), 5 * 60 * 1000)
// );
// this.app.workspace.onLayoutReady(() => {
// this.getTargetFile();
// });
}
onunload() {
}
onunload() {}
async loadSettings() {
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
this.settings = Object.assign(
{},
DEFAULT_SETTINGS,
await this.loadData()
);
}
async saveSettings() {
await this.saveData(this.settings);
}
}
class SampleModal extends Modal {
constructor(app: App) {
super(app);
}
getTargetFile(): TFile | null {
// const currentFile = this.app.workspace.getActiveFile();
const targetFile = this.app.vault.getFileByPath("redirects/target.md");
// console.log(targetFile);
onOpen() {
const {contentEl} = this;
contentEl.setText('Woah!');
}
onClose() {
const {contentEl} = this;
contentEl.empty();
this.app.workspace.openLinkText(
targetFile?.name as string,
targetFile?.path as string,
false,
{
active: false,
}
);
return targetFile;
}
}
class SampleSettingTab extends PluginSettingTab {
plugin: MyPlugin;
// class File extends FileView {
// constructor(leaf: WorkspaceLeaf) {
// super(leaf);
// }
constructor(app: App, plugin: MyPlugin) {
// getViewType(): string {
// return "FileView";
// }
// getFile() {
// console.log(this.getDisplayText());
// }
// }
// class RedirectModal extends Modal {
// constructor(app: App) {
// super(app);
// }
// onOpen() {
// const { contentEl } = this;
// contentEl.setText("Define redirect here?");
// }
// onClose() {
// const { contentEl } = this;
// contentEl.empty();
// }
// }
class RedirectSettingsTab extends PluginSettingTab {
plugin: RedirectPlugin;
constructor(app: App, plugin: RedirectPlugin) {
super(app, plugin);
this.plugin = plugin;
}
display(): void {
const {containerEl} = this;
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();
}));
.setName("Automatic Redirect to Synonym")
.setDesc("Whether to automatically redirect to the target note.")
.addToggle((toggle) => {
toggle.setValue(true);
toggle.setTooltip("Well whaddaya know...");
toggle.onChange((value) => {
console.log(value);
if (value) {
console.log("true");
} else {
console.log("false");
}
});
});
// .addText((text) =>
// text
// .setPlaceholder("Enter your secret")
// .setValue(this.plugin.settings.mySetting)
// .onChange(async (value) => {
// this.plugin.settings.mySetting = value;
// await this.plugin.saveSettings();
// })
// );
}
}

View file

@ -1,11 +1,9 @@
{
"id": "sample-plugin",
"name": "Sample Plugin",
"id": "synonyms-plugin",
"name": "obsidian-synonyms-plugin",
"version": "1.0.0",
"minAppVersion": "0.15.0",
"description": "Demonstrates some of the capabilities of the Obsidian API.",
"author": "Obsidian",
"authorUrl": "https://obsidian.md",
"fundingUrl": "https://obsidian.md/pricing",
"description": "This plugin allows you to redirect multiple references to a single note.",
"author": "Idan Liberman",
"isDesktopOnly": false
}

2382
package-lock.json generated Normal file

File diff suppressed because it is too large Load diff

View file

@ -1,15 +1,15 @@
{
"name": "obsidian-sample-plugin",
"name": "obsidian-synonyms-plugin",
"version": "1.0.0",
"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
"description": "This plugin allows you to redirect multiple links to a single note.",
"main": "main.js",
"scripts": {
"dev": "node esbuild.config.mjs",
"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
"version": "node version-bump.mjs && git add manifest.json versions.json"
},
"keywords": [],
"author": "",
"keywords": ["obsidian", "redirect", "note", "synonym", "symlink", "symbolic link", "references"],
"author": "Idan Liberman",
"license": "MIT",
"devDependencies": {
"@types/node": "^16.11.6",