@tiptap/core 3.4.5 → 3.5.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/core",
   "description": "headless rich text editor",
-  "version": "3.4.5",
+  "version": "3.5.0",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -52,10 +52,10 @@
     "jsx-dev-runtime"
   ],
   "devDependencies": {
-    "@tiptap/pm": "^3.4.5"
+    "@tiptap/pm": "^3.5.0"
   },
   "peerDependencies": {
-    "@tiptap/pm": "^3.4.5"
+    "@tiptap/pm": "^3.5.0"
   },
   "repository": {
     "type": "git",

package/src/InputRule.ts

@@ -33,6 +33,8 @@ export class InputRule {
     can: () => CanCommands
   }) => void | null
 
+  undoable: boolean
+
   constructor(config: {
     find: InputRuleFinder
     handler: (props: {
@@ -43,9 +45,11 @@ export class InputRule {
       chain: () => ChainedCommands
       can: () => CanCommands
     }) => void | null
+    undoable?: boolean
   }) {
     this.find = config.find
     this.handler = config.handler
+    this.undoable = config.undoable ?? true
   }
 }
 
@@ -149,12 +153,14 @@ function run(config: {
 
     // store transform as meta data
     // so we can undo input rules within the `undoInputRules` command
-    tr.setMeta(plugin, {
-      transform: tr,
-      from,
-      to,
-      text,
-    })
+    if (rule.undoable) {
+      tr.setMeta(plugin, {
+        transform: tr,
+        from,
+        to,
+        text,
+      })
+    }
 
     view.dispatch(tr)
     matched = true

package/src/inputRules/markInputRule.ts

@@ -14,6 +14,7 @@ import { callOrReturn } from '../utilities/callOrReturn.js'
 export function markInputRule(config: {
   find: InputRuleFinder
   type: MarkType
+  undoable?: boolean
   getAttributes?: Record<string, any> | ((match: ExtendedRegExpMatchArray) => Record<string, any>) | false | null
 }) {
   return new InputRule({
@@ -62,5 +63,6 @@ export function markInputRule(config: {
         tr.removeStoredMark(config.type)
       }
     },
+    undoable: config.undoable,
   })
 }

package/src/inputRules/nodeInputRule.ts

@@ -21,6 +21,12 @@ export function nodeInputRule(config: {
    */
   type: NodeType
 
+  /**
+   * Whether the input rule should be undoable
+   * when the user presses backspace.
+   */
+  undoable?: boolean
+
   /**
    * A function that returns the attributes for the node
    * can also be an object of attributes
@@ -62,5 +68,6 @@ export function nodeInputRule(config: {
 
       tr.scrollIntoView()
     },
+    undoable: config.undoable,
   })
 }

package/src/inputRules/textInputRule.ts

@@ -6,7 +6,7 @@ import { InputRule } from '../InputRule.js'
  * matched text is typed into it.
  * @see https://tiptap.dev/docs/editor/extensions/custom-extensions/extend-existing#input-rules
  */
-export function textInputRule(config: { find: InputRuleFinder; replace: string }) {
+export function textInputRule(config: { find: InputRuleFinder; replace: string; undoable?: boolean }) {
   return new InputRule({
     find: config.find,
     handler: ({ state, range, match }) => {
@@ -30,5 +30,6 @@ export function textInputRule(config: { find: InputRuleFinder; replace: string }
 
       state.tr.insertText(insert, start, end)
     },
+    undoable: config.undoable,
   })
 }

package/src/inputRules/textblockTypeInputRule.ts

@@ -15,6 +15,7 @@ import { callOrReturn } from '../utilities/callOrReturn.js'
 export function textblockTypeInputRule(config: {
   find: InputRuleFinder
   type: NodeType
+  undoable?: boolean
   getAttributes?: Record<string, any> | ((match: ExtendedRegExpMatchArray) => Record<string, any>) | false | null
 }) {
   return new InputRule({
@@ -29,5 +30,6 @@ export function textblockTypeInputRule(config: {
 
       state.tr.delete(range.from, range.to).setBlockType(range.from, range.from, config.type, attributes)
     },
+    undoable: config.undoable,
   })
 }

package/src/inputRules/wrappingInputRule.ts

@@ -28,6 +28,7 @@ export function wrappingInputRule(config: {
   keepMarks?: boolean
   keepAttributes?: boolean
   editor?: Editor
+  undoable?: boolean
   getAttributes?: Record<string, any> | ((match: ExtendedRegExpMatchArray) => Record<string, any>) | false | null
   joinPredicate?: (match: ExtendedRegExpMatchArray, node: ProseMirrorNode) => boolean
 }) {
@@ -76,5 +77,6 @@ export function wrappingInputRule(config: {
         tr.join(range.from - 1)
       }
     },
+    undoable: config.undoable,
   })
 }