Skip to content

Build your personal knowledge base with Trilium Notes

refactor(global-menu): show a row's shortcut through `FormListItem`

Elian Doran3a94662908fc
diff --git a/.claude/skills/building-client-ui/SKILL.md b/.claude/skills/building-client-ui/SKILL.md
index 20fbe951cf..538622c4de 100644
--- a/.claude/skills/building-client-ui/SKILL.md
+++ b/.claude/skills/building-client-ui/SKILL.md
@@ -70,7 +70,7 @@ Buttons and links:
- `Button` — the general button (also carries the tooltip for a *disabled* control via a wrapper, since a disabled `<button>` emits no pointer events). `ActionButton` — icon button with consistent styling. `SplitButton` — a button with its related actions in a `Dropdown` menu on a toggle beside it; its rows are `FormListItem`s.
- `HelpButton`, `HelpTooltipButton`, `HelpDropdown` — open in-app help pages; don't invent a new "?" affordance.
-- `KeyboardShortcut` — renders a shortcut as keycaps.
+- A menu row's shortcut is `FormListItem`'s `keyboardShortcut` (an action's configured keys) or `shortcut` (literal text); never put keycaps into its label by hand.
**Never hand-roll `<a className="tn-link">`.** Which link component to reach for depends on what the link *is*:
diff --git a/apps/client/src/widgets/buttons/global_menu.tsx b/apps/client/src/widgets/buttons/global_menu.tsx
index 29978fd07e..9e63a4a3b8 100644
--- a/apps/client/src/widgets/buttons/global_menu.tsx
+++ b/apps/client/src/widgets/buttons/global_menu.tsx
@@ -12,7 +12,6 @@ import utils, { isElectron, isMobile, isStandalone, reloadFrontendApp } from "..
import Dropdown from "../react/Dropdown";
import { FormDropdownDivider, FormDropdownSubmenu, FormListHeader, FormListItem } from "../react/FormList";
import { useStaticTooltip, useStaticTooltipWithKeyboardShortcut, useTriliumOption, useTriliumOptionBool } from "../react/hooks";
-import KeyboardShortcut from "../react/KeyboardShortcut";
import { ParentComponent } from "../react/react_utils";
interface MenuItemProps<T> {
@@ -23,6 +22,7 @@ interface MenuItemProps<T> {
disabled?: boolean
active?: boolean;
outsideChildren?: ComponentChildren;
+ keyboardShortcut?: KeyboardActionNames;
}
export default function GlobalMenu({ isHorizontalLayout }: { isHorizontalLayout: boolean }) {
@@ -145,23 +145,20 @@ function SwitchToOptions() {
}
-function MenuItem({ icon, text, title, command, disabled, active }: MenuItemProps<KeyboardActionNames | CommandNames | (() => void)>) {
+function MenuItem({ icon, text, title, command, disabled, active, keyboardShortcut }: MenuItemProps<KeyboardActionNames | CommandNames | (() => void)>) {
const parentComponent = useContext(ParentComponent);
return <FormListItem
icon={icon}
title={title}
+ keyboardShortcut={keyboardShortcut}
onClick={typeof command === "function" ? command : () => void parentComponent?.triggerCommand(command)}
disabled={disabled}
active={active}
>{text}</FormListItem>;
}
-function KeyboardActionMenuItem({ text, command, ...props }: MenuItemProps<KeyboardActionNames>) {
- return <MenuItem
- {...props}
- command={command}
- text={<>{text} <KeyboardShortcut actionName={command as KeyboardActionNames} /></>}
- />;
+function KeyboardActionMenuItem({ command, ...props }: MenuItemProps<KeyboardActionNames>) {
+ return <MenuItem {...props} command={command} keyboardShortcut={command} />;
}
export function VerticalLayoutIcon({ logoRef }: { logoRef?: RefObject<SVGSVGElement> }) {
diff --git a/apps/client/src/widgets/react/FormList.spec.tsx b/apps/client/src/widgets/react/FormList.spec.tsx
index edea7d921d..2024a2484a 100644
--- a/apps/client/src/widgets/react/FormList.spec.tsx
+++ b/apps/client/src/widgets/react/FormList.spec.tsx
@@ -7,10 +7,15 @@ vi.mock("bootstrap", () => ({
}));
const help = vi.hoisted(() => ({ open: vi.fn() }));
+const layout = vi.hoisted(() => ({ onMobile: false }));
vi.mock("../../services/utils", async (importOriginal) => ({
...(await importOriginal<typeof import("../../services/utils")>()),
+ isMobile: () => layout.onMobile,
openInAppHelpFromUrl: help.open
}));
+vi.mock("../../services/keyboard_actions", () => ({
+ getActionSync: () => ({ effectiveShortcuts: [ "CommandOrControl+Q" ] })
+}));
import FormList, { focusListItem, FormDropdownDivider, FormDropdownSubmenu, FormListCustomItem, FormListHeader, FormListItem, FormListToggleableItem } from "./FormList";
@@ -77,6 +82,29 @@ describe("FormListItem", () => {
]);
expect(span?.textContent).toBe("By titleCtrl+S");
});
+
+ it("shows no shortcuts on a phone, which has no keyboard to press them on", () => {
+ const host = document.createElement("div");
+ const rows = () => render((
+ <menu>
+ <FormListItem shortcut="Ctrl+S">Save</FormListItem>
+ <FormListItem keyboardShortcut="copyNotesToClipboard">Copy</FormListItem>
+ </menu>
+ ), host);
+ rows();
+ expect(host.querySelectorAll("kbd").length).toBeGreaterThan(1);
+ expect(host.querySelector(".keyboard-shortcut")).not.toBeNull();
+
+ layout.onMobile = true;
+ try {
+ rows();
+ expect(host.querySelector("kbd")).toBeNull();
+ expect(host.querySelector(".keyboard-shortcut")).toBeNull();
+ expect(host.textContent).toBe("SaveCopy");
+ } finally {
+ layout.onMobile = false;
+ }
+ });
});
describe("FormListItem presses", () => {
diff --git a/apps/client/src/widgets/react/FormList.tsx b/apps/client/src/widgets/react/FormList.tsx
index 8a0b392d36..e5cb781ebf 100644
--- a/apps/client/src/widgets/react/FormList.tsx
+++ b/apps/client/src/widgets/react/FormList.tsx
@@ -600,6 +600,8 @@ function actsOnClick(target: EventTarget | null, row: HTMLElement) {
* literal `shortcut`. Read synchronously, so the menu is placed at its final width.
*/
function FormListShortcut({ keyboardShortcut, shortcut }: Pick<FormListItemOpts, "keyboardShortcut" | "shortcut">) {
+ // A phone has no keyboard to press them on.
+ if (isMobile()) return null;
if (keyboardShortcut) {
const shortcuts = getActionSync(keyboardShortcut)?.effectiveShortcuts;
if (!shortcuts?.length) return null;
diff --git a/apps/client/src/widgets/react/KeyboardShortcut.tsx b/apps/client/src/widgets/react/KeyboardShortcut.tsx
deleted file mode 100644
index 601c88fc80..0000000000
--- a/apps/client/src/widgets/react/KeyboardShortcut.tsx
+++ /dev/null
@@ -1,30 +0,0 @@
-import { ActionKeyboardShortcut, KeyboardActionNames } from "@triliumnext/commons";
-import { useEffect, useState } from "preact/hooks";
-import keyboard_actions from "../../services/keyboard_actions";
-import { joinElements } from "./react_utils";
-import { renderShortcutKbds } from "./shortcut_kbd";
-import utils from "../../services/utils";
-
-interface KeyboardShortcutProps {
- actionName: KeyboardActionNames;
-}
-
-const isMobile = utils.isMobile();
-
-export default function KeyboardShortcut({ actionName }: KeyboardShortcutProps) {
-
- const [ action, setAction ] = useState<ActionKeyboardShortcut>();
- useEffect(() => {
- keyboard_actions.getAction(actionName).then(setAction);
- }, []);
-
- if (!action) {
- return <></>;
- }
-
- return (!isMobile &&
- <span className="keyboard-shortcut">
- {joinElements(action.effectiveShortcuts?.map((shortcut) => renderShortcutKbds(shortcut)))}
- </span>
- );
-}
\ No newline at end of file