feat: add scrollIntoView option to focus command, fix #2172

docs/api/commands/focus.md

@@ -10,6 +10,10 @@ See also: [setTextSelection](/api/commands/set-text-selection), [blur](/api/comm
 
 By default, it’s restoring the cursor position (and text selection). Pass a position to move the cursor too.
 
+`options: { scrollIntoView: boolen }`
+
+Defines whether to scroll to the cursor when focusing. Defaults to `true`.
+
 ## Usage
 ```js
 // Set the focus to the editor

packages/core/src/commands/focus.ts

@@ -44,17 +44,27 @@ declare module '@tiptap/core' {
       /**
        * Focus the editor at the given position.
        */
-      focus: (position?: FocusPosition) => ReturnType,
+      focus: (
+        position?: FocusPosition,
+        options?: {
+          scrollIntoView?: boolean,
+        },
+      ) => ReturnType,
     }
   }
 }
 
-export const focus: RawCommands['focus'] = (position = null) => ({
+export const focus: RawCommands['focus'] = (position = null, options) => ({
   editor,
   view,
   tr,
   dispatch,
 }) => {
+  options = {
+    scrollIntoView: true,
+    ...options,
+  }
+
   const delayedFocus = () => {
     // focus within `requestAnimationFrame` breaks focus on iOS
     // so we have to call this
@@ -67,8 +77,11 @@ export const focus: RawCommands['focus'] = (position = null) => ({
     requestAnimationFrame(() => {
       if (!editor.isDestroyed) {
         view.focus()
+
+        if (options?.scrollIntoView) {
           editor.commands.scrollIntoView()
         }
+      }
     })
   }
 

packages/extension-task-item/src/task-item.ts

@@ -118,7 +118,7 @@ export const TaskItem = Node.create<TaskItemOptions>({
         if (editor.isEditable && typeof getPos === 'function') {
           editor
             .chain()
-            .focus()
+            .focus(undefined, { scrollIntoView: false })
             .command(({ tr }) => {
               tr.setNodeMarkup(getPos(), undefined, {
                 checked,