potentially fix cross-platform keybinding handling Naming at the very

least.
This commit is contained in:
CJ Pais 2025-08-02 19:03:56 -07:00
parent 98eb336ab0
commit 32a630cc52
2 changed files with 110 additions and 70 deletions

View file

@ -1,7 +1,12 @@
import React, { useEffect, useState, useRef } from "react"; import React, { useEffect, useState, useRef } from "react";
import { BindingResponseSchema, ShortcutBindingsMap } from "../../lib/types"; import { BindingResponseSchema, ShortcutBindingsMap } from "../../lib/types";
import { type } from "@tauri-apps/plugin-os"; import { type } from "@tauri-apps/plugin-os";
import { getKeyName } from "../../lib/utils/keyboard"; import {
getKeyName,
formatKeyCombination,
normalizeKey,
type OSType,
} from "../../lib/utils/keyboard";
import ResetIcon from "../icons/ResetIcon"; import ResetIcon from "../icons/ResetIcon";
import { SettingContainer } from "../ui/SettingContainer"; import { SettingContainer } from "../ui/SettingContainer";
import { useSettings } from "../../hooks/useSettings"; import { useSettings } from "../../hooks/useSettings";
@ -24,57 +29,42 @@ export const HandyShortcut: React.FC<HandyShortcutProps> = ({
null, null,
); );
const [originalBinding, setOriginalBinding] = useState<string>(""); const [originalBinding, setOriginalBinding] = useState<string>("");
const [isMacOS, setIsMacOS] = useState<boolean>(false); const [osType, setOsType] = useState<OSType>("unknown");
const shortcutRefs = useRef<Map<string, HTMLDivElement | null>>(new Map()); const shortcutRefs = useRef<Map<string, HTMLDivElement | null>>(new Map());
const bindings = getSetting("bindings") || {}; const bindings = getSetting("bindings") || {};
// Check if running on macOS // Detect and store OS type
useEffect(() => { useEffect(() => {
const checkOsType = async () => { const detectOsType = async () => {
try { try {
const osType = await type(); const detectedType = await type();
setIsMacOS(osType === "macos"); let normalizedType: OSType;
switch (detectedType) {
case "macos":
normalizedType = "macos";
break;
case "windows":
normalizedType = "windows";
break;
case "linux":
normalizedType = "linux";
break;
default:
normalizedType = "unknown";
}
setOsType(normalizedType);
} catch (error) { } catch (error) {
console.error("Error detecting OS type:", error); console.error("Error detecting OS type:", error);
setIsMacOS(false); setOsType("unknown");
} }
}; };
checkOsType(); detectOsType();
}, []); }, []);
// Normalize modifier keys (unify left/right variants)
const normalizeKey = (key: string): string => {
// Handle left/right variants of modifier keys
if (key.startsWith("left ") || key.startsWith("right ")) {
const parts = key.split(" ");
if (parts.length === 2) {
// Return just the modifier name without left/right prefix
return parts[1];
}
}
return key;
};
// Format keys for macOS display
const formatMacOSKeys = (key: string): string => {
if (!isMacOS) return key; // Only format for macOS
const keyMap: Record<string, string> = {
alt: "option",
};
return keyMap[key.toLowerCase()] || key;
};
// Format a key combination for display
const formatKeyCombination = (combination: string): string => {
if (!isMacOS) return combination; // Only format for macOS
return combination.split("+").map(formatMacOSKeys).join(" + ");
};
useEffect(() => { useEffect(() => {
// Only add event listeners when we're in editing mode // Only add event listeners when we're in editing mode
if (editingShortcutId === null) return; if (editingShortcutId === null) return;
@ -99,8 +89,8 @@ export const HandyShortcut: React.FC<HandyShortcutProps> = ({
} }
e.preventDefault(); e.preventDefault();
// Get the key and normalize it (unify left/right modifiers) // Get the key with OS-specific naming and normalize it
const rawKey = getKeyName(e); const rawKey = getKeyName(e, osType);
const key = normalizeKey(rawKey); const key = normalizeKey(rawKey);
console.log("You pressed", rawKey, "normalized to", key); console.log("You pressed", rawKey, "normalized to", key);
@ -117,8 +107,8 @@ export const HandyShortcut: React.FC<HandyShortcutProps> = ({
const handleKeyUp = async (e: KeyboardEvent) => { const handleKeyUp = async (e: KeyboardEvent) => {
e.preventDefault(); e.preventDefault();
// Get the key and normalize it // Get the key with OS-specific naming and normalize it
const rawKey = getKeyName(e); const rawKey = getKeyName(e, osType);
const key = normalizeKey(rawKey); const key = normalizeKey(rawKey);
// Remove from currently pressed keys // Remove from currently pressed keys
@ -183,6 +173,7 @@ export const HandyShortcut: React.FC<HandyShortcutProps> = ({
bindings, bindings,
originalBinding, originalBinding,
updateBinding, updateBinding,
osType,
]); ]);
// Start recording a new shortcut // Start recording a new shortcut
@ -200,15 +191,11 @@ export const HandyShortcut: React.FC<HandyShortcutProps> = ({
}; };
// Format the current shortcut keys being recorded // Format the current shortcut keys being recorded
const formatCurrentKeys = () => { const formatCurrentKeys = (): string => {
if (recordedKeys.length === 0) return "Press keys..."; if (recordedKeys.length === 0) return "Press keys...";
if (!isMacOS) { // Use the same formatting as the display to ensure consistency
return recordedKeys.join("+"); return formatKeyCombination(recordedKeys.join("+"), osType);
}
// Map each key to its macOS-friendly name for display
return recordedKeys.map(formatMacOSKeys).join(" + ");
}; };
// Store references to shortcut elements // Store references to shortcut elements
@ -275,7 +262,7 @@ export const HandyShortcut: React.FC<HandyShortcutProps> = ({
className="px-2 py-1 text-sm font-semibold bg-mid-gray/10 border border-mid-gray/80 hover:bg-logo-primary/10 rounded cursor-pointer hover:border-logo-primary" className="px-2 py-1 text-sm font-semibold bg-mid-gray/10 border border-mid-gray/80 hover:bg-logo-primary/10 rounded cursor-pointer hover:border-logo-primary"
onClick={() => startRecording(primaryId)} onClick={() => startRecording(primaryId)}
> >
{formatKeyCombination(primaryBinding.current_binding)} {formatKeyCombination(primaryBinding.current_binding, osType)}
</div> </div>
)} )}
<button <button

View file

@ -2,12 +2,17 @@
* Keyboard utility functions for handling keyboard events * Keyboard utility functions for handling keyboard events
*/ */
export type OSType = "macos" | "windows" | "linux" | "unknown";
/** /**
* Extract a consistent key name from a KeyboardEvent * Extract a consistent key name from a KeyboardEvent
* This function replaces the keycode library and provides better support * This function provides cross-platform keyboard event handling
* for extended function keys (F14+) and cross-platform compatibility * and returns key names appropriate for the target operating system
*/ */
export const getKeyName = (e: KeyboardEvent): string => { export const getKeyName = (
e: KeyboardEvent,
osType: OSType = "unknown",
): string => {
// Handle special cases first // Handle special cases first
if (e.code) { if (e.code) {
const code = e.code; const code = e.code;
@ -32,18 +37,36 @@ export const getKeyName = (e: KeyboardEvent): string => {
return code.replace("Numpad", "numpad ").toLowerCase(); return code.replace("Numpad", "numpad ").toLowerCase();
} }
// Handle modifier keys - normalize left/right variants // Handle modifier keys - OS-specific naming
const getModifierName = (baseModifier: string): string => {
switch (baseModifier) {
case "shift":
return "shift";
case "ctrl":
return osType === "macos" ? "ctrl" : "ctrl";
case "alt":
return osType === "macos" ? "option" : "alt";
case "meta":
// Windows key on Windows/Linux, Command key on Mac
if (osType === "macos") return "command";
if (osType === "windows") return "win";
return "super"; // Linux convention
default:
return baseModifier;
}
};
const modifierMap: Record<string, string> = { const modifierMap: Record<string, string> = {
ShiftLeft: "shift", ShiftLeft: getModifierName("shift"),
ShiftRight: "shift", ShiftRight: getModifierName("shift"),
ControlLeft: "ctrl", ControlLeft: getModifierName("ctrl"),
ControlRight: "ctrl", ControlRight: getModifierName("ctrl"),
AltLeft: "alt", AltLeft: getModifierName("alt"),
AltRight: "alt", AltRight: getModifierName("alt"),
MetaLeft: "command", MetaLeft: getModifierName("meta"),
MetaRight: "command", MetaRight: getModifierName("meta"),
OSLeft: "command", OSLeft: getModifierName("meta"),
OSRight: "command", OSRight: getModifierName("meta"),
CapsLock: "caps lock", CapsLock: "caps lock",
Tab: "tab", Tab: "tab",
Enter: "enter", Enter: "enter",
@ -103,13 +126,15 @@ export const getKeyName = (e: KeyboardEvent): string => {
if (e.key) { if (e.key) {
const key = e.key; const key = e.key;
// Handle special key names // Handle special key names with OS-specific formatting
const keyMap: Record<string, string> = { const keyMap: Record<string, string> = {
Control: "ctrl", Control: osType === "macos" ? "ctrl" : "ctrl",
Alt: "alt", Alt: osType === "macos" ? "option" : "alt",
Shift: "shift", Shift: "shift",
Meta: "command", Meta:
OS: "command", osType === "macos" ? "command" : osType === "windows" ? "win" : "super",
OS:
osType === "macos" ? "command" : osType === "windows" ? "win" : "super",
CapsLock: "caps lock", CapsLock: "caps lock",
ArrowUp: "up", ArrowUp: "up",
ArrowDown: "down", ArrowDown: "down",
@ -129,3 +154,31 @@ export const getKeyName = (e: KeyboardEvent): string => {
// Last resort fallback // Last resort fallback
return `unknown-${e.keyCode || e.which || 0}`; return `unknown-${e.keyCode || e.which || 0}`;
}; };
/**
* Get display-friendly key combination string for the current OS
* Returns basic plus-separated format with correct platform key names
*/
export const formatKeyCombination = (
combination: string,
osType: OSType,
): string => {
// Simply return the combination as-is since getKeyName already provides
// the correct platform-specific key names
return combination;
};
/**
* Normalize modifier keys to handle left/right variants
*/
export const normalizeKey = (key: string): string => {
// Handle left/right variants of modifier keys
if (key.startsWith("left ") || key.startsWith("right ")) {
const parts = key.split(" ");
if (parts.length === 2) {
// Return just the modifier name without left/right prefix
return parts[1];
}
}
return key;
};