DocMosaicdocs
Primitives

Editor.KeybindingHelp

Modal listing every active keyboard shortcut. Opens via mod+/.

Modal listing every active keyboard shortcut. Opens via mod+/.

Usage

import { Editor } from '@docmosaic/react';

<Editor.Root>
    <Editor.KeybindingHelp />
</Editor.Root>;

API Reference

PropTypeDefaultDescription
keymapPartial<EditorKeymap> | undefined-

Override the displayed keymap. Defaults to DEFAULT_KEYMAP. Pass the same partial map you handed to Editor.Root keybindings so the dialog reflects the actual active bindings. Anything omitted falls back to the default

  • the merge mirrors what the runtime layer does.
openboolean | undefined-

Externally control the open state. When omitted, the dialog manages its own visibility and listens for the showHelp keybinding to toggle.

onOpenChange((open: boolean) => void) | undefined-

Called when the user requests open/close.

  • Root - the orchestrator