Skip to content

Build your personal knowledge base with Trilium Notes

feat(bulk_actions): give each action a composite icon

Elian Doran489eade818f0
diff --git a/apps/client/src/widgets/bulk_actions/AddBulkActionButton.tsx b/apps/client/src/widgets/bulk_actions/AddBulkActionButton.tsx
index f9ecf777f5..e7b06e14e1 100644
--- a/apps/client/src/widgets/bulk_actions/AddBulkActionButton.tsx
+++ b/apps/client/src/widgets/bulk_actions/AddBulkActionButton.tsx
@@ -30,8 +30,8 @@ export default function AddBulkActionButton({ noteId, text, buttonClassName }: A
<FormListHeader text={title} />
<div>
- {actions.map(({ actionName, actionTitle }) => (
- <FormListItem key={actionName} onClick={() => bulk_action.addAction(noteId, actionName)}>{actionTitle}</FormListItem>
+ {actions.map(({ actionName, actionTitle, actionIcon }) => (
+ <FormListItem key={actionName} icon={actionIcon} onClick={() => bulk_action.addAction(noteId, actionName)}>{actionTitle}</FormListItem>
))}
</div>
</Fragment>
diff --git a/apps/client/src/widgets/bulk_actions/BulkAction.css b/apps/client/src/widgets/bulk_actions/BulkAction.css
new file mode 100644
index 0000000000..987d33c324
--- /dev/null
+++ b/apps/client/src/widgets/bulk_actions/BulkAction.css
@@ -0,0 +1,53 @@
+.tn-icon:is(
+ .bulk-action-marker-add,
+ .bulk-action-marker-update,
+ .bulk-action-marker-rename,
+ .bulk-action-marker-delete,
+ .bulk-action-marker-move,
+ .bulk-action-marker-convert
+) {
+ --bulk-action-marker-cutout: var(--card-background-color, var(--main-background-color));
+ position: relative;
+
+ &::after {
+ position: absolute;
+ inset-inline-end: -4px;
+ bottom: -3px;
+ font-family: boxicons;
+ font-size: 0.62em;
+ font-weight: normal;
+ line-height: 1;
+ text-shadow:
+ 0 0 2px var(--bulk-action-marker-cutout),
+ 0 0 2px var(--bulk-action-marker-cutout);
+ }
+}
+
+.action-add-menu .tn-icon {
+ --bulk-action-marker-cutout: var(--menu-background-color);
+}
+
+/* Codepoints from boxicons.css. */
+.bulk-action-marker-add::after {
+ content: "\ebc0"; /* bx-plus */
+}
+
+.bulk-action-marker-update::after {
+ content: "\ebb1"; /* bx-pencil */
+}
+
+.bulk-action-marker-rename::after {
+ content: "\ebdb"; /* bx-rename */
+}
+
+.bulk-action-marker-delete::after {
+ content: "\ec8d"; /* bx-x */
+}
+
+.bulk-action-marker-move::after {
+ content: "\ebe6"; /* bx-right-arrow-alt */
+}
+
+.bulk-action-marker-convert::after {
+ content: "\ec0e"; /* bx-shuffle */
+}
diff --git a/apps/client/src/widgets/bulk_actions/BulkAction.tsx b/apps/client/src/widgets/bulk_actions/BulkAction.tsx
index fd151aa170..497bdbae0d 100644
--- a/apps/client/src/widgets/bulk_actions/BulkAction.tsx
+++ b/apps/client/src/widgets/bulk_actions/BulkAction.tsx
@@ -1,7 +1,10 @@
+import "./BulkAction.css";
+
import { ComponentChildren } from "preact";
import { memo } from "preact/compat";
import AbstractBulkAction from "./abstract_bulk_action";
import HelpRemoveButtons from "../react/HelpRemoveButtons";
+import Icon from "../react/Icon";
interface BulkActionProps {
label: string | ComponentChildren;
@@ -16,11 +19,15 @@ const labelStyle = { marginInlineEnd: "10px" } as const;
const textStyle = { marginInlineEnd: "10px", marginInlineStart: "10px" } as const;
const BulkAction = memo(({ label, children, helpText, bulkAction }: BulkActionProps) => {
+ const { actionIcon } = bulkAction.constructor as typeof AbstractBulkAction;
+
return (
<tr>
<td colSpan={2}>
<div style={flexContainerStyle}>
- <div style={labelStyle} className="text-nowrap">{label}</div>
+ <div style={labelStyle} className="text-nowrap">
+ {actionIcon && <Icon icon={actionIcon} className="bulk-action-icon" />}{" "}{label}
+ </div>
{children}
</div>
diff --git a/apps/client/src/widgets/bulk_actions/abstract_bulk_action.ts b/apps/client/src/widgets/bulk_actions/abstract_bulk_action.ts
index d7473b4456..6c19f9764f 100644
--- a/apps/client/src/widgets/bulk_actions/abstract_bulk_action.ts
+++ b/apps/client/src/widgets/bulk_actions/abstract_bulk_action.ts
@@ -43,6 +43,14 @@ export default abstract class AbstractBulkAction {
return "";
}
+ /**
+ * The action's icon, shown in the add menu and on its row: a boxicons class for what it acts on,
+ * plus a `bulk-action-marker-*` class for the corner glyph saying what it does.
+ */
+ static get actionIcon() {
+ return "";
+ }
+
async saveAction(data: {}) {
const actionObject = Object.assign({ name: (this.constructor as typeof AbstractBulkAction).actionName }, data);
diff --git a/apps/client/src/widgets/bulk_actions/execute_script.tsx b/apps/client/src/widgets/bulk_actions/execute_script.tsx
index aef6c25057..7af8f2d253 100644
--- a/apps/client/src/widgets/bulk_actions/execute_script.tsx
+++ b/apps/client/src/widgets/bulk_actions/execute_script.tsx
@@ -42,6 +42,9 @@ export default class ExecuteScriptBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("execute_script.execute_script");
}
+ static get actionIcon() {
+ return "bx bx-play";
+ }
doRender() {
return <ExecuteScriptBulkActionComponent bulkAction={this} actionDef={this.actionDef} />
diff --git a/apps/client/src/widgets/bulk_actions/label/add_label.tsx b/apps/client/src/widgets/bulk_actions/label/add_label.tsx
index 18bcd1944f..e8fdabc1bf 100644
--- a/apps/client/src/widgets/bulk_actions/label/add_label.tsx
+++ b/apps/client/src/widgets/bulk_actions/label/add_label.tsx
@@ -54,4 +54,7 @@ export default class AddLabelBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("add_label.add_label");
}
+ static get actionIcon() {
+ return "bx bx-hash bulk-action-marker-add";
+ }
}
diff --git a/apps/client/src/widgets/bulk_actions/label/delete_label.tsx b/apps/client/src/widgets/bulk_actions/label/delete_label.tsx
index 639c1003ca..b7ce0c731e 100644
--- a/apps/client/src/widgets/bulk_actions/label/delete_label.tsx
+++ b/apps/client/src/widgets/bulk_actions/label/delete_label.tsx
@@ -32,6 +32,9 @@ export default class DeleteLabelBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("delete_label.delete_label");
}
+ static get actionIcon() {
+ return "bx bx-hash bulk-action-marker-delete";
+ }
doRender() {
return <DeleteLabelBulkActionComponent bulkAction={this} actionDef={this.actionDef} />
diff --git a/apps/client/src/widgets/bulk_actions/label/rename_label.tsx b/apps/client/src/widgets/bulk_actions/label/rename_label.tsx
index e5a8a83131..bdc4728744 100644
--- a/apps/client/src/widgets/bulk_actions/label/rename_label.tsx
+++ b/apps/client/src/widgets/bulk_actions/label/rename_label.tsx
@@ -42,6 +42,9 @@ export default class RenameLabelBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("rename_label.rename_label");
}
+ static get actionIcon() {
+ return "bx bx-hash bulk-action-marker-rename";
+ }
doRender() {
return <RenameLabelBulkActionComponent bulkAction={this} actionDef={this.actionDef} />
diff --git a/apps/client/src/widgets/bulk_actions/label/update_label_value.tsx b/apps/client/src/widgets/bulk_actions/label/update_label_value.tsx
index 4da79076e0..56f8c17a33 100644
--- a/apps/client/src/widgets/bulk_actions/label/update_label_value.tsx
+++ b/apps/client/src/widgets/bulk_actions/label/update_label_value.tsx
@@ -43,6 +43,9 @@ export default class UpdateLabelValueBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("update_label_value.update_label_value");
}
+ static get actionIcon() {
+ return "bx bx-hash bulk-action-marker-update";
+ }
doRender() {
return <UpdateLabelValueComponent bulkAction={this} actionDef={this.actionDef} />;
diff --git a/apps/client/src/widgets/bulk_actions/note/convert_note.tsx b/apps/client/src/widgets/bulk_actions/note/convert_note.tsx
index 3eefc62a66..e7238fde5d 100644
--- a/apps/client/src/widgets/bulk_actions/note/convert_note.tsx
+++ b/apps/client/src/widgets/bulk_actions/note/convert_note.tsx
@@ -65,4 +65,7 @@ export default class ConvertNoteBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("convert_note.convert_note");
}
+ static get actionIcon() {
+ return "bx bx-note bulk-action-marker-convert";
+ }
}
diff --git a/apps/client/src/widgets/bulk_actions/note/delete_note.tsx b/apps/client/src/widgets/bulk_actions/note/delete_note.tsx
index 3879f18583..bca5176f90 100644
--- a/apps/client/src/widgets/bulk_actions/note/delete_note.tsx
+++ b/apps/client/src/widgets/bulk_actions/note/delete_note.tsx
@@ -26,6 +26,9 @@ export default class DeleteNoteBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("delete_note.delete_note");
}
+ static get actionIcon() {
+ return "bx bx-note bulk-action-marker-delete destructive-action-icon";
+ }
doRender() {
return <DeleteNoteBulkActionComponent bulkAction={this} />
diff --git a/apps/client/src/widgets/bulk_actions/note/delete_revisions.tsx b/apps/client/src/widgets/bulk_actions/note/delete_revisions.tsx
index 40e33a2d81..929dca80e0 100644
--- a/apps/client/src/widgets/bulk_actions/note/delete_revisions.tsx
+++ b/apps/client/src/widgets/bulk_actions/note/delete_revisions.tsx
@@ -21,6 +21,9 @@ export default class DeleteRevisionsBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("delete_revisions.delete_note_revisions");
}
+ static get actionIcon() {
+ return "bx bx-history bulk-action-marker-delete destructive-action-icon";
+ }
doRender() {
return <DeleteRevisionsBulkActionComponent bulkAction={this} />
diff --git a/apps/client/src/widgets/bulk_actions/note/move_note.tsx b/apps/client/src/widgets/bulk_actions/note/move_note.tsx
index 4290726ce4..407aa06e2e 100644
--- a/apps/client/src/widgets/bulk_actions/note/move_note.tsx
+++ b/apps/client/src/widgets/bulk_actions/note/move_note.tsx
@@ -43,6 +43,9 @@ export default class MoveNoteBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("move_note.move_note");
}
+ static get actionIcon() {
+ return "bx bx-note bulk-action-marker-move";
+ }
doRender() {
return <MoveNoteBulkActionComponent bulkAction={this} />
diff --git a/apps/client/src/widgets/bulk_actions/note/rename_note.tsx b/apps/client/src/widgets/bulk_actions/note/rename_note.tsx
index 682494cd25..d9d13a417f 100644
--- a/apps/client/src/widgets/bulk_actions/note/rename_note.tsx
+++ b/apps/client/src/widgets/bulk_actions/note/rename_note.tsx
@@ -44,6 +44,9 @@ export default class RenameNoteBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("rename_note.rename_note");
}
+ static get actionIcon() {
+ return "bx bx-note bulk-action-marker-rename";
+ }
doRender() {
return <RenameNoteBulkActionComponent bulkAction={this} actionDef={this.actionDef} />
diff --git a/apps/client/src/widgets/bulk_actions/note/save_revision.tsx b/apps/client/src/widgets/bulk_actions/note/save_revision.tsx
index 51aafd10a3..d695acac9e 100644
--- a/apps/client/src/widgets/bulk_actions/note/save_revision.tsx
+++ b/apps/client/src/widgets/bulk_actions/note/save_revision.tsx
@@ -40,6 +40,9 @@ export default class SaveRevisionBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("save_revision.save_revision");
}
+ static get actionIcon() {
+ return "bx bx-history bulk-action-marker-add";
+ }
doRender() {
return <SaveRevisionBulkActionComponent bulkAction={this} actionDef={this.actionDef} />;
diff --git a/apps/client/src/widgets/bulk_actions/relation/add_relation.tsx b/apps/client/src/widgets/bulk_actions/relation/add_relation.tsx
index 59d222ee86..76c9296633 100644
--- a/apps/client/src/widgets/bulk_actions/relation/add_relation.tsx
+++ b/apps/client/src/widgets/bulk_actions/relation/add_relation.tsx
@@ -44,6 +44,9 @@ export default class AddRelationBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("add_relation.add_relation");
}
+ static get actionIcon() {
+ return "bx bx-transfer bulk-action-marker-add";
+ }
doRender() {
return <AddRelationBulkActionComponent bulkAction={this} actionDef={this.actionDef} />
diff --git a/apps/client/src/widgets/bulk_actions/relation/delete_relation.tsx b/apps/client/src/widgets/bulk_actions/relation/delete_relation.tsx
index bf8e3f352c..75b67d8a53 100644
--- a/apps/client/src/widgets/bulk_actions/relation/delete_relation.tsx
+++ b/apps/client/src/widgets/bulk_actions/relation/delete_relation.tsx
@@ -34,6 +34,9 @@ export default class DeleteRelationBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("delete_relation.delete_relation");
}
+ static get actionIcon() {
+ return "bx bx-transfer bulk-action-marker-delete";
+ }
doRender() {
return <DeleteRelationBulkActionComponent bulkAction={this} actionDef={this.actionDef} />
diff --git a/apps/client/src/widgets/bulk_actions/relation/rename_relation.tsx b/apps/client/src/widgets/bulk_actions/relation/rename_relation.tsx
index b0ce548340..a333667717 100644
--- a/apps/client/src/widgets/bulk_actions/relation/rename_relation.tsx
+++ b/apps/client/src/widgets/bulk_actions/relation/rename_relation.tsx
@@ -42,6 +42,9 @@ export default class RenameRelationBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("rename_relation.rename_relation");
}
+ static get actionIcon() {
+ return "bx bx-transfer bulk-action-marker-rename";
+ }
doRender() {
return <RenameRelationBulkActionComponent bulkAction={this} actionDef={this.actionDef} />
diff --git a/apps/client/src/widgets/bulk_actions/relation/update_relation_target.tsx b/apps/client/src/widgets/bulk_actions/relation/update_relation_target.tsx
index b2d5935442..d54477e8b3 100644
--- a/apps/client/src/widgets/bulk_actions/relation/update_relation_target.tsx
+++ b/apps/client/src/widgets/bulk_actions/relation/update_relation_target.tsx
@@ -52,6 +52,9 @@ export default class UpdateRelationTargetBulkAction extends AbstractBulkAction {
static get actionTitle() {
return t("update_relation_target.update_relation_target");
}
+ static get actionIcon() {
+ return "bx bx-transfer bulk-action-marker-update";
+ }
doRender() {
return <UpdateRelationTargetComponent bulkAction={this} actionDef={this.actionDef} />
diff --git a/apps/client/src/widgets/dialogs/bulk_actions.spec.tsx b/apps/client/src/widgets/dialogs/bulk_actions.spec.tsx
index 475104cfbb..ee46caf072 100644
--- a/apps/client/src/widgets/dialogs/bulk_actions.spec.tsx
+++ b/apps/client/src/widgets/dialogs/bulk_actions.spec.tsx
@@ -80,6 +80,7 @@ describe("BulkActionsDialog", () => {
const item = [ ...document.querySelectorAll<HTMLElement>(".action-add-menu .dropdown-item") ]
.find((el) => el.textContent?.includes("move_note.move_note"));
expect(item).toBeDefined();
+ expect(item?.querySelector(".bx-note.bulk-action-marker-move")).not.toBeNull();
await act(async () => item?.click());
expect(server.post).toHaveBeenCalledWith("notes/_bulkAction/attributes", {
@@ -89,6 +90,17 @@ describe("BulkActionsDialog", () => {
});
});
+ it("marks each chosen action with its icon", async () => {
+ buildNote({ id: "_bulkAction", title: "Bulk action", "#action": JSON.stringify({ name: "deleteNote" }) });
+ await open([ "n1" ]);
+ expect(container.querySelectorAll(".bulk-existing-action-list tr")).toHaveLength(1);
+
+ const icon = container.querySelector(".bulk-existing-action-list .bulk-action-icon");
+ expect(icon?.classList.contains("bx-note")).toBe(true);
+ expect(icon?.classList.contains("bulk-action-marker-delete")).toBe(true);
+ expect(icon?.classList.contains("destructive-action-icon")).toBe(true);
+ });
+
it("drops a removed chip from the notes the actions apply to, keeping the last one", async () => {
await open([ "n1", "n2" ]);
expect(lastAffectedNotesRequest()).toStrictEqual({ noteIds: [ "n1", "n2" ], includeDescendants: false });