import { type EditorView } from '@codemirror/view'; import { type CodeEditorProps } from '../../CodeEditor.types'; import { type CodeEditorModules } from '../moduleLoaders.types'; import { useExtension } from './useExtension'; /** * Hook for managing the read-only state of the CodeMirror editor. * * When enabled, this extension prevents users from editing the content * of the editor, making it effectively read-only. The extension is * dynamically updated based on the `readOnly` prop. * * @param params - Configuration object * @param params.editorViewInstance - The CodeMirror editor view instance * @param params.props - Partial CodeEditor props containing the readOnly flag * @param params.modules - Module dependencies (requires @codemirror/state for EditorState.readOnly) * @returns A CodeMirror extension that controls read-only behavior */ export function useReadOnlyExtension({ editorViewInstance, props, modules, }: { editorViewInstance: EditorView | null; props: Partial; modules: Partial; }) { return useExtension({ editorViewInstance, stateModule: modules?.['@codemirror/state'], value: { enable: props.readOnly, module: modules?.['@codemirror/state'], EditorViewModule: modules?.['@codemirror/view'], }, factory: ({ enable, module, EditorViewModule }) => enable && module && EditorViewModule ? [ // Prevents editing module.EditorState.readOnly.of(true), // Prevents cursor from blinking EditorViewModule.EditorView.editable.of(false), ] : [], }); }