?HAMA

Navigation

Breadcrumbs

/ / proc / thread-self / root / home / byroehnu / .trash / node_modules11 / @tiptap / react / src

Create

Create File | Create Folder | Upload Files | Run Command

Edit File Size: 5.54 KB

/proc/thread-self/root/home/byroehnu/.trash/node_modules11/@tiptap/react/src/useEditorState.ts

Text Base64

import type { Editor } from '@tiptap/core'
import deepEqual from 'fast-deep-equal/es6/react'
import {
  useDebugValue, useEffect, useLayoutEffect, useState,
} from 'react'
import { useSyncExternalStoreWithSelector } from 'use-sync-external-store/shim/with-selector'

const useIsomorphicLayoutEffect = typeof window !== 'undefined' ? useLayoutEffect : useEffect

export type EditorStateSnapshot<TEditor extends Editor | null = Editor | null> = {
  editor: TEditor;
  transactionNumber: number;
};

export type UseEditorStateOptions<
  TSelectorResult,
  TEditor extends Editor | null = Editor | null,
> = {
  /**
   * The editor instance.
   */
  editor: TEditor;
  /**
   * A selector function to determine the value to compare for re-rendering.
   */
  selector: (context: EditorStateSnapshot<TEditor>) => TSelectorResult;
  /**
   * A custom equality function to determine if the editor should re-render.
   * @default `deepEqual` from `fast-deep-equal`
   */
  equalityFn?: (a: TSelectorResult, b: TSelectorResult | null) => boolean;
};

/**
 * To synchronize the editor instance with the component state,
 * we need to create a separate instance that is not affected by the component re-renders.
 */
class EditorStateManager<TEditor extends Editor | null = Editor | null> {
  private transactionNumber = 0

private lastTransactionNumber = 0

private lastSnapshot: EditorStateSnapshot<TEditor>

private editor: TEditor

private subscribers = new Set<() => void>()

constructor(initialEditor: TEditor) {
    this.editor = initialEditor
    this.lastSnapshot = { editor: initialEditor, transactionNumber: 0 }

this.getSnapshot = this.getSnapshot.bind(this)
    this.getServerSnapshot = this.getServerSnapshot.bind(this)
    this.watch = this.watch.bind(this)
    this.subscribe = this.subscribe.bind(this)
  }

/**
   * Get the current editor instance.
   */
  getSnapshot(): EditorStateSnapshot<TEditor> {
    if (this.transactionNumber === this.lastTransactionNumber) {
      return this.lastSnapshot
    }
    this.lastTransactionNumber = this.transactionNumber
    this.lastSnapshot = { editor: this.editor, transactionNumber: this.transactionNumber }
    return this.lastSnapshot
  }

/**
   * Always disable the editor on the server-side.
   */
  getServerSnapshot(): EditorStateSnapshot<null> {
    return { editor: null, transactionNumber: 0 }
  }

/**
   * Subscribe to the editor instance's changes.
   */
  subscribe(callback: () => void): () => void {
    this.subscribers.add(callback)
    return () => {
      this.subscribers.delete(callback)
    }
  }

/**
   * Watch the editor instance for changes.
   */
  watch(nextEditor: Editor | null): undefined | (() => void) {
    this.editor = nextEditor as TEditor

if (this.editor) {
      /**
       * This will force a re-render when the editor state changes.
       * This is to support things like `editor.can().toggleBold()` in components that `useEditor`.
       * This could be more efficient, but it's a good trade-off for now.
       */
      const fn = () => {
        this.transactionNumber += 1
        this.subscribers.forEach(callback => callback())
      }

const currentEditor = this.editor

currentEditor.on('transaction', fn)
      return () => {
        currentEditor.off('transaction', fn)
      }
    }

return undefined
  }
}

/**
 * This hook allows you to watch for changes on the editor instance.
 * It will allow you to select a part of the editor state and re-render the component when it changes.
 * @example
 * ```tsx
 * const editor = useEditor({...options})
 * const { currentSelection } = useEditorState({
 *  editor,
 *  selector: snapshot => ({ currentSelection: snapshot.editor.state.selection }),
 * })
 */
export function useEditorState<TSelectorResult>(
  options: UseEditorStateOptions<TSelectorResult, Editor>
): TSelectorResult;
/**
 * This hook allows you to watch for changes on the editor instance.
 * It will allow you to select a part of the editor state and re-render the component when it changes.
 * @example
 * ```tsx
 * const editor = useEditor({...options})
 * const { currentSelection } = useEditorState({
 *  editor,
 *  selector: snapshot => ({ currentSelection: snapshot.editor.state.selection }),
 * })
 */
export function useEditorState<TSelectorResult>(
  options: UseEditorStateOptions<TSelectorResult, Editor | null>
): TSelectorResult | null;

// Using the `useSyncExternalStore` hook to sync the editor instance with the component state
  const selectedState = useSyncExternalStoreWithSelector(
    editorStateManager.subscribe,
    editorStateManager.getSnapshot,
    editorStateManager.getServerSnapshot,
    options.selector as UseEditorStateOptions<TSelectorResult, Editor | null>['selector'],
    options.equalityFn ?? deepEqual,
  )

useIsomorphicLayoutEffect(() => {
    return editorStateManager.watch(options.editor)
  }, [options.editor, editorStateManager])

useDebugValue(selectedState)

return selectedState
}

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Directory Contents

Dirs: 0 × Files: 14

Sort:

Enable drag-to-move

Name	Size	Perms	Modified	Actions
BubbleMenu.tsx	1.56 KB	lrw-r--r--	2026-02-28 11:47:14	Edit Download recursive recursive
Context.tsx	1.42 KB	lrw-r--r--	2026-02-28 11:47:14	Edit Download recursive recursive
Editor.ts	510 B	lrw-r--r--	2026-02-28 11:47:14	Edit Download recursive recursive
EditorContent.tsx	5.75 KB	lrw-r--r--	2026-02-28 11:47:14	Edit Download recursive recursive
FloatingMenu.tsx	1.56 KB	lrw-r--r--	2026-02-28 11:47:14	Edit Download recursive recursive
index.ts	443 B	lrw-r--r--	2026-02-28 11:47:14	Edit Download recursive recursive
NodeViewContent.tsx	546 B	lrw-r--r--	2026-02-28 11:47:14	Edit Download recursive recursive
NodeViewWrapper.tsx	579 B	lrw-r--r--	2026-02-28 11:47:14	Edit Download recursive recursive
ReactNodeViewRenderer.tsx	10.57 KB	lrw-r--r--	2026-02-28 11:47:14	Edit Download recursive recursive
ReactRenderer.tsx	6.18 KB	lrw-r--r--	2026-02-28 11:47:14	Edit Download recursive recursive
types.ts	210 B	lrw-r--r--	2026-02-28 11:47:14	Edit Download recursive recursive
useEditor.ts	12.35 KB	lrw-r--r--	2026-02-28 11:47:14	Edit Download recursive recursive
useEditorState.ts	5.54 KB	lrw-r--r--	2026-02-28 11:47:14	Edit Download recursive recursive
useReactNodeView.ts	392 B	lrw-r--r--	2026-02-28 11:47:14	Edit Download recursive recursive