Interface KeyboardShortcutContextValue

Keyboard shortcut context value

interface KeyboardShortcutContextValue {
    shortcuts: ShortcutMap;
    registerShortcut: (shortcut: KeyboardShortcut) => void;
    unregisterShortcut: (id: string) => void;
    isEnabled: boolean;
    setEnabled: (enabled: boolean) => void;
    platform: Platform;
    showHelp: boolean;
    setShowHelp: (show: boolean) => void;
}

Properties

All registered shortcuts

registerShortcut: (shortcut: KeyboardShortcut) => void

unregisterShortcut: (id: string) => void

Unregister a shortcut by id

isEnabled: boolean

Check if shortcuts are enabled

setEnabled: (enabled: boolean) => void

Enable/disable all shortcuts

platform: Platform

Get current platform

showHelp: boolean

Toggle help modal visibility

setShowHelp: (show: boolean) => void

Set help modal visibility