@openeditor/react 0.0.17 → 0.0.19

package/README.md

@@ -10,11 +10,30 @@ Pass `attachmentRuntime` to `useOpenEditorController` for editable attachments a
 - `OpenEditorContent` for the editable Tiptap-backed content surface
 - `OpenEditorViewer` for read-only React rendering
 - `getDefaultSlashMenuItems` for UI packages that want the built-in insert actions
+- position-based block targeting and transaction-backed copy, duplicate, move, and delete commands
 - `defineOpenEditorReactNode` for consumer-owned React blocks
 - `defineOpenEditorReactExtension` for advanced integrations that contribute multiple Tiptap extensions
 
 This package intentionally does not import CSS and does not render styled menus. Use `@openeditor/ui` for the optional styled components.
 
+## Block actions
+
+`controller.blockTarget` identifies the top-level block under the pointer or the
+active node selection. Mutating commands operate directly on ProseMirror
+transactions, preserving history and avoiding whole-document replacement:
+
+```tsx
+controller.selectBlock(target);
+await controller.copyBlock(target);
+controller.duplicateBlock(target);
+controller.deleteBlock(target);
+```
+
+Pass `blockActions` to contribute product-specific actions. The optional
+`OpenEditorBlockMenu` from `@openeditor/ui` combines those contributions with
+Copy, Duplicate, and Delete. Clipboard copies use a versioned OpenEditor block
+envelope so blocks can move between independent editor instances and documents.
+
 The built-in web catalog includes editable Toggle Lists, rich-content Callouts,
 and Mermaid-powered Diagrams. Diagrams use `beautiful-mermaid` for synchronous,
 themeable SVG rendering and retain their canonical Mermaid source in the document.

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { OpenEditorDocument, BlockSpec, ProseMirrorNode, OpenEditorAttachmentRun
 import { toExportBundle, OpenEditorExporters } from '@openeditor/exporters';
 export { seedDocument } from '@openeditor/extensions';
 import { Editor, AnyExtension, NodeConfig } from '@tiptap/core';
+export { DragHandle as OpenEditorDragHandle } from '@tiptap/extension-drag-handle-react';
 import { ReactNodeViewProps } from '@tiptap/react';
 export { NodeViewContent, NodeViewWrapper, ReactNodeViewProps as OpenEditorNodeViewProps } from '@tiptap/react';
 
@@ -46,6 +47,25 @@ type OpenEditorReactProps = {
     slashMenuItems?: readonly OpenEditorSlashMenuItem[];
     /** Consumer-owned blocks. Extension names and node types must be unique. */
     extensions?: readonly OpenEditorReactExtension[];
+    blockActions?: readonly OpenEditorBlockAction[];
+};
+type OpenEditorBlockTarget = {
+    pos: number;
+    depth: number;
+    nodeType: string;
+    blockName?: string;
+    rect: OpenEditorOverlayRect;
+};
+type OpenEditorBlockActionContext = {
+    controller: OpenEditorController;
+    target: OpenEditorBlockTarget;
+};
+type OpenEditorBlockAction = {
+    id: string;
+    label: string;
+    group?: "edit" | "danger" | string;
+    disabled?: (context: OpenEditorBlockActionContext) => boolean;
+    run: (context: OpenEditorBlockActionContext) => void | Promise<void>;
 };
 type OpenEditorReactConfig = OpenEditorReactProps;
 type OpenEditorController = {
@@ -78,6 +98,14 @@ type OpenEditorController = {
     moveSelectedBlock: (direction: -1 | 1) => void;
     duplicateSelectedBlock: () => void;
     deleteSelectedBlock: () => void;
+    selectBlock: (target: OpenEditorBlockTarget) => void;
+    copyBlock: (target?: OpenEditorBlockTarget) => Promise<boolean>;
+    duplicateBlock: (target?: OpenEditorBlockTarget) => boolean;
+    deleteBlock: (target?: OpenEditorBlockTarget) => boolean;
+    moveBlock: (direction: -1 | 1, target?: OpenEditorBlockTarget) => boolean;
+    blockActions: readonly OpenEditorBlockAction[];
+    blockTarget: OpenEditorBlockTarget | null;
+    setBlockTargetAt: (pos: number | null) => void;
     slashMenuItems: readonly OpenEditorSlashMenuItem[];
     extensions: readonly OpenEditorReactExtension[];
     pageRuntime?: OpenEditorPageRuntime;
@@ -168,10 +196,10 @@ declare module "@tiptap/core" {
     }
 }
 declare const formatAttachmentSize: (size: number | null) => string;
-declare const useOpenEditorController: ({ initialDocument, editable, placeholder, onChange, onFilePasteDrop, pageRuntime, attachmentRuntime, slashMenuItems, extensions, }?: OpenEditorReactProps) => OpenEditorController;
+declare const useOpenEditorController: ({ initialDocument, editable, placeholder, onChange, onFilePasteDrop, pageRuntime, attachmentRuntime, slashMenuItems, extensions, blockActions, }?: OpenEditorReactProps) => OpenEditorController;
 declare const getDefaultSlashMenuItems: (controller: OpenEditorController) => OpenEditorSlashMenuItem[];
 declare const OpenEditorContent: ({ controller, className, }: OpenEditorContentProps) => react.JSX.Element;
 declare const OpenEditorViewer: ({ document, className, renderers, extensions, pageRuntime, attachmentRuntime, }: OpenEditorViewerProps) => react.JSX.Element;
-declare const useOpenEditor: ({ initialDocument, editable, placeholder, onChange, onFilePasteDrop, pageRuntime, attachmentRuntime, slashMenuItems, extensions, }?: OpenEditorReactProps) => OpenEditorController;
+declare const useOpenEditor: ({ initialDocument, editable, placeholder, onChange, onFilePasteDrop, pageRuntime, attachmentRuntime, slashMenuItems, extensions, blockActions, }?: OpenEditorReactProps) => OpenEditorController;
 
-export { type InsertRange, OpenEditorContent, type OpenEditorContentProps, type OpenEditorController, type OpenEditorExtensionMenu, type OpenEditorOverlayRect, type OpenEditorPageRuntime, type OpenEditorPageSnapshot, type OpenEditorReactConfig, type OpenEditorReactExtension, type OpenEditorReactNodeExtension, type OpenEditorReactProps, type OpenEditorSlashMenuItem, type OpenEditorTheme, OpenEditorThemeProvider, type OpenEditorThemeStyle, type OpenEditorThemeToken, OpenEditorViewer, type OpenEditorViewerProps, type OpenEditorViewerRenderer, type SelectionBubbleState, type SlashState, createOpenEditorThemeStyle, defineOpenEditorReactExtension, defineOpenEditorReactNode, formatAttachmentSize, getDefaultSlashMenuItems, openEditorThemeTokenNames, useOpenEditor, useOpenEditorController, useOpenEditorThemeStyle };
+export { type InsertRange, type OpenEditorBlockAction, type OpenEditorBlockActionContext, type OpenEditorBlockTarget, OpenEditorContent, type OpenEditorContentProps, type OpenEditorController, type OpenEditorExtensionMenu, type OpenEditorOverlayRect, type OpenEditorPageRuntime, type OpenEditorPageSnapshot, type OpenEditorReactConfig, type OpenEditorReactExtension, type OpenEditorReactNodeExtension, type OpenEditorReactProps, type OpenEditorSlashMenuItem, type OpenEditorTheme, OpenEditorThemeProvider, type OpenEditorThemeStyle, type OpenEditorThemeToken, OpenEditorViewer, type OpenEditorViewerProps, type OpenEditorViewerRenderer, type SelectionBubbleState, type SlashState, createOpenEditorThemeStyle, defineOpenEditorReactExtension, defineOpenEditorReactNode, formatAttachmentSize, getDefaultSlashMenuItems, openEditorThemeTokenNames, useOpenEditor, useOpenEditorController, useOpenEditorThemeStyle };