obsidian-plugin/alberti42_obsidian-plugins-annotations
1
0
Fork 0
mirror of https://github.com/alberti42/obsidian-plugins-annotations.git synced 2026-07-22 10:10:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improved rendering of annotations and icons

Browse source
This commit is contained in:
Andrea Alberti 2024-08-26 00:30:15 +02:00
parent 5738eba8da
commit 15c0e0972c
3 changed files with 67 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

114
src/main.ts
View file

@ -337,6 +337,54 @@ export default class PluginsAnnotations extends Plugin {
return invertedMap;
}
patchCommunityPluginSettingTab(tab:SettingTab) {
// eslint-disable-next-line @typescript-eslint/no-this-alias
const self = this;
// Monkey patch for uninstallPlugin
const removeMonkeyPatchForRender = around(tab, {
renderInstalledPlugin: (next: (
pluginManifest: PluginManifest,
containerEl:HTMLElement,
nameMatch: boolean | null,
authorMatch: boolean | null,
descriptionMatch: boolean | null
) => void ) => {
return function (this: SettingTab,
pluginManifest: PluginManifest,
containerEl: HTMLElement,
nameMatch: boolean | null,
authorMatch: boolean | null,
descriptionMatch: boolean | null
): void {
next.call(this, pluginManifest, containerEl, nameMatch, authorMatch, descriptionMatch);
// Custom code for personal annotations here
if(containerEl && containerEl.lastElementChild)
{
self.addAnnotation(containerEl.lastElementChild)
}
};
},
// Patch for `render` method
render: (next: (
isInitialRender: boolean
) => void) => {
return function (this: SettingTab, isInitialRender: boolean): void {
// Call the original `render` function
next.call(this, isInitialRender);
self.addIcon(this.containerEl);
};
}
});
// Register the patch to ensure it gets cleaned up
this.register(removeMonkeyPatchForRender);
}
patchSettings() {
// eslint-disable-next-line @typescript-eslint/no-this-alias
const self = this;
@ -345,13 +393,11 @@ export default class PluginsAnnotations extends Plugin {
const removeMonkeyPatchForSetting = around(this.app.setting, {
openTab: (next: (tab: SettingTab) => void) => {
return function(this: Setting, tab: SettingTab) {
next.call(this, tab);
if (tab && tab.id === 'community-plugins') {
if(self.observedTab!==tab)
{
self.observeTab(tab);
}
if(self.observedTab!==tab) self.observeTab(tab);
self.patchCommunityPluginSettingTab(tab);
}
next.call(this, tab);
};
},
onClose: (next: () => void) => {
@ -443,40 +489,6 @@ export default class PluginsAnnotations extends Plugin {
// just in case, remove previous observers if there are any
this.disconnectObservers();
// eslint-disable-next-line @typescript-eslint/no-this-alias
const self = this;
// Monkey patch for uninstallPlugin
const removeMonkeyPatchForUpdateSearch = around(tab, {
renderInstalledPlugin: (next: (
pluginManifest: PluginManifest,
containerEl:HTMLElement,
nameMatch: boolean | null,
authorMatch: boolean | null,
descriptionMatch: boolean | null
) => void ) => {
return function (this: SettingTab,
pluginManifest: PluginManifest,
containerEl: HTMLElement,
nameMatch: boolean | null,
authorMatch: boolean | null,
descriptionMatch: boolean | null
): void {
next.call(this, pluginManifest, containerEl, nameMatch, authorMatch, descriptionMatch);
// Custom code for personal annotations here
if(containerEl && containerEl.lastElementChild)
{
self.addAnnotation(containerEl.lastElementChild)
}
};
}
});
// // Register the patch to ensure it gets cleaned up
this.register(removeMonkeyPatchForUpdateSearch);
if(!this.mutationObserver) {
this.observedTab = tab;
@ -487,7 +499,7 @@ export default class PluginsAnnotations extends Plugin {
await this.loadSettings();
await this.loadCommunityPluginsJson();
this.addIcon(tab);
// this.addIcon(tab);
this.addAnnotations(tab);
});
@ -501,10 +513,11 @@ export default class PluginsAnnotations extends Plugin {
// there could be changes in the settings due to synchronization among devices
// which only happens after the plugin is loaded
await this.loadSettings();
await this.loadCommunityPluginsJson();
// Initial call to add comments to already present plugins
this.addIcon(tab);
this.addAnnotations(tab);
// this.addIcon(tab);
// this.addAnnotations(tab);
}
disconnectObservers() {
@ -515,12 +528,12 @@ export default class PluginsAnnotations extends Plugin {
}
}
async addIcon(tab: SettingTab) {
async addIcon(containerEl: HTMLElement) {
// This should not be necessary, but just in case, remove the icon if it was there
this.removeIcon();
// Add new icon to the existing icons container
const headingContainer = tab.containerEl.querySelector('.setting-item-heading .setting-item-control');
const headingContainer = containerEl.querySelector('.setting-item-heading .setting-item-control');
if (headingContainer) {
this.lockIcon = document.createElement('div');
@ -548,7 +561,7 @@ export default class PluginsAnnotations extends Plugin {
lockIcon.innerHTML = svg_locked;
}
const plugins = tab.containerEl.querySelectorAll('.plugin-comment-annotation');
const plugins = containerEl.querySelectorAll('.plugin-comment-annotation');
plugins.forEach((div:Element) => {
if (div instanceof HTMLDivElement) {
if(this.settings.editable) {
@ -592,11 +605,15 @@ export default class PluginsAnnotations extends Plugin {
}
async loadCommunityPluginsJson() {
const url = 'https://raw.githubusercontent.com/obsidianmd/obsidian-releases/master/community-plugins.json';
// If the user decided not to show the GitHub icons, then avoid running this function
if(!this.settings.show_github_icons) return;
// If it was already loaded, we just return without fetching a new json
if(Object.keys(this.community_plugins).length>0) return;
try {
// Fetch the JSON data from the URL
const response = await fetch(url);
const response = await fetch('https://raw.githubusercontent.com/obsidianmd/obsidian-releases/master/community-plugins.json');
// Check if the response is OK (status code 200-299)
if (!response.ok) {
@ -622,7 +639,6 @@ export default class PluginsAnnotations extends Plugin {
const pluginName = pluginNameDiv ? pluginNameDiv.textContent : null;
if (!pluginName) {
console.log(pluginNameDiv);
console.warn('Plugin name not found');
return;
}

2
src/settings_tab.ts
View file

@ -450,7 +450,7 @@ export class PluginsAnnotationsSettingTab extends PluginSettingTab {
const show_github_icons_setting = new Setting(containerEl)
.setName('Show GitHub links')
.setDesc("If this option is enabled, a clickable icon linking to the plugin's GitHub page will be displayed.");
.setDesc("If this option is enabled, aclickable icon linking to the plugin's GitHub page will be displayed in the Community plugin pane.");
let show_github_icons_toggle: ToggleComponent;
show_github_icons_setting.addToggle(toggle => {

1
src/types/obsidian-augment.d.ts vendored
View file

@ -19,6 +19,7 @@ declare module "obsidian" {
name: string;
navEl: HTMLElement;
// updateSearch(e: string): void;
render(isInitialRender:boolean):void;
renderInstalledPlugin(
pluginManifest: PluginManifest,
containerEl: HTMLElement,