@tiptap/core/src/commands/scrollIntoView.ts

headless rich text editor

import type { RawCommands } from '../types.js'

declare module '@tiptap/core' {
  interface Commands<ReturnType> {
    scrollIntoView: {
      /**
       * Scroll the selection into view.
       * @example editor.commands.scrollIntoView()
       */
      scrollIntoView: () => ReturnType
    }
  }
}

export const scrollIntoView: RawCommands['scrollIntoView'] =
  () =>
  ({ tr, dispatch }) => {
    if (dispatch) {
      tr.scrollIntoView()
    }

    return true
  }