@tiptap/extension-drag-handle-vue-2 3.14.0 → 3.15.0

package/dist/index.d.cts

@@ -858,6 +858,27 @@ interface ExtendableConfig<Options = any, Storage = any, Config extends Extensio
         type: PMType;
         parent: ParentConfig<Config>['onDestroy'];
     }, event: EditorEvents['destroy']) => void) | null;
+    /**
+     * This hook allows you to intercept and modify transactions before they are dispatched.
+     *
+     * Example
+     * ```ts
+     * dispatchTransaction({ transaction, next }) {
+     *   console.log('Dispatching transaction:', transaction)
+     *   next(transaction)
+     * }
+     * ```
+     *
+     * @param props - The dispatch transaction props
+     */
+    dispatchTransaction?: ((this: {
+        name: string;
+        options: Options;
+        storage: Storage;
+        editor: Editor;
+        type: PMType;
+        parent: ParentConfig<Config>['dispatchTransaction'];
+    }, props: DispatchTransactionProps) => void) | null;
 }
 declare class Extendable<Options = any, Storage = any, Config = ExtensionConfig<Options, Storage> | NodeConfig<Options, Storage> | MarkConfig<Options, Storage>> {
     type: string;
@@ -1092,6 +1113,22 @@ interface EditorEvents {
         mark: Mark$1;
     });
 }
+/**
+ * Props passed to the `dispatchTransaction` hook in extensions.
+ */
+type DispatchTransactionProps = {
+    /**
+     * The transaction that is about to be dispatched.
+     */
+    transaction: Transaction;
+    /**
+     * A function that should be called to pass the transaction down to the next extension
+     * (or eventually to the editor).
+     *
+     * @param transaction The transaction to dispatch
+     */
+    next: (transaction: Transaction) => void;
+};
 type EnableRules = (AnyExtension | string)[] | boolean;
 interface EditorOptions {
     /**
@@ -1263,6 +1300,17 @@ interface EditorOptions {
      * Called when content is deleted from the editor.
      */
     onDelete: (props: EditorEvents['delete']) => void;
+    /**
+     * Whether to enable extension-level dispatching of transactions.
+     * If `false`, extensions cannot define their own `dispatchTransaction` hook.
+     *
+     * @default true
+     * @example
+     * new Editor({
+     *   enableExtensionDispatchTransaction: false,
+     * })
+     */
+    enableExtensionDispatchTransaction?: boolean;
 }
 /**
  * The editor's content as HTML
@@ -1727,6 +1775,12 @@ declare class ExtensionManager {
      * @returns An object with all node views where the key is the node name and the value is the node view function
      */
     get nodeViews(): Record<string, NodeViewConstructor>;
+    /**
+     * Get the composed dispatchTransaction function from all extensions.
+     * @param baseDispatch The base dispatch function (e.g. from the editor or user props)
+     * @returns A composed dispatch function
+     */
+    dispatchTransaction(baseDispatch: (tr: Transaction) => void): (tr: Transaction) => void;
     get markViews(): Record<string, MarkViewConstructor>;
     /**
      * Go through all extensions, create extension storages & setup marks

package/dist/index.d.ts

@@ -858,6 +858,27 @@ interface ExtendableConfig<Options = any, Storage = any, Config extends Extensio
         type: PMType;
         parent: ParentConfig<Config>['onDestroy'];
     }, event: EditorEvents['destroy']) => void) | null;
+    /**
+     * This hook allows you to intercept and modify transactions before they are dispatched.
+     *
+     * Example
+     * ```ts
+     * dispatchTransaction({ transaction, next }) {
+     *   console.log('Dispatching transaction:', transaction)
+     *   next(transaction)
+     * }
+     * ```
+     *
+     * @param props - The dispatch transaction props
+     */
+    dispatchTransaction?: ((this: {
+        name: string;
+        options: Options;
+        storage: Storage;
+        editor: Editor;
+        type: PMType;
+        parent: ParentConfig<Config>['dispatchTransaction'];
+    }, props: DispatchTransactionProps) => void) | null;
 }
 declare class Extendable<Options = any, Storage = any, Config = ExtensionConfig<Options, Storage> | NodeConfig<Options, Storage> | MarkConfig<Options, Storage>> {
     type: string;
@@ -1092,6 +1113,22 @@ interface EditorEvents {
         mark: Mark$1;
     });
 }
+/**
+ * Props passed to the `dispatchTransaction` hook in extensions.
+ */
+type DispatchTransactionProps = {
+    /**
+     * The transaction that is about to be dispatched.
+     */
+    transaction: Transaction;
+    /**
+     * A function that should be called to pass the transaction down to the next extension
+     * (or eventually to the editor).
+     *
+     * @param transaction The transaction to dispatch
+     */
+    next: (transaction: Transaction) => void;
+};
 type EnableRules = (AnyExtension | string)[] | boolean;
 interface EditorOptions {
     /**
@@ -1263,6 +1300,17 @@ interface EditorOptions {
      * Called when content is deleted from the editor.
      */
     onDelete: (props: EditorEvents['delete']) => void;
+    /**
+     * Whether to enable extension-level dispatching of transactions.
+     * If `false`, extensions cannot define their own `dispatchTransaction` hook.
+     *
+     * @default true
+     * @example
+     * new Editor({
+     *   enableExtensionDispatchTransaction: false,
+     * })
+     */
+    enableExtensionDispatchTransaction?: boolean;
 }
 /**
  * The editor's content as HTML
@@ -1727,6 +1775,12 @@ declare class ExtensionManager {
      * @returns An object with all node views where the key is the node name and the value is the node view function
      */
     get nodeViews(): Record<string, NodeViewConstructor>;
+    /**
+     * Get the composed dispatchTransaction function from all extensions.
+     * @param baseDispatch The base dispatch function (e.g. from the editor or user props)
+     * @returns A composed dispatch function
+     */
+    dispatchTransaction(baseDispatch: (tr: Transaction) => void): (tr: Transaction) => void;
     get markViews(): Record<string, MarkViewConstructor>;
     /**
      * Go through all extensions, create extension storages & setup marks

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/extension-drag-handle-vue-2",
   "description": "drag handle extension for tiptap with vue 2",
-  "version": "3.14.0",
+  "version": "3.15.0",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -37,16 +37,16 @@
   ],
   "peerDependencies": {
     "vue": "^2.0.0",
-    "@tiptap/extension-drag-handle": "^3.14.0",
-    "@tiptap/pm": "^3.14.0",
-    "@tiptap/vue-2": "^3.14.0"
+    "@tiptap/extension-drag-handle": "^3.15.0",
+    "@tiptap/pm": "^3.15.0",
+    "@tiptap/vue-2": "^3.15.0"
   },
   "devDependencies": {
     "vue": "^2.0.0",
     "vue-ts-types": "1.6.2",
-    "@tiptap/extension-drag-handle": "^3.14.0",
-    "@tiptap/pm": "^3.14.0",
-    "@tiptap/vue-2": "^3.14.0"
+    "@tiptap/extension-drag-handle": "^3.15.0",
+    "@tiptap/pm": "^3.15.0",
+    "@tiptap/vue-2": "^3.15.0"
   },
   "scripts": {
     "build": "tsup",