Skip to content

Build your personal knowledge base with Trilium Notes

fix(mobile): keep the tree's previews and bookmarks current

Elian Doranc421d75ee63a
diff --git a/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.css b/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.css
index 2fd67cbbc4..db3d3ec7b5 100644
--- a/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.css
+++ b/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.css
@@ -1,4 +1,3 @@
-/* The current note and its children are grouped like the mobile settings list in menus.css. */
.mobile-note-navigator {
--navigator-group-inset: 16px;
--navigator-group-radius: 6px;
@@ -48,9 +47,11 @@
gap: 8px;
min-width: 0;
padding: 16px 8px 12px;
+ border: 0;
border-radius: var(--navigator-group-radius);
background: var(--navigator-group-background);
color: var(--main-text-color);
+ font: inherit;
cursor: pointer;
user-select: none;
-webkit-tap-highlight-color: transparent;
diff --git a/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.spec.tsx b/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.spec.tsx
index 0a184eada4..ad4c05147c 100644
--- a/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.spec.tsx
+++ b/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.spec.tsx
@@ -5,19 +5,37 @@ import appContext from "../../components/app_context";
import type Component from "../../components/component";
import FBranch from "../../entities/fbranch";
import type FNote from "../../entities/fnote";
+import content_renderer from "../../services/content_renderer";
import froca from "../../services/froca";
import type LoadResults from "../../services/load_results";
import search from "../../services/search";
import { buildNote, buildNotes } from "../../test/easy-froca";
import { renderInto } from "../../test/render";
import { ParentComponent } from "../react/react_utils";
-import { BookmarkList, getListedChildCount, getPreviewNoteIds, TitleWithIndicators, WorkspaceCards } from "./MobileNoteNavigator";
+import { BookmarkList, getListedChildCount, getPreviewNoteIds, PreviewSlot, TitleWithIndicators, WorkspaceCards } from "./MobileNoteNavigator";
vi.mock("../../services/i18n", () => ({
t: (key: string, options?: object) => (options ? `${key} ${JSON.stringify(options)}` : key),
translationsInitializedPromise: Promise.resolve()
}));
+/** A parent component that collects the `entitiesReloaded` handlers, and fires them with the `LoadResults` methods given. */
+function reloadingParent(extra: object = {}) {
+ const handlers: ((data: unknown) => void)[] = [];
+ const parent = {
+ componentId: "cid",
+ registerHandler: (name: string, callback: (data: unknown) => void) => {
+ if (name === "entitiesReloaded") handlers.push(callback);
+ },
+ removeHandler: () => {},
+ ...extra
+ } as unknown as Component;
+ const reload = (loadResults: object) => act(() => {
+ for (const handler of handlers) handler({ loadResults });
+ });
+ return { parent, reload };
+}
+
describe("getListedChildCount", () => {
buildNotes([
{ id: "parent", title: "Parent", children: [
@@ -130,6 +148,7 @@ describe("WorkspaceCards", () => {
expect(container.querySelector(".mobile-navigator-workspaces-label")?.textContent).toBe("mobile_note_navigator.workspaces");
const cards = [ ...container.querySelectorAll(".mobile-navigator-workspaces .mobile-navigator-workspace") ];
expect(cards.map((card) => card.textContent)).toEqual([ "Work" ]);
+ expect(cards[0]?.tagName).toBe("BUTTON");
expect(cards[0]?.querySelector(".mobile-navigator-workspace-icon.bx-briefcase")).not.toBeNull();
(cards[0] as HTMLElement | undefined)?.click();
@@ -183,4 +202,73 @@ describe("BookmarkList", () => {
});
expect(container.querySelector(".mobile-navigator-bookmarks-label")?.textContent).toBe("mobile_note_navigator.bookmarks");
});
+
+ it("follows a bookmarked note moved elsewhere in the tree", async () => {
+ buildNote({ id: "root", title: "root", children: [
+ { id: "fromFolder", title: "From", children: [ { id: "moved", title: "Moved" } ] },
+ { id: "toFolder", title: "To" }
+ ] });
+ const bookmarks = buildNote({ id: "_lbBookmarks", title: "Bookmarks" });
+ const moved = froca.notes["moved"];
+ const toFolder = froca.notes["toFolder"];
+ if (!moved || !toFolder) throw new Error("expected the notes");
+ const link = (parent: FNote, branchId: string) => {
+ froca.branches[branchId] = new FBranch(froca, {
+ branchId, noteId: "moved", parentNoteId: parent.noteId, notePosition: 0, fromSearchNote: false
+ });
+ parent.addChild("moved", branchId, false);
+ moved.addParent(parent.noteId, branchId, false);
+ };
+ link(bookmarks, "_lbBookmarks_moved");
+ const { parent, reload } = reloadingParent();
+
+ let container = document.body;
+ await act(async () => {
+ container = renderInto(
+ <ParentComponent.Provider value={parent}>
+ <BookmarkList renderRow={({ note, notePath }) => <div key={note.noteId} className="row">{notePath}</div>} />
+ </ParentComponent.Provider>
+ );
+ });
+ const rowPaths = () => [ ...container.querySelectorAll(".row") ].map((row) => row.textContent);
+ await vi.waitFor(() => expect(rowPaths()).toEqual([ "root/fromFolder/moved" ]));
+
+ moved.parents = moved.parents.filter((parentNoteId) => parentNoteId !== "fromFolder");
+ delete moved.parentToBranch["fromFolder"];
+ link(toFolder, "toFolder_moved");
+ reload({ getBranchRows: () => [ { noteId: "moved", parentNoteId: "toFolder" } ] });
+ await vi.waitFor(() => expect(rowPaths()).toEqual([ "root/toFolder/moved" ]));
+ });
+});
+
+describe("PreviewSlot", () => {
+ afterEach(() => {
+ vi.restoreAllMocks();
+ });
+
+ it("renders the preview again once the note's content changes, while it is kept", async () => {
+ const note = buildNote({ title: "Previewed" });
+ let version = 1;
+ const getRenderedContent = vi.spyOn(content_renderer, "getRenderedContent").mockImplementation(async () => {
+ const $renderedContent = $("<div>").text(`Version ${version}`);
+ return { $renderedContent, type: "text" };
+ });
+ const { parent, reload } = reloadingParent();
+
+ let container = document.body;
+ await act(async () => {
+ container = renderInto(
+ <ParentComponent.Provider value={parent}>
+ <PreviewSlot note={note} shown={false} hideArchived onReady={() => {}} />
+ </ParentComponent.Provider>
+ );
+ });
+ await vi.waitFor(() => expect(container.textContent).toBe("Version 1"));
+
+ version = 2;
+ reload({ isNoteContentReloaded: (noteId: string) => noteId === "other" });
+ expect(getRenderedContent).toHaveBeenCalledTimes(1);
+ reload({ isNoteContentReloaded: (noteId: string) => noteId === note.noteId });
+ await vi.waitFor(() => expect(container.textContent).toBe("Version 2"));
+ });
});
diff --git a/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.tsx b/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.tsx
index 4623219e53..e1010fd2ea 100644
--- a/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.tsx
+++ b/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.tsx
@@ -409,7 +409,7 @@ function getPreviewNotes(noteIds: string[]) {
.filter((note): note is FNote => !!note);
}
-function PreviewSlot({ note, shown, hideArchived, onReady }: {
+export function PreviewSlot({ note, shown, hideArchived, onReady }: {
note: FNote;
shown: boolean;
hideArchived: boolean;
@@ -417,10 +417,16 @@ function PreviewSlot({ note, shown, hideArchived, onReady }: {
}) {
const { noteId } = note;
useEffect(() => () => onReady(noteId, false), [ noteId, onReady ]);
+ // `NoteContent` renders again only for another note, and froca updates this one in place.
+ const [ contentVersion, setContentVersion ] = useState(0);
+ useTriliumEvent("entitiesReloaded", ({ loadResults }) => {
+ if (loadResults.isNoteContentReloaded(noteId)) setContentVersion((version) => version + 1);
+ });
return (
<div className="mobile-navigator-preview-slot" hidden={!shown}>
<NoteContent
+ key={contentVersion}
note={note}
trim
noChildrenList
@@ -514,6 +520,14 @@ interface Bookmark {
export function BookmarkList({ renderRow }: { renderRow: (bookmark: Bookmark) => ComponentChildren }) {
const bookmarkNotes = useChildNotes("_lbBookmarks");
const [ bookmarks, setBookmarks ] = useState<Bookmark[]>([]);
+ // A bookmarked note moved elsewhere in the tree changes no branch under `_lbBookmarks`.
+ const [ treeVersion, setTreeVersion ] = useState(0);
+ useTriliumEvent("entitiesReloaded", ({ loadResults }) => {
+ const bookmarkIds = new Set(bookmarkNotes.map((note) => note.noteId));
+ if (loadResults.getBranchRows().some((branch) => !!branch.noteId && bookmarkIds.has(branch.noteId))) {
+ setTreeVersion((version) => version + 1);
+ }
+ });
useEffect(() => {
let cancelled = false;
@@ -524,7 +538,7 @@ export function BookmarkList({ renderRow }: { renderRow: (bookmark: Bookmark) =>
if (!cancelled) setBookmarks(resolved.filter((bookmark): bookmark is Bookmark => !!bookmark));
});
return () => { cancelled = true; };
- }, [ bookmarkNotes ]);
+ }, [ bookmarkNotes, treeVersion ]);
if (!bookmarks.length) return null;
@@ -547,10 +561,9 @@ function WorkspaceCard({ note, onClick }: { note: FNote, onClick: () => void })
const title = useNoteTitle(note.noteId, undefined);
return (
- <div
+ <button
+ type="button"
className={clsx("mobile-navigator-workspace", { "has-color": !!workspaceColor })}
- role="button"
- tabIndex={0}
onClick={onClick}
>
<Icon
@@ -559,7 +572,7 @@ function WorkspaceCard({ note, onClick }: { note: FNote, onClick: () => void })
style={workspaceColorStyle(workspaceColor)}
/>
<span className="mobile-navigator-workspace-title">{title ?? note.title}</span>
- </div>
+ </button>
);
}