@tiptap/extension-paragraph 2.6.5 → 2.7.0-pre.0

package/dist/packages/core/src/NodeView.d.ts

@@ -1,8 +1,6 @@
-import { Node as ProseMirrorNode } from '@tiptap/pm/model';
 import { NodeView as ProseMirrorNodeView } from '@tiptap/pm/view';
 import { Editor as CoreEditor } from './Editor.js';
-import { Node } from './Node.js';
-import { DecorationWithType, NodeViewRendererOptions, NodeViewRendererProps } from './types.js';
+import { NodeViewRendererOptions, NodeViewRendererProps } from './types.js';
 /**
  * Node views are used to customize the rendered DOM structure of a node.
  * @see https://tiptap.dev/guide/node-views
@@ -11,10 +9,13 @@ export declare class NodeView<Component, NodeEditor extends CoreEditor = CoreEdi
     component: Component;
     editor: NodeEditor;
     options: Options;
-    extension: Node;
-    node: ProseMirrorNode;
-    decorations: DecorationWithType[];
-    getPos: any;
+    extension: NodeViewRendererProps['extension'];
+    node: NodeViewRendererProps['node'];
+    decorations: NodeViewRendererProps['decorations'];
+    innerDecorations: NodeViewRendererProps['innerDecorations'];
+    view: NodeViewRendererProps['view'];
+    getPos: NodeViewRendererProps['getPos'];
+    HTMLAttributes: NodeViewRendererProps['HTMLAttributes'];
     isDragging: boolean;
     constructor(component: Component, props: NodeViewRendererProps, options?: Partial<Options>);
     mount(): void;
@@ -22,10 +23,21 @@ export declare class NodeView<Component, NodeEditor extends CoreEditor = CoreEdi
     get contentDOM(): HTMLElement | null;
     onDragStart(event: DragEvent): void;
     stopEvent(event: Event): boolean;
+    /**
+     * Called when a DOM [mutation](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver) or a selection change happens within the view.
+     * @return `false` if the editor should re-read the selection or re-parse the range around the mutation
+     * @return `true` if it can safely be ignored.
+     */
     ignoreMutation(mutation: MutationRecord | {
         type: 'selection';
         target: Element;
     }): boolean;
-    updateAttributes(attributes: {}): void;
+    /**
+     * Update the attributes of the prosemirror node.
+     */
+    updateAttributes(attributes: Record<string, any>): void;
+    /**
+     * Delete the node.
+     */
     deleteNode(): void;
 }

package/dist/packages/core/src/index.d.ts

@@ -11,6 +11,8 @@ export * from './NodePos.js';
 export * from './NodeView.js';
 export * from './PasteRule.js';
 export * from './pasteRules/index.js';
+export * from './plugins/DropPlugin.js';
+export * from './plugins/PastePlugin.js';
 export * from './Tracker.js';
 export * from './types.js';
 export * from './utilities/index.js';

package/dist/packages/core/src/plugins/DropPlugin.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from '@tiptap/pm/state';
+import { Slice } from 'packages/pm/model';
+export declare const DropPlugin: (onDrop: (e: DragEvent, slice: Slice, moved: boolean) => void) => Plugin<any>;

package/dist/packages/core/src/plugins/PastePlugin.d.ts

@@ -0,0 +1,3 @@
+import { Slice } from '@tiptap/pm/model';
+import { Plugin } from '@tiptap/pm/state';
+export declare const PastePlugin: (onPaste: (e: ClipboardEvent, slice: Slice) => void) => Plugin<any>;

package/dist/packages/core/src/types.d.ts

@@ -1,6 +1,6 @@
-import { Mark as ProseMirrorMark, Node as ProseMirrorNode, NodeType, ParseOptions } from '@tiptap/pm/model';
+import { Mark as ProseMirrorMark, Node as ProseMirrorNode, NodeType, ParseOptions, Slice } from '@tiptap/pm/model';
 import { EditorState, Transaction } from '@tiptap/pm/state';
-import { Decoration, EditorProps, EditorView, NodeView } from '@tiptap/pm/view';
+import { Decoration, EditorProps, EditorView, NodeView, NodeViewConstructor } from '@tiptap/pm/view';
 import { Editor } from './Editor.js';
 import { Extension } from './Extension.js';
 import { Commands, ExtensionConfig, MarkConfig, NodeConfig } from './index.js';
@@ -79,7 +79,24 @@ export interface EditorOptions {
     };
     enableInputRules: EnableRules;
     enablePasteRules: EnableRules;
-    enableCoreExtensions: boolean;
+    /**
+     * Determines whether core extensions are enabled.
+     *
+     * If set to `false`, all core extensions will be disabled.
+     * To disable specific core extensions, provide an object where the keys are the extension names and the values are `false`.
+     * Extensions not listed in the object will remain enabled.
+     *
+     * @example
+     * // Disable all core extensions
+     * enabledCoreExtensions: false
+     *
+     * @example
+     * // Disable only the keymap core extension
+     * enabledCoreExtensions: { keymap: false }
+     *
+     * @default true
+     */
+    enableCoreExtensions?: boolean | Partial<Record<'editable' | 'clipboardTextSerializer' | 'commands' | 'focusEvents' | 'keymap' | 'tabindex', false>>;
     /**
      * If `true`, the editor will check the content for errors on initialization.
      * Emitting the `contentError` event if the content is invalid.
@@ -100,6 +117,8 @@ export interface EditorOptions {
     onFocus: (props: EditorEvents['focus']) => void;
     onBlur: (props: EditorEvents['blur']) => void;
     onDestroy: (props: EditorEvents['destroy']) => void;
+    onPaste: (e: ClipboardEvent, slice: Slice) => void;
+    onDrop: (e: DragEvent, slice: Slice, moved: boolean) => void;
 }
 export type HTMLContent = string;
 export type JSONContent = {
@@ -170,19 +189,18 @@ export type ValuesOf<T> = T[keyof T];
 export type KeysWithTypeOf<T, Type> = {
     [P in keyof T]: T[P] extends Type ? P : never;
 }[keyof T];
+export type Simplify<T> = {
+    [KeyType in keyof T]: T[KeyType];
+} & {};
 export type DecorationWithType = Decoration & {
     type: NodeType;
 };
-export type NodeViewProps = {
-    editor: Editor;
-    node: ProseMirrorNode;
-    decorations: DecorationWithType[];
+export type NodeViewProps = Simplify<Omit<NodeViewRendererProps, 'decorations'> & {
+    decorations: readonly DecorationWithType[];
     selected: boolean;
-    extension: Node;
-    getPos: () => number;
     updateAttributes: (attributes: Record<string, any>) => void;
     deleteNode: () => void;
-};
+}>;
 export interface NodeViewRendererOptions {
     stopEvent: ((props: {
         event: Event;
@@ -196,14 +214,16 @@ export interface NodeViewRendererOptions {
     contentDOMElementTag: string;
 }
 export type NodeViewRendererProps = {
+    node: Parameters<NodeViewConstructor>[0];
+    view: Parameters<NodeViewConstructor>[1];
+    getPos: () => number;
+    decorations: Parameters<NodeViewConstructor>[3];
+    innerDecorations: Parameters<NodeViewConstructor>[4];
     editor: Editor;
-    node: ProseMirrorNode;
-    getPos: (() => number) | boolean;
-    HTMLAttributes: Record<string, any>;
-    decorations: Decoration[];
     extension: Node;
+    HTMLAttributes: Record<string, any>;
 };
-export type NodeViewRenderer = (props: NodeViewRendererProps) => NodeView | {};
+export type NodeViewRenderer = (props: NodeViewRendererProps) => NodeView;
 export type AnyCommands = Record<string, (...args: any[]) => Command>;
 export type UnionCommands<T = Command> = UnionToIntersection<ValuesOf<Pick<Commands<T>, KeysWithTypeOf<Commands<T>, {}>>>>;
 export type RawCommands = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/extension-paragraph",
   "description": "paragraph extension for tiptap",
-  "version": "2.6.5",
+  "version": "2.7.0-pre.0",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -29,10 +29,10 @@
     "dist"
   ],
   "devDependencies": {
-    "@tiptap/core": "^2.6.5"
+    "@tiptap/core": "^2.7.0-pre.0"
   },
   "peerDependencies": {
-    "@tiptap/core": "^2.6.5"
+    "@tiptap/core": "^2.7.0-pre.0"
   },
   "repository": {
     "type": "git",