Interface HotkeyConfig

export interface HotkeyConfig {
  /** Logical action id used to look up the runtime handler. */
  id: string;
  /** Key binding (platform-aware). */
  keys: KeyBinding;
  /** Human-readable description shown in the help modal. */
  description: string;
  /** Grouping label used to organize the help modal list. */
  group: string;
  /**
   * Optional confirmation text flashed in the status bar when the hotkey
   * fires. Omit for shortcuts whose effect is self-evident (e.g. opening a
   * modal) so we don't spam redundant feedback.
   */
  flash?: string;
  /**
   * When `true`, `keys` is interpreted as an ordered **sequence** — the
   * `+`-separated tokens must be pressed one after another (e.g.
   * `up+up+down+down+left+right`) rather than as a simultaneous chord.
   * Defaults to `false`/absent (chord matching).
   */
  sequential?: boolean;
  /**
   * When `true`, the hotkey is hidden from the help modal (and any other UI
   * that lists shortcuts) but stays fully functional. Useful for easter eggs
   * or power-user shortcuts. Defaults to `false`/absent (listed).
   */
  unlisted?: boolean;
}
Copy