Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
fix(text): turn the editor's selection drawing back on only for input in the text (closes #11650)
Scott Campbelld663cb5af003
diff --git a/packages/ckeditor5/src/plugins/content_embed/content_embed.spec.ts b/packages/ckeditor5/src/plugins/content_embed/content_embed.spec.tsindex f9e1eb76fd..2c1f4a2dd0 100644--- a/packages/ckeditor5/src/plugins/content_embed/content_embed.spec.ts+++ b/packages/ckeditor5/src/plugins/content_embed/content_embed.spec.ts@@ -21,6 +21,7 @@ import { beforeEach, describe, expect, it, vi } from "vitest";import { createTestEditor } from "../../../test/editor-kit.js";import { installGlobMock } from "../../../test/globals-test-kit.js";+import LinkEmbed from "../link_embed/link_embed.js";import ReferenceLink from "../referencelink.js";import ContentEmbed, {BOX_SIZE_COMMAND_NAME,@@ -339,49 +340,82 @@ describe("ContentEmbed", () => {}function pressWidget() {- const root = editor.editing.view.getDomRoot();- const wrapper = root?.querySelector("div.include-note-wrapper");+ const wrapper = getDomRoot(editor).querySelector("div.include-note-wrapper");if (!wrapper) {throw new Error("The embed was not rendered.");}wrapper.dispatchEvent(new MouseEvent("mousedown", { bubbles: true, cancelable: true }));expect(editor.model.document.selection.getSelectedElement()?.name).toBe("contentEmbed");- expect(rendererIsFocused()).toBe(false);+ expect(rendererIsFocused(editor)).toBe(false);}- function rendererIsFocused() {- //@ts-expect-error: The renderer is a private field.- return editor.editing.view._renderer.isFocused as boolean;- }-- it("turns the renderer's focus back on once the selection leaves the widget", () => {+ it("turns the renderer's focus back on for a press in the text, not in the widget", () => {pressWidgetOfFocusedEditor();+ const wrapper = getDomRoot(editor).querySelector("div.include-note-wrapper");+ wrapper?.dispatchEvent(new KeyboardEvent("keydown", { key: "a", bubbles: true }));+ expect(rendererIsFocused(editor)).toBe(false);- editor.model.change((writer) => {- const root = editor.model.document.getRoot();- if (!root) {- throw new Error("The editor has no root.");- }- writer.setSelection(root.getChild(2), "end");- });- expect(rendererIsFocused()).toBe(true);+ const paragraph = getDomRoot(editor).children[2];+ paragraph.dispatchEvent(new MouseEvent("mousedown", { bubbles: true }));+ expect(rendererIsFocused(editor)).toBe(true);- // The next press turns it off again.pressWidget();});- it("turns the renderer's focus back on once the selected widget is deleted", () => {+ it("turns the renderer's focus back on for the key that deletes the widget", () => {pressWidgetOfFocusedEditor();+ const domRoot = getDomRoot(editor);+ domRoot.dispatchEvent(new KeyboardEvent("keydown", { key: "Backspace" }));+ expect(rendererIsFocused(editor)).toBe(true);editor.execute("delete");expect(getModelData(editor.model)).toBe("<paragraph>foo</paragraph><paragraph>[]</paragraph><paragraph>bar</paragraph>");- expect(rendererIsFocused()).toBe(true);// The DOM selection follows the model selection into the new empty paragraph.const domSelection = window.getSelection();- const caretParagraph = editor.editing.view.getDomRoot()?.children[1];- expect(caretParagraph?.contains(domSelection?.anchorNode ?? null)).toBe(true);+ expect(domRoot.children[1].contains(domSelection?.anchorNode ?? null)).toBe(true);+ });++ it("keeps the renderer's focus off for a press on a link preview", async () => {+ installGlobMock({+ getComponentByEl: () => ({+ triggerCommand,+ loadEmbeddedNote,+ renderLinkMention: vi.fn(),+ detectEmbedType: vi.fn(() => "opengraph")+ })+ });+ const linkEditor = await createTestEditor([+ Essentials, Paragraph, Widget, ContentEmbed, LinkEmbed+ ]);+ setModelData(linkEditor.model, "<paragraph>foo[]"+ + "<linkMention url=\"https://e.com/\" embedType=\"opengraph\"></linkMention>"+ + "</paragraph>");+ linkEditor.editing.view.document.isFocused = true;++ const mention = getDomRoot(linkEditor).querySelector(".link-mention-inner");+ if (!mention) {+ throw new Error("The link mention was not rendered.");+ }+ mention.dispatchEvent(new MouseEvent("mousedown", { bubbles: true, cancelable: true }));++ const selected = linkEditor.model.document.selection.getSelectedElement();+ expect(selected?.name).toBe("linkMention");+ expect(rendererIsFocused(linkEditor)).toBe(false);});++ function getDomRoot(target: ClassicEditor) {+ const domRoot = target.editing.view.getDomRoot();+ if (!domRoot) {+ throw new Error("The editor has no DOM root.");+ }+ return domRoot;+ }++ function rendererIsFocused(target: ClassicEditor) {+ //@ts-expect-error: The renderer is a private field.+ return target.editing.view._renderer.isFocused as boolean;+ }});it("suppresses the native caret on a non-interactive mousedown but not on interactive targets", () => {diff --git a/packages/ckeditor5/src/plugins/content_embed/content_embed.ts b/packages/ckeditor5/src/plugins/content_embed/content_embed.tsindex ffe8062674..2eb9daeb79 100644--- a/packages/ckeditor5/src/plugins/content_embed/content_embed.ts+++ b/packages/ckeditor5/src/plugins/content_embed/content_embed.ts@@ -374,14 +374,12 @@ class ContentEmbedEditing extends Plugin {editor.model.document.registerPostFixer( writer => this.removeTinyCaptions( writer ) );- // `preventCKEditorHandling()` turns `_renderer.isFocused` off for a press in an embed.- // Without a reset once the selection leaves it, the DOM selection stops following the model.- const selection = editor.model.document.selection;- this.listenTo( selection, 'change:range', () => {- if ( !isContentEmbed( selection.getSelectedElement() ) ) {- restoreRendererFocus( editor );- }- } );+ // Widget UI sets `_renderer.isFocused` to false on a press. The view ignores its events+ // (`data-cke-ignore-events`), so a press or key that the view sees is back in the text.+ const viewDocument = editor.editing.view.document;+ const restore = () => restoreRendererFocus( editor );+ this.listenTo( viewDocument, 'mousedown', restore, { priority: 'highest' } );+ this.listenTo( viewDocument, 'keydown', restore, { priority: 'highest' } );}/** Keeps a copy of `caption`, for `embed` to show again. */@@ -1304,7 +1302,7 @@ function preventCKEditorHandling( domElement: HTMLElement, editor: Editor ) {}}-/** Sets `_renderer.isFocused` back to `view.document.isFocused`, undoing `hackRendererFocus()`. */+/** Sets `_renderer.isFocused` back to `view.document.isFocused`. */function restoreRendererFocus( editor: Editor ) {const view = editor.editing.view;//@ts-expect-error: We are accessing a private field.