From 126b42dbd89f4ee65eec94489a2a6c16b57fd059 Mon Sep 17 00:00:00 2001 From: anareaty Date: Tue, 11 Mar 2025 01:24:47 +0400 Subject: [PATCH] fix on paste --- README.md | 10 ++- main.ts | 200 +++++++++++++++++++++++++++++++++++++++++++------- manifest.json | 2 +- tsconfig.json | 4 +- 4 files changed, 187 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 5d0572a..58bd794 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,15 @@ This plugin allows you to quickly add HTML checkboxes to your notes and makes th The main reason you may want to use HTML checkboxes instead of Markdown checkboxes is that you can put them into Markdown tables. You can also place them anywhere in the note, for example add several checkboxes in the row. Also all of your Markdown stays valid, and even if you turn the plugin off, all created checkboxes would still be visible (just not clickable). -## Details +## Usage -To create checkbox you should put cursor to the place you want and call the command "Add HTML checkbox". Alternatively you can select the option in the editor menu. Be aware that every created checkbox has a unique id, it is nesessary for the checkboxes to be clickable. Do not remove the id and also do not copy-paste checkboxes inside the same file, because if there are several checkboxes with the same id, they will not work. It is recommended to never edit checkboxes manually. Also checkboxes are NOT added automatically on the next line when you hit "enter". +To create checkbox you should put cursor to the place you want and call the command "Add HTML checkbox". Alternatively you can select the option in the editor menu. Be aware that every created checkbox has a unique id, it is nesessary for the checkboxes to be clickable. Do not remove the id and make sure you don't have several checkboxes with the same id within the same file, otherwise they will not work. + +If you want to copy and paste checkboxes within the same file, it is important to change IDs, so they are note duplicate existing ones. This can be done in two ways: +1. Enable option "Automatically fix duplicated IDs on pasting" in plugin settings. In this case every time you paste checkboxes, plugin would scan the file to find and fix any repeating IDs. Be aware that pasting may become slow, if you pasting many checkboxes at once or if there are already many checkboxes in the file. +2. You can fix all checkboxes that are already in the file by chosing command "Fix HTML checkboxes" from command pallete or from editor menu. + +It is recommended to never edit checkboxes manually. Also checkboxes are NOT added automatically on the next line when you hit "enter". When right-clicking on the checkbox you will see the menu allowing you to select between a few of alternate checkboxes (you will need the theme or special css to make alternate checkboxes look different). Note that not all of possble alternate checkboxes are supported, and I am not planning to add more. When the alternate checkboxes menu appears inside the table it will hide the default table right-click menu. If you want to see table right-click menu, you should click on some other place in the cell. diff --git a/main.ts b/main.ts index 01d0ac9..5b2f14c 100644 --- a/main.ts +++ b/main.ts @@ -1,11 +1,22 @@ -import { Editor, Plugin, TFile, Menu, WorkspaceLeaf } from 'obsidian'; +import { Editor, Plugin, TFile, Menu, WorkspaceLeaf, PluginSettingTab, App, Setting} from 'obsidian'; +interface CMSettings { + fixOnPaste: boolean; +} + +const DEFAULT_SETTINGS: CMSettings = { + fixOnPaste: true, +}; + export default class HTMLCheckboxPlugin extends Plugin { + settings: CMSettings; async onload() { + await this.loadSettings(); + this.addSettingTab(new HCSettingTab(this.app, this)); /* Add menu item to create checkbox */ @@ -18,6 +29,14 @@ export default class HTMLCheckboxPlugin extends Plugin { this.addCheckbox(editor) }); }); + menu.addItem((item) => { + item + .setTitle("Fix HTML checkboxes") + .setIcon("wrench") + .onClick(async () => { + this.fixCheckboxIds(editor) + }); + }); })); this.addCommand({ @@ -28,6 +47,14 @@ export default class HTMLCheckboxPlugin extends Plugin { } }); + this.addCommand({ + id: "fix-checkbox-ids", + name: "Fix HTML checkboxes", + editorCallback: async (editor, view) => { + this.fixCheckboxIds(editor) + } + }); + @@ -96,10 +123,6 @@ export default class HTMLCheckboxPlugin extends Plugin { await leaf.rebuildView() } } - - - - } } }); @@ -112,6 +135,8 @@ export default class HTMLCheckboxPlugin extends Plugin { this.registerDomEvent(window, "contextmenu", (e: MouseEvent) => { + + if (e.button == 2) { let target = e.target as HTMLElement if (target.localName == "input" && @@ -166,7 +191,6 @@ export default class HTMLCheckboxPlugin extends Plugin { ); menu.showAtMouseEvent(e as MouseEvent); - console.log(menu) //@ts-ignore menu.dom.classList.add("checkbox-menu"); } @@ -175,52 +199,151 @@ export default class HTMLCheckboxPlugin extends Plugin { - - + /* Fix checkboxes on paste */ + /* No typescript error if we use window.document instead of window, but then listener don't work in canvas for some reason. Event bubbles up to the window anyway. */ + //@ts-ignore + this.registerDomEvent(window, "paste", (e: ClipboardEvent) => { + if (this.settings.fixOnPaste) { + let pasteContent = e.clipboardData?.getData("text") || "" + let re = /(id="hc-)([^"]+)(\")/g; + let matchPaste = pasteContent?.match(re) + if (matchPaste) { + let inCanvas + if (e.target) { + let target = e.target as HTMLElement + inCanvas = target.closest(".mod-inside-iframe") + } + if (inCanvas) { + e.preventDefault() + } + let editor = this.app.workspace.activeEditor?.editor + if (editor) { + this.fixCheckboxIds(editor, inCanvas, pasteContent) + } + } + } + + }) } onunload() {} + async loadSettings() { + this.settings = Object.assign( + {}, + DEFAULT_SETTINGS, + await this.loadData() + ); + } + async saveSettings() { + await this.saveData(this.settings); + } - - - - - async addCheckbox(editor: Editor) { - const generateId: any = (content: string) => { - let id = "hc-" + (Math.floor(Math.random() * 999) + 1); - let match = content.match("id=\"" + id + "\"") - if (match) { - return generateId(content) - } else { - return id - } - } - + async addCheckbox(editor: Editor) { let lastLine = editor.lastLine() let lastLineLength = editor.getLine(lastLine).length let editorContent = editor.getRange({line:0, ch: 0}, {line:lastLine, ch: lastLineLength}) - let id = generateId(editorContent) + let id = this.generateNewId(editorContent) let checkbox = '' editor.replaceSelection(checkbox) } + generateNewId(content: string): any { + let id = "hc-" + (Math.floor(Math.random() * 9000) + 1000); + let match = content.match("id=\"" + id + "\"") + if (match) { + return this.generateNewId(content) + } else { + return id + } + } + generateFixedId(content: string, id: string, tryCount: number): any { + let re = new RegExp(id, "g") + let match = content.match(re) + let file = this.app.workspace.getActiveFile() + if (match && match.length == 1 && file?.extension != "canvas") { + return id + } else { + let newId = 'id="hc-' + (Math.floor(Math.random() * 9000) + 1000) + '"'; + match = content.match(newId) + if (match) { + return this.generateFixedId(content, id, tryCount + 1) + } else { + return newId + } + } + } + + + async fixCheckboxIds(editor: Editor, inCanvas?: Element | null | undefined, pasteContent?: string) { + let lastLine = editor.lastLine() + let lastLineLength = editor.getLine(lastLine).length + let editorContent = editor.getRange({line:0, ch: 0}, {line:lastLine, ch: lastLineLength}) + let re = /(id="hc-)([^"]+)(\")/g; + let cursor = editor.getCursor() + + /* In regular notes event triggers after text already pasted, but in canvas - before text pasted, so we need to process content differently. */ + /* In the paste listener we prevented paste with preventDefault(), so we need to add pasted text to content manually. */ + if (inCanvas && pasteContent) { + let startCursor = editor.getCursor("from") + let endCursor = editor.getCursor("to") + let startContent = editor.getRange({line:0, ch: 0}, startCursor) + let endContent = editor.getRange(endCursor, {line:lastLine, ch: lastLineLength}) + editorContent = startContent + pasteContent + endContent + cursor.ch = cursor.ch + pasteContent.length + } + + let matchContent + + let file = this.app.workspace.getActiveFile() + + if (file && file.extension == "canvas") { + let fileContent = await this.app.vault.cachedRead(file) + re = /(id=\\"hc-)([^"]+)(\\")/g; + matchContent = fileContent?.match(re) + } else { + matchContent = editorContent?.match(re) + } + + if (matchContent) { + for (let id of matchContent) { + id = id.replaceAll('\\\"', '"') + let newId = this.generateFixedId(editorContent, id, 0) + if (id != newId) { + editorContent = editorContent.replace(id, newId) + } + } + } + + editor.setSelection({line:0, ch: 0}, {line:lastLine, ch: lastLineLength}) + editor.replaceSelection(editorContent) + + lastLine = editor.lastLine() + lastLineLength = editor.getLine(lastLine).length + + if (cursor.line >= lastLine && cursor.ch > lastLineLength) { + editor.setCursor({line:lastLine, ch: lastLineLength}) + } else { + editor.setCursor(cursor) + } + editor.focus() + } async setStatus(status: string, target: HTMLElement) { let file = this.app.workspace.getActiveFile() - + /* Check if checkbox is inside embedded file */ let embedWrapper = target.closest(".internal-embed") @@ -288,6 +411,33 @@ export default class HTMLCheckboxPlugin extends Plugin { } +class HCSettingTab extends PluginSettingTab { + plugin: HTMLCheckboxPlugin; + + constructor(app: App, plugin: HTMLCheckboxPlugin) { + super(app, plugin); + this.plugin = plugin; + } + + display(): void { + const { containerEl } = this; + + containerEl.empty(); + + new Setting(containerEl) + .setName("Automatically fix duplicated IDs on pasting") + .setDesc("If you copy and paste any HTML checkboxes, plugin will scan the file and fix any duplicated IDs. Be aware that pasting too many checkboxes at onse may be slow if this option is enabled.") + .addToggle((toggle) => + toggle + .setValue(this.plugin.settings.fixOnPaste) + .onChange(async(value) => { + this.plugin.settings.fixOnPaste = value; + await this.plugin.saveSettings(); + }) + ) + } +} + diff --git a/manifest.json b/manifest.json index acde39a..ebd27d9 100644 --- a/manifest.json +++ b/manifest.json @@ -1,7 +1,7 @@ { "id": "html-checkboxes", "name": "HTML checkboxes", - "version": "1.0.6", + "version": "1.1.0", "minAppVersion": "1.1.0", "description": "Allows to quickly add HTML checkboxes to your notes and makes them clickable.", "author": "Anareaty", diff --git a/tsconfig.json b/tsconfig.json index c44b729..0fea143 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -15,7 +15,9 @@ "DOM", "ES5", "ES6", - "ES7" + "ES7", + "ES2021", + "ES2022" ] }, "include": [