Skip to content

Build your personal knowledge base with Trilium Notes

fix(client): let the DOM and the props reach a type widget's event gate

Elian Dorandb1586b4e7dc
diff --git a/apps/client/src/widgets/NoteDetail.spec.ts b/apps/client/src/widgets/NoteDetail.spec.ts
index a4b1530679..cf7ee218ce 100644
--- a/apps/client/src/widgets/NoteDetail.spec.ts
+++ b/apps/client/src/widgets/NoteDetail.spec.ts
@@ -3,7 +3,7 @@ import { useContext } from "preact/hooks";
import { act } from "preact/test-utils";
import { afterEach, describe, expect, it, vi } from "vitest";
-import type { EventData } from "../components/app_context";
+import appContext, { type EventData } from "../components/app_context";
import Component from "../components/component";
import NoteContext from "../components/note_context";
import type FNote from "../entities/fnote";
@@ -14,7 +14,7 @@ import froca from "../services/froca";
vi.mock("./note_tree", () => ({ default: class {} }));
import { getExtendedWidgetType, NoteDetailWrapper, useDeferredDetailFocus } from "./NoteDetail";
-import { isContextInActiveTab, useTriliumEvent } from "./react/hooks";
+import { isContextInActiveTab, useLegacyImperativeHandlers, useTriliumEvent } from "./react/hooks";
import { ContainerVisibilityContext, ParentComponent } from "./react/react_utils";
import type { TypeWidgetProps } from "./type_widgets/type_widget";
@@ -153,21 +153,27 @@ describe("NoteDetailWrapper", () => {
const host = document.createElement("div");
const received: string[] = [];
let typeWidgetParent: Component | null = null;
+ let typeWidgetProps: TypeWidgetProps | null = null;
let hostComponent = new Component();
+ const addLinkToText = vi.fn();
+ const imperativeHandlers = { addLinkToTextCommand: addLinkToText };
- function TypeWidget() {
+ function TypeWidget(props: TypeWidgetProps) {
typeWidgetParent = useContext(ParentComponent);
+ typeWidgetProps = props;
+ useLegacyImperativeHandlers(imperativeHandlers);
useTriliumEvent("findInText", () => received.push("findInText"));
useTriliumEvent("executeWithCodeEditor", () => received.push("executeWithCodeEditor"));
useTriliumEvent("entitiesReloaded", () => received.push("entitiesReloaded"));
useTriliumEvent("noteSwitched", () => received.push("noteSwitched"));
- return h("div", {});
+ useTriliumEvent("sqlQueryResults", () => received.push("sqlQueryResults"));
+ return h("div", {}, h("p", { className: "type-widget-content" }));
}
function renderWrapper(isVisible: boolean, containerVisible = true) {
const wrapper = h(NoteDetailWrapper, {
Element: TypeWidget, type: "editableText", isVisible, isFullHeight: false,
- props: {} as TypeWidgetProps
+ props: { parentComponent: hostComponent } as TypeWidgetProps
});
act(() => render(
h(ParentComponent.Provider, { value: hostComponent },
@@ -183,30 +189,35 @@ describe("NoteDetailWrapper", () => {
await hostComponent.handleEventInChildren("entitiesReloaded",
{} as EventData<"entitiesReloaded">);
await hostComponent.handleEventInChildren("noteSwitched", {} as EventData<"noteSwitched">);
+ await hostComponent.handleEventInChildren("sqlQueryResults",
+ {} as EventData<"sqlQueryResults">);
}
afterEach(() => {
render(null, host);
received.length = 0;
typeWidgetParent = null;
+ typeWidgetProps = null;
hostComponent = new Component();
+ addLinkToText.mockReset();
});
it("sends requests only to the displayed type widget, and syncs a hidden one", async () => {
renderWrapper(false);
await dispatchAll();
- expect(received).toEqual([ "entitiesReloaded", "noteSwitched" ]);
+ expect(received).toEqual([ "entitiesReloaded", "noteSwitched", "sqlQueryResults" ]);
received.length = 0;
renderWrapper(true, false);
await dispatchAll();
- expect(received).toEqual([ "entitiesReloaded", "noteSwitched" ]);
+ expect(received).toEqual([ "entitiesReloaded", "noteSwitched", "sqlQueryResults" ]);
received.length = 0;
renderWrapper(true);
await dispatchAll();
expect(received).toEqual(
- [ "findInText", "executeWithCodeEditor", "entitiesReloaded", "noteSwitched" ]);
+ [ "findInText", "executeWithCodeEditor", "entitiesReloaded", "noteSwitched",
+ "sqlQueryResults" ]);
});
it("gives the type widget a parent that saves and commands as the host", () => {
@@ -225,4 +236,19 @@ describe("NoteDetailWrapper", () => {
render(null, host);
expect(hostComponent.children).not.toContain(parent);
});
+
+ it("lets the DOM and the widget's props reach the handlers the type widget installs", () => {
+ renderWrapper(true);
+ const parent = typeWidgetParent;
+ const content = host.querySelector<HTMLElement>(".type-widget-content");
+ if (!parent || !content) throw new Error("The type widget did not render.");
+
+ // The text editor finds its host this way, e.g. for reference link titles.
+ expect(appContext.getComponentByEl(content)).toBe(parent);
+ expect(typeWidgetProps?.parentComponent).toBe(parent);
+
+ // Keyboard shortcuts trigger their command on `props.parentComponent`.
+ typeWidgetProps?.parentComponent?.triggerCommand("addLinkToText", {});
+ expect(addLinkToText).toHaveBeenCalledOnce();
+ });
});
diff --git a/apps/client/src/widgets/NoteDetail.tsx b/apps/client/src/widgets/NoteDetail.tsx
index 9bf9f13370..87a2c09409 100644
--- a/apps/client/src/widgets/NoteDetail.tsx
+++ b/apps/client/src/widgets/NoteDetail.tsx
@@ -27,6 +27,7 @@ import {
useDelayedVisibility,
useGetContextDataFrom,
useHasTabBeenShown,
+ useLegacyComponentElement,
useNoteContext,
useTriliumEvent
} from "./react/hooks";
@@ -286,6 +287,7 @@ export function NoteDetailWrapper({ Element, type, isVisible, isFullHeight, prop
const [ cachedProps, setCachedProps ] = useState(props);
const wrapperRef = useRef<HTMLDivElement>(null);
const eventGate = useTypeWidgetEventGate(isVisible && containerVisible);
+ useLegacyComponentElement(wrapperRef, eventGate);
useEffect(() => {
if (isVisible) {
@@ -314,7 +316,11 @@ export function NoteDetailWrapper({ Element, type, isVisible, isFullHeight, prop
}}
>
<ParentComponent.Provider value={eventGate}>
- <Element {...cachedProps} isVisible={isVisible && containerVisible} />
+ <Element
+ {...cachedProps}
+ parentComponent={eventGate}
+ isVisible={isVisible && containerVisible}
+ />
</ParentComponent.Provider>
</div>
);
@@ -326,6 +332,7 @@ export function NoteDetailWrapper({ Element, type, isVisible, isFullHeight, prop
*/
const EVENTS_FOR_HIDDEN_TYPE_WIDGETS = new Set<EventNames>([
"entitiesReloaded", "frocaReloaded", "refreshEmbeddedNote", "searchRefreshed", "apiLogMessages",
+ "sqlQueryResults",
"themeChanged", "protectedSessionStarted", "readOnlyTemporarilyDisabled", "contextDataChanged",
"setNoteContext", "activeContextChanged", "activeNoteChanged", "hoistedNoteChanged",
"noteSwitched", "noteSwitchedAndActivated", "beforeNoteSwitch", "noteTypeMimeChanged",
diff --git a/apps/client/src/widgets/react/hooks.tsx b/apps/client/src/widgets/react/hooks.tsx
index 3d15ed08e9..e7e7b40008 100644
--- a/apps/client/src/widgets/react/hooks.tsx
+++ b/apps/client/src/widgets/react/hooks.tsx
@@ -1507,8 +1507,9 @@ export function useLegacyImperativeHandlers(handlers: Record<string, Function>)
* marks its own element (see `BasicWidget.render`), and a React tree mounted under one answers to
* that same widget, so the two already agree everywhere else.
*/
-export function useLegacyComponentElement(elRef: RefObject<HTMLElement | null>) {
- const parentComponent = useContext(ParentComponent);
+export function useLegacyComponentElement(elRef: RefObject<HTMLElement | null>, component?: Component) {
+ const contextComponent = useContext(ParentComponent);
+ const parentComponent = component ?? contextComponent;
useEffect(() => {
const el = elRef.current;