a497fccd06
Follow-up to #717. Replaces all remaining hardcoded keybinding hints with configurable ones. - Add pasteImage to AppAction so it can be configured in keybindings.json - Create keybinding-hints.ts with reusable helper functions: - editorKey(action) / appKey(keybindings, action) - get key display string - keyHint(action, desc) / appKeyHint(kb, action, desc) / rawKeyHint(key, desc) - styled hints - Export helpers from components/index.ts for extensions - Update all components to use configured keybindings - Remove now-unused getDisplayString() from KeybindingsManager and EditorKeybindingsManager - Use keybindings.matches() instead of matchesKey() for pasteImage in custom-editor.ts
67 lines
2.3 KiB
TypeScript
67 lines
2.3 KiB
TypeScript
/**
|
|
* Utilities for formatting keybinding hints in the UI.
|
|
*/
|
|
|
|
import { type EditorAction, getEditorKeybindings, type KeyId } from "@mariozechner/pi-tui";
|
|
import type { AppAction, KeybindingsManager } from "../../../core/keybindings.js";
|
|
import { theme } from "../theme/theme.js";
|
|
|
|
/**
|
|
* Format keys array as display string (e.g., ["ctrl+c", "escape"] -> "ctrl+c/escape").
|
|
*/
|
|
function formatKeys(keys: KeyId[]): string {
|
|
if (keys.length === 0) return "";
|
|
if (keys.length === 1) return keys[0]!;
|
|
return keys.join("/");
|
|
}
|
|
|
|
/**
|
|
* Get display string for an editor action.
|
|
*/
|
|
export function editorKey(action: EditorAction): string {
|
|
return formatKeys(getEditorKeybindings().getKeys(action));
|
|
}
|
|
|
|
/**
|
|
* Get display string for an app action.
|
|
*/
|
|
export function appKey(keybindings: KeybindingsManager, action: AppAction): string {
|
|
return formatKeys(keybindings.getKeys(action));
|
|
}
|
|
|
|
/**
|
|
* Format a keybinding hint with consistent styling: dim key, muted description.
|
|
* Looks up the key from editor keybindings automatically.
|
|
*
|
|
* @param action - Editor action name (e.g., "selectConfirm", "expandTools")
|
|
* @param description - Description text (e.g., "to expand", "cancel")
|
|
* @returns Formatted string with dim key and muted description
|
|
*/
|
|
export function keyHint(action: EditorAction, description: string): string {
|
|
return theme.fg("dim", editorKey(action)) + theme.fg("muted", ` ${description}`);
|
|
}
|
|
|
|
/**
|
|
* Format a keybinding hint for app-level actions.
|
|
* Requires the KeybindingsManager instance.
|
|
*
|
|
* @param keybindings - KeybindingsManager instance
|
|
* @param action - App action name (e.g., "interrupt", "externalEditor")
|
|
* @param description - Description text
|
|
* @returns Formatted string with dim key and muted description
|
|
*/
|
|
export function appKeyHint(keybindings: KeybindingsManager, action: AppAction, description: string): string {
|
|
return theme.fg("dim", appKey(keybindings, action)) + theme.fg("muted", ` ${description}`);
|
|
}
|
|
|
|
/**
|
|
* Format a raw key string with description (for non-configurable keys like ↑↓).
|
|
*
|
|
* @param key - Raw key string
|
|
* @param description - Description text
|
|
* @returns Formatted string with dim key and muted description
|
|
*/
|
|
export function rawKeyHint(key: string, description: string): string {
|
|
return theme.fg("dim", key) + theme.fg("muted", ` ${description}`);
|
|
}
|