Skip to content

Build your personal knowledge base with Trilium Notes

client/collections/board: show column icons in the "Move to" submenu

Adorian Doran126d7fe89f86
diff --git a/apps/client/src/widgets/collections/board/api.spec.ts b/apps/client/src/widgets/collections/board/api.spec.ts
index 2943948a7e..fcea56e2fb 100644
--- a/apps/client/src/widgets/collections/board/api.spec.ts
+++ b/apps/client/src/widgets/collections/board/api.spec.ts
@@ -933,3 +933,17 @@ describe("duplicating a card", () => {
expect(branches.moveAfterBranch).toHaveBeenCalledWith([ "copyBranch" ], "card1Branch");
});
});
+
+describe("the icon a column wears", () => {
+ it("gives each column its own, and the stock one to a column given none", () => {
+ const { api } = createApi(
+ { columns: [ { value: "To Do", icon: "bx bx-list-ul" }, { value: "Done" } ] },
+ [ "To Do", "Done" ]
+ );
+
+ expect(api.columnIcon("To Do")).toBe("bx bx-list-ul");
+ expect(api.columnIcon("Done")).toBe("bx bx-circle");
+ // One the board has never heard of is still owed an icon.
+ expect(api.columnIcon("Elsewhere")).toBe("bx bx-circle");
+ });
+});
diff --git a/apps/client/src/widgets/collections/board/api.ts b/apps/client/src/widgets/collections/board/api.ts
index cc6bdbaea6..0debc7d2ac 100644
--- a/apps/client/src/widgets/collections/board/api.ts
+++ b/apps/client/src/widgets/collections/board/api.ts
@@ -13,7 +13,9 @@ import server from "../../../services/server";
import ws from "../../../services/ws";
import toast from "../../../services/toast";
import { BoardColumnData, BoardViewData } from ".";
-import { type BoardStatusDefinition, canStoreColumnsInDefinition, DEFAULT_GROUP_BY } from "./columns";
+import {
+ type BoardStatusDefinition, canStoreColumnsInDefinition, DEFAULT_COLUMN_ICON, DEFAULT_GROUP_BY
+} from "./columns";
import { ColumnMap } from "./data";
/** One write's claim on a column, held until that write lands or is taken back. */
@@ -281,6 +283,21 @@ export default class BoardApi {
this.updateColumn(column, { color: color ?? undefined });
}
+ /**
+ * The icon a column shows in its header, for anywhere else standing for the same column.
+ *
+ * In relation mode the column is a note and wears that note's own icon, which the board does
+ * not keep and cannot set. Everywhere else the stock icon stands in for a column given none.
+ */
+ columnIcon(column: string) {
+ if (this.isRelationMode) {
+ return froca.getNoteFromCache(column)?.getIcon() ?? DEFAULT_COLUMN_ICON;
+ }
+
+ const stored = this.viewConfig?.columns?.find(col => col.value === column)?.icon;
+ return stored || DEFAULT_COLUMN_ICON;
+ }
+
/** Whether a column is archived, which the board shows only while archived notes are shown. */
isColumnArchived(column: string) {
return !!this.viewConfig?.columns?.find(col => col.value === column)?.archived;
diff --git a/apps/client/src/widgets/collections/board/context_menu.spec.ts b/apps/client/src/widgets/collections/board/context_menu.spec.ts
index d5a7862ac2..dbc3c4abbb 100644
--- a/apps/client/src/widgets/collections/board/context_menu.spec.ts
+++ b/apps/client/src/widgets/collections/board/context_menu.spec.ts
@@ -225,6 +225,7 @@ describe("Board item context menu", () => {
const api = {
columns: [],
isColumnArchived: () => false,
+ columnIcon: () => "bx bx-circle",
insertRowAtPosition: vi.fn(async () => {})
} as unknown as BoardApi;
const items = openItemMenu(api);
@@ -243,6 +244,7 @@ describe("Board item context menu", () => {
const api = {
columns: [ "To Do", "Done" ],
isColumnArchived: () => false,
+ columnIcon: () => "bx bx-circle",
changeColumn: vi.fn(async () => {})
} as unknown as BoardApi;
@@ -263,6 +265,7 @@ describe("Board item context menu", () => {
const api = {
columns: [],
isColumnArchived: () => false,
+ columnIcon: () => "bx bx-circle",
removeFromBoard: vi.fn()
} as unknown as BoardApi;
const deleteNotes = vi.spyOn(branches, "deleteNotes").mockResolvedValue(false);
@@ -278,10 +281,27 @@ describe("Board item context menu", () => {
expect(deleteNotes).toHaveBeenCalledWith([ "branchId" ], false, false);
});
+ it("shows each column with the icon its header wears", () => {
+ const api = {
+ columns: [ "To Do", "Done" ],
+ isColumnArchived: () => false,
+ columnIcon: (column: string) =>
+ column === "To Do" ? "bx bx-list-ul" : "bx bx-check"
+ } as unknown as BoardApi;
+
+ const moveTo = openItemMenu(api).find(item =>
+ item && "uiIcon" in item && item.uiIcon === "bx bx-transfer");
+ if (!moveTo || !("items" in moveTo)) throw new Error("expected a move-to entry");
+
+ expect((moveTo.items ?? []).map(item => item && "uiIcon" in item ? item.uiIcon : null))
+ .toEqual([ "bx bx-list-ul", "bx bx-check" ]);
+ });
+
it("copies a card into the board, after the one it was made from", async () => {
const api = {
columns: [ "To Do" ],
isColumnArchived: () => false,
+ columnIcon: () => "bx bx-circle",
duplicateItem: vi.fn(async () => {})
} as unknown as BoardApi;
@@ -316,7 +336,8 @@ describe("Board item context menu", () => {
it("names the whole-way keys on the ends, and nothing on the columns beside", () => {
const api = {
columns: [ "To Do", "Doing", "Done", "Shipped" ],
- isColumnArchived: () => false
+ isColumnArchived: () => false,
+ columnIcon: () => "bx bx-circle"
} as unknown as BoardApi;
const moveTo = openItemMenu(api, "Doing").find(item =>
@@ -330,7 +351,8 @@ describe("Board item context menu", () => {
it("leaves the end a card already stands in bare", () => {
const api = {
columns: [ "To Do", "Doing", "Done" ],
- isColumnArchived: () => false
+ isColumnArchived: () => false,
+ columnIcon: () => "bx bx-circle"
} as unknown as BoardApi;
const moveTo = openItemMenu(api, "To Do").find(item =>
@@ -345,7 +367,8 @@ describe("Board item context menu", () => {
it("counts the end over an archived column rather than onto it", () => {
const api = {
columns: [ "To Do", "Doing", "Parked" ],
- isColumnArchived: (column: string) => column === "Parked"
+ isColumnArchived: (column: string) => column === "Parked",
+ columnIcon: () => "bx bx-circle"
} as unknown as BoardApi;
const moveTo = openItemMenu(api, "To Do").find(item =>
@@ -359,7 +382,8 @@ describe("Board item context menu", () => {
it("marks the archived columns it offers to move a card to", () => {
const api = {
columns: [ "To Do", "Done" ],
- isColumnArchived: (column: string) => column === "Done"
+ isColumnArchived: (column: string) => column === "Done",
+ columnIcon: () => "bx bx-circle"
} as unknown as BoardApi;
const moveTo = openItemMenu(api).find(item =>
diff --git a/apps/client/src/widgets/collections/board/context_menu.ts b/apps/client/src/widgets/collections/board/context_menu.ts
index 45fe72853c..747ef60e45 100644
--- a/apps/client/src/widgets/collections/board/context_menu.ts
+++ b/apps/client/src/widgets/collections/board/context_menu.ts
@@ -169,6 +169,7 @@ export function openNoteContextMenu(api: Api, event: ContextMenuEvent, note: FNo
// fair thing to want; the badge is there so it is not a surprise when it goes.
items: api.columns.map(columnToMoveTo => ({
title: columnToMoveTo,
+ uiIcon: api.columnIcon(columnToMoveTo),
enabled: columnToMoveTo !== column,
shortcut: endColumnKey(api, column, columnToMoveTo),
badges: api.isColumnArchived(columnToMoveTo)