@mdxeditor/editor 2.10.0 → 2.11.0

package/dist/index.d.ts

@@ -818,6 +818,11 @@ export declare const diffSourcePlugin: (params?: {
      * Optional, additional CodeMirror extensions to load in the diff/source mode.
      */
     codeMirrorExtensions?: Extension_2[] | undefined;
+    /**
+     * Set the diff editor to read-only.
+     * @default false
+     */
+    readOnlyDiff?: boolean | undefined;
 } | undefined) => RealmPlugin;
 
 /**
@@ -2204,6 +2209,8 @@ export declare const quotePlugin: (params?: unknown) => RealmPlugin;
  */
 export declare const readOnly$: NodeRef<boolean>;
 
+/* Excluded from this release type: readOnlyDiff$ */
+
 /**
  * A plugin for the editor.
  * @group Core

package/dist/index.js

@@ -24,7 +24,7 @@ import { ADMONITION_TYPES, AdmonitionDirectiveDescriptor } from "./directive-edi
 import { GenericDirectiveEditor } from "./directive-editors/GenericDirectiveEditor.js";
 import { applyLinkChanges$, cancelLinkEdit$, linkAutocompleteSuggestions$, linkDialogPlugin, linkDialogState$, onClickLinkCallback$, onWindowChange$, openLinkEditDialog$, removeLink$, switchFromPreviewToLinkEdit$, updateLink$ } from "./plugins/link-dialog/index.js";
 import { toolbarContents$, toolbarPlugin } from "./plugins/toolbar/index.js";
-import { cmExtensions$, diffMarkdown$, diffSourcePlugin } from "./plugins/diff-source/index.js";
+import { cmExtensions$, diffMarkdown$, diffSourcePlugin, readOnlyDiff$ } from "./plugins/diff-source/index.js";
 import { markdownShortcutPlugin } from "./plugins/markdown-shortcut/index.js";
 import { BlockTypeSelect } from "./plugins/toolbar/components/BlockTypeSelect.js";
 import { BoldItalicUnderlineToggles } from "./plugins/toolbar/components/BoldItalicUnderlineToggles.js";
@@ -260,6 +260,7 @@ export {
   prop,
   quotePlugin,
   readOnly$,
+  readOnlyDiff$,
   realmPlugin,
   removeFrontmatter$,
   removeLink$,

package/dist/plugins/diff-source/DiffViewer.js

@@ -1,6 +1,6 @@
 import React__default from "react";
-import { diffMarkdown$, cmExtensions$ } from "./index.js";
-import { markdown$, markdownSourceEditorValue$, onBlur$ } from "../core/index.js";
+import { diffMarkdown$, readOnlyDiff$, cmExtensions$ } from "./index.js";
+import { markdown$, readOnly$, markdownSourceEditorValue$, onBlur$ } from "../core/index.js";
 import { MergeView } from "@codemirror/merge";
 import { EditorState } from "@codemirror/state";
 import { EditorView } from "@codemirror/view";
@@ -13,7 +13,7 @@ function setContent(view, content) {
 }
 const DiffViewer = () => {
   const realm = useRealm();
-  const [newMarkdown, oldMarkdown] = useCellValues(markdown$, diffMarkdown$);
+  const [newMarkdown, oldMarkdown, readOnly, readOnlyDiff] = useCellValues(markdown$, diffMarkdown$, readOnly$, readOnlyDiff$);
   const onUpdate = usePublisher(markdownSourceEditorValue$);
   const elRef = React__default.useRef(null);
   const cmMergeViewRef = React__default.useRef(null);
@@ -32,16 +32,23 @@ const DiffViewer = () => {
     });
   }, [realm]);
   React__default.useEffect(() => {
-    cmMergeViewRef.current = new MergeView({
+    const isReadOnly = readOnly || readOnlyDiff;
+    const revertParams = isReadOnly ? {
+      renderRevertControl: void 0,
+      revertControls: void 0
+    } : {
       renderRevertControl: () => {
         const el = document.createElement("button");
         el.classList.add("cm-merge-revert");
         el.appendChild(document.createTextNode("⮕"));
         return el;
       },
+      revertControls: "a-to-b"
+    };
+    cmMergeViewRef.current = new MergeView({
+      ...revertParams,
       parent: elRef.current,
       orientation: "a-b",
-      revertControls: "a-to-b",
       gutter: true,
       a: {
         doc: oldMarkdown,
@@ -52,6 +59,7 @@ const DiffViewer = () => {
         extensions: [
           ...cmExtensions,
           ...COMMON_STATE_CONFIG_EXTENSIONS,
+          EditorState.readOnly.of(isReadOnly),
           EditorView.updateListener.of(({ state }) => {
             const md = state.doc.toString();
             onUpdate(md);

package/dist/plugins/diff-source/index.js

@@ -4,21 +4,24 @@ import { Cell } from "@mdxeditor/gurx";
 import { realmPlugin } from "../../RealmWithPlugins.js";
 const diffMarkdown$ = Cell("");
 const cmExtensions$ = Cell([]);
+const readOnlyDiff$ = Cell(false);
 const diffSourcePlugin = realmPlugin({
   update: (r, params) => {
-    r.pub(diffMarkdown$, (params == null ? void 0 : params.diffMarkdown) || "");
+    r.pub(diffMarkdown$, (params == null ? void 0 : params.diffMarkdown) ?? "");
   },
   init(r, params) {
     r.pubIn({
-      [diffMarkdown$]: (params == null ? void 0 : params.diffMarkdown) || "",
-      [cmExtensions$]: (params == null ? void 0 : params.codeMirrorExtensions) || [],
+      [diffMarkdown$]: (params == null ? void 0 : params.diffMarkdown) ?? "",
+      [cmExtensions$]: (params == null ? void 0 : params.codeMirrorExtensions) ?? [],
       [addEditorWrapper$]: DiffSourceWrapper,
-      [viewMode$]: (params == null ? void 0 : params.viewMode) || "rich-text"
+      [readOnlyDiff$]: (params == null ? void 0 : params.readOnlyDiff) ?? false,
+      [viewMode$]: (params == null ? void 0 : params.viewMode) ?? "rich-text"
     });
   }
 });
 export {
   cmExtensions$,
   diffMarkdown$,
-  diffSourcePlugin
+  diffSourcePlugin,
+  readOnlyDiff$
 };

package/package.json

@@ -11,7 +11,7 @@
     "*.css"
   ],
   "type": "module",
-  "version": "2.10.0",
+  "version": "2.11.0",
   "description": "React component for rich text markdown editing",
   "scripts": {
     "build": "vite build",