@brett_lamy/docstream-editor 0.3.5 → 0.3.7

package/README.md

@@ -73,11 +73,15 @@ export function EditorPage() {
 export interface GitbookEditorProps {
   markdown: string
   onChange: (markdown: string) => void
+  onKeyDown?: (event: KeyboardEvent) => boolean
+  onPaste?: (event: ClipboardEvent) => boolean
 }
 ```
 
 - `markdown`: Source markdown to load into the editor.
 - `onChange`: Called with serialized markdown whenever TipTap content changes.
+- `onKeyDown` / `onPaste`: Optional host hooks that run before the built-in editor behavior;
+  return `true` when the application handled the event.
 
 The editor tracks the last markdown it emitted so normal controlled updates do not continuously reset the TipTap document. Passing a different external `markdown` value replaces the editor content.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brett_lamy/docstream-editor",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "description": "TipTap editor for Docstream GitBook-style markdown documents.",
   "type": "module",
   "scripts": {
@@ -32,7 +32,7 @@
     "./styles.css": "./src/styles.css"
   },
   "dependencies": {
-    "@brett_lamy/docstream": "0.3.7",
+    "@brett_lamy/docstream": "0.4.0",
     "lowlight": "^3.3.0",
     "lucide-react": "^1.17.0"
   },

package/src/editor/Editor.tsx

@@ -39,6 +39,10 @@ export interface GitbookEditorProps {
   disableHistory?: boolean
   /** Extra TipTap extensions appended last (e.g. Collaboration, CollaborationCursor). */
   extensions?: AnyExtension[]
+  /** Handle a key before the editor's built-in keymaps. Return true when handled. */
+  onKeyDown?: (event: KeyboardEvent) => boolean
+  /** Handle clipboard content before the editor's built-in paste behavior. Return true when handled. */
+  onPaste?: (event: ClipboardEvent) => boolean
   /** Receive the underlying TipTap editor instance (and null on teardown). */
   onEditorReady?: (editor: TiptapEditor | null) => void
 }
@@ -114,6 +118,8 @@ export function GitbookEditor({
   autofocus = false,
   disableHistory,
   extensions,
+  onKeyDown,
+  onPaste,
   onEditorReady,
 }: GitbookEditorProps) {
   // Tracks the markdown the editor itself produced, so external updates
@@ -130,6 +136,10 @@ export function GitbookEditor({
       ...(disableHistory !== undefined ? { disableHistory } : {}),
       ...(extensions ? { extensions } : {}),
     }),
+    editorProps: {
+      handleKeyDown: (_view, event) => onKeyDown?.(event) ?? false,
+      handlePaste: (_view, event) => onPaste?.(event) ?? false,
+    },
     ...(controlled ? { content: astToTiptap(parseMarkdown(markdown as string)) } : {}),
     onUpdate({ editor }) {
       if (!onChange) return