@brett_lamy/docstream-editor 0.3.4 → 0.3.6

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.
 
@@ -158,6 +162,14 @@ Exports:
 - `SourceFileEditor`
 - `SourceFileEditorProps`
 
+Applications that only need the core editor can import the narrow entrypoint. It avoids loading
+the source-file and React playground integrations:
+
+```tsx
+import { GitbookEditor } from "@brett_lamy/docstream-editor/editor"
+import { astToTiptap } from "@brett_lamy/docstream-editor/convert"
+```
+
 ## Styling and Theming
 
 The editor CSS is designed to sit beside `@brett_lamy/docstream/styles.css` and inherit the same application theme tokens. In a shadcn-style app, define your theme variables globally and import both CSS entrypoints once.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brett_lamy/docstream-editor",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "description": "TipTap editor for Docstream GitBook-style markdown documents.",
   "type": "module",
   "scripts": {
@@ -21,6 +21,14 @@
       "types": "./src/index.ts",
       "import": "./src/index.ts"
     },
+    "./editor": {
+      "types": "./src/editor/Editor.tsx",
+      "import": "./src/editor/Editor.tsx"
+    },
+    "./convert": {
+      "types": "./src/editor/convert.ts",
+      "import": "./src/editor/convert.ts"
+    },
     "./styles.css": "./src/styles.css"
   },
   "dependencies": {

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

package/src/styles.css

@@ -538,6 +538,30 @@
 }
 .gb-code pre code { background: none; padding: 0; font-size: inherit; color: inherit; }
 .gb-code pre code .hljs-comment { font-style: italic; }
+.gb-code .hljs-keyword,
+.gb-code .hljs-selector-tag,
+.gb-code .hljs-built_in,
+.gb-code .hljs-type,
+.gb-code .hljs-tag,
+.gb-code .hljs-name { color: #c792ea; }
+.gb-code .hljs-string,
+.gb-code .hljs-attr,
+.gb-code .hljs-symbol,
+.gb-code .hljs-bullet { color: #a5d6a7; }
+.gb-code .hljs-title,
+.gb-code .hljs-section,
+.gb-code .hljs-function .hljs-title { color: #82aaff; }
+.gb-code .hljs-number,
+.gb-code .hljs-literal,
+.gb-code .hljs-variable,
+.gb-code .hljs-template-variable { color: #f78c6c; }
+.gb-code .hljs-comment,
+.gb-code .hljs-quote,
+.gb-code .hljs-meta { color: #777784; }
+.gb-code .hljs-operator,
+.gb-code .hljs-punctuation { color: #89ddff; }
+.gb-code .hljs-deletion { color: #ff6b6b; }
+.gb-code .hljs-addition { color: #69db7c; }
 
 /* ── Updates / changelog (mirrors .docs-updates) ────────── */
 .gb-updates { margin: 0.85em 0; border-top: 1px solid var(--gb-border); }