Merge pull request #13124 from gitbutlerapp/push-lsowvtzstkst

Lite: keyboard shortcut fixes

Author: OliverJAsh

apps/lite/ui/src/routes/project/$id/branches/route.tsx

@@ -87,7 +87,7 @@ const useSelectionKeyboardShortcuts = ({
 
 	const handleKeyDown = useEffectEvent((event: KeyboardEvent) => {
 		if (event.defaultPrevented || event.repeat) return;
-		if (event.metaKey || event.ctrlKey || event.altKey) return;
+		if (event.metaKey || event.ctrlKey || event.altKey || event.shiftKey) return;
 		if (isTypingTarget(event.target)) return;
 		if (selection?._tag !== "Commit") return;
 

apps/lite/ui/src/routes/project/$id/workspace/-WorkspaceShortcuts.ts

@@ -31,8 +31,8 @@ import {
 
 type SelectionAction =
 	| { _tag: "Move"; offset: -1 | 1 }
-	| { _tag: "NextSection" }
 	| { _tag: "PreviousSection" }
+	| { _tag: "NextSection" }
 	| { _tag: "TogglePreview" }
 	| { _tag: "OpenFullscreenPreview" };
 
@@ -71,18 +71,18 @@ const selectionBindings: Array<ShortcutBinding<SelectionAction>> = [
 		keys: ["ArrowDown", "j"],
 		action: { _tag: "Move", offset: 1 },
 	},
-	{
-		id: "next-section",
-		description: "Next section",
-		keys: ["J"],
-		action: { _tag: "NextSection" },
-	},
 	{
 		id: "previous-section",
 		description: "Previous section",
-		keys: ["K"],
+		keys: ["Shift+ArrowUp", "Shift+k"],
 		action: { _tag: "PreviousSection" },
 	},
+	{
+		id: "next-section",
+		description: "Next section",
+		keys: ["Shift+ArrowDown", "Shift+j"],
+		action: { _tag: "NextSection" },
+	},
 	togglePreviewBinding,
 	openFullscreenPreviewBinding,
 ];
@@ -193,17 +193,12 @@ export const handleCommitEditingMessageKeyDown = ({
 	const action = getAction(commitEditingMessageBindings, event);
 	if (!action) return;
 
+	event.preventDefault();
+
 	Match.value(action).pipe(
 		Match.tagsExhaustive({
-			Save: () => {
-				if (event.shiftKey) return;
-				event.preventDefault();
-				onSave();
-			},
-			Cancel: () => {
-				event.preventDefault();
-				onCancel();
-			},
+			Save: onSave,
+			Cancel: onCancel,
 		}),
 	);
 };
@@ -464,17 +459,17 @@ export const useWorkspaceShortcuts = ({
 
 	const move = (offset: -1 | 1, selection: Item) =>
 		select(getAdjacentItem(navigationModel, selection, offset));
-	const nextSection = (selection: Item) =>
-		select(getAdjacentSection(navigationModel, selection, 1));
 	const previousSection = (selection: Item) =>
 		select(getParentSection(selection) ?? getAdjacentSection(navigationModel, selection, -1));
+	const nextSection = (selection: Item) =>
+		select(getAdjacentSection(navigationModel, selection, 1));
 
 	const handleSelectionAction = (action: SelectionAction, selection: Item) =>
 		Match.value(action).pipe(
 			Match.tagsExhaustive({
 				Move: ({ offset }) => move(offset, selection),
-				NextSection: () => nextSection(selection),
 				PreviousSection: () => previousSection(selection),
+				NextSection: () => nextSection(selection),
 				TogglePreview: () => setShowPreviewPanel((visible) => !visible),
 				OpenFullscreenPreview: () => setShowFullscreenPreview(true),
 			}),
@@ -546,7 +541,6 @@ export const useWorkspaceShortcuts = ({
 
 	const handleKeyDown = useEffectEvent((event: KeyboardEvent) => {
 		if (event.defaultPrevented) return;
-		if (event.metaKey || event.ctrlKey || event.altKey) return;
 		if (isTypingTarget(event.target)) return;
 		if (isWithinBaseUiInert(event.target)) return;
 

apps/lite/ui/src/shortcuts.ts

@@ -12,33 +12,98 @@ export type ShortcutBinding<Action extends ShortcutActionBase> = {
 	repeat?: boolean;
 };
 
+const normalizeShortcutKey = (key: string): string => (key.length === 1 ? key.toLowerCase() : key);
+
+type ParsedShortcutKey = {
+	key: string;
+	altKey: boolean;
+	ctrlKey: boolean;
+	metaKey: boolean;
+	shiftKey: boolean;
+};
+
+const parseShortcutKey = (shortcutKey: string): ParsedShortcutKey => {
+	const parsed: ParsedShortcutKey = {
+		key: "",
+		altKey: false,
+		ctrlKey: false,
+		metaKey: false,
+		shiftKey: false,
+	};
+
+	for (const part of shortcutKey.split("+"))
+		switch (part) {
+			case "Alt":
+				parsed.altKey = true;
+				break;
+			case "Ctrl":
+				parsed.ctrlKey = true;
+				break;
+			case "Meta":
+				parsed.metaKey = true;
+				break;
+			case "Shift":
+				parsed.shiftKey = true;
+				break;
+			default:
+				parsed.key = normalizeShortcutKey(part);
+		}
+
+	return parsed;
+};
+
+const eventMatchesShortcutKey = (event: KeyboardEvent, shortcutKey: string): boolean => {
+	const parsed = parseShortcutKey(shortcutKey);
+	if (parsed.key === "") return false;
+
+	return (
+		normalizeShortcutKey(event.key) === parsed.key &&
+		event.altKey === parsed.altKey &&
+		event.ctrlKey === parsed.ctrlKey &&
+		event.metaKey === parsed.metaKey &&
+		event.shiftKey === parsed.shiftKey
+	);
+};
+
 export const getAction = <Action extends ShortcutActionBase>(
 	bindings: Array<ShortcutBinding<Action>>,
 	event: KeyboardEvent,
 ): Action | null => {
 	for (const binding of bindings) {
-		if (!binding.keys.includes(event.key)) continue;
+		if (!binding.keys.some((shortcutKey) => eventMatchesShortcutKey(event, shortcutKey))) continue;
 		if (binding.repeat === false && event.repeat) continue;
 		return binding.action;
 	}
 
 	return null;
 };
 
+const formatShortcutKey = (key: string): string => {
+	const parsed = parseShortcutKey(key);
+	if (parsed.key === "") return key;
+
+	const modifiers = [
+		parsed.ctrlKey ? "ctrl" : null,
+		parsed.altKey ? "alt" : null,
+		parsed.shiftKey ? "shift" : null,
+		parsed.metaKey ? "meta" : null,
+	].filter((modifier) => modifier !== null);
+
+	const formattedKey = Match.value(parsed.key).pipe(
+		Match.when("ArrowUp", () => "↑"),
+		Match.when("ArrowDown", () => "↓"),
+		Match.when("ArrowLeft", () => "←"),
+		Match.when("ArrowRight", () => "→"),
+		Match.when("Escape", () => "esc"),
+		Match.when("Enter", () => "enter"),
+		Match.orElse(() => parsed.key),
+	);
+
+	return [...modifiers, formattedKey].join("+");
+};
+
 export const formatShortcutKeys = (keys: Array<string>): string =>
-	keys
-		.map((key) =>
-			Match.value(key).pipe(
-				Match.when("ArrowUp", () => "↑"),
-				Match.when("ArrowDown", () => "↓"),
-				Match.when("ArrowLeft", () => "←"),
-				Match.when("ArrowRight", () => "→"),
-				Match.when("Escape", () => "esc"),
-				Match.when("Enter", () => "enter"),
-				Match.orElse(() => key),
-			),
-		)
-		.join("/");
+	keys.map((key) => formatShortcutKey(key)).join("/");
 
 export const bindingButtonLabel = (binding: ShortcutBinding<ShortcutActionBase>): string =>
 	`${binding.description} (${formatShortcutKeys(binding.keys)})`;