@mdxeditor/editor 3.36.0 → 3.38.0

package/dist/index.d.ts

@@ -36,6 +36,7 @@ import { Options } from 'mdast-util-from-markdown';
 import { Options as Options_2 } from 'mdast-util-to-markdown/lib/types';
 import { Options as Options_3 } from 'mdast-util-gfm-table';
 import { ParseOptions } from 'micromark-util-types';
+import { PropsWithChildren } from 'react';
 import * as RadixToolbar from '@radix-ui/react-toolbar';
 import { RangeSelection } from 'lexical';
 import { ReactNode } from 'react';
@@ -2519,6 +2520,25 @@ export declare function realmPlugin<Params>(plugin: {
  */
 export declare type RectData = Pick<DOMRect, 'height' | 'width' | 'top' | 'left'>;
 
+/**
+ * A context provider that allows you to register and access realms of remote MDX editors.
+ * @group Utils
+ */
+export declare const RemoteMDXEditorRealmProvider: FC<PropsWithChildren>;
+
+/**
+ * A plugin that allows you to access the editor's realm outside of the editor's component tree.
+ * Requires wrapping your application in the `RemoteMDXEditorRealmProvider` component.
+ * @see {@link useRemoteMDXEditorRealm}.
+ * @group Utils
+ */
+export declare const remoteRealmPlugin: (params?: {
+    /**
+     * The id to access the realm with. See {@link useRemoteMDXEditorRealm}.
+     */
+    editorId: string;
+} | undefined) => RealmPlugin;
+
 /**
  * Removes the frontmatter node from the markdown document.
  * @group Frontmatter
@@ -2979,6 +2999,13 @@ export declare function useMdastNodeUpdater<T extends Mdast.RootContent>(): (nod
  */
 export declare function useNestedEditorContext<T extends Mdast.RootContent>(): NestedEditorsContextValue<T>;
 
+/**
+ * A hook to access the realm of a remote MDX editor by its ID. You need to wrap your tree in the `RemoteMDXEditorRealmProvider` and add the {@link remoteRealmPlugin} to the editor's instance.
+ * @param editorId - The id passed to the {@link remoteRealmPlugin} of the MDX editor instance.
+ * @group Utils
+ */
+export declare function useRemoteMDXEditorRealm(editorId: string): Realm | undefined;
+
 export declare function useTranslation(): Translation;
 
 /* Excluded from this release type: uuidv4 */

package/dist/index.js

@@ -52,6 +52,7 @@ import { TooltipWrap } from "./plugins/toolbar/primitives/TooltipWrap.js";
 import { Select, SelectButtonTrigger, SelectContent, SelectItem, SelectTrigger } from "./plugins/toolbar/primitives/select.js";
 import { NestedEditorsContext, NestedLexicalEditor, useLexicalNodeRemove, useMdastNodeUpdater, useNestedEditorContext } from "./plugins/core/NestedLexicalEditor.js";
 import { PropertyPopover } from "./plugins/core/PropertyPopover.js";
+import { RemoteMDXEditorRealmProvider, remoteRealmPlugin, useRemoteMDXEditorRealm } from "./plugins/remote/index.js";
 import { CAN_USE_DOM, IS_APPLE, controlOrMeta } from "./utils/detectMac.js";
 import { always, call, compose, curry1to0, curry2to1, joinProc, noop, prop, tap, thrush } from "./utils/fp.js";
 import { isPartOftheEditorUI } from "./utils/isPartOftheEditorUI.js";
@@ -139,6 +140,7 @@ export {
   NestedLexicalEditor,
   PropertyPopover,
   RealmWithPlugins,
+  RemoteMDXEditorRealmProvider,
   Root,
   SandpackEditor,
   Select,
@@ -297,6 +299,7 @@ export {
   readOnly$,
   readOnlyDiff$,
   realmPlugin,
+  remoteRealmPlugin,
   removeFrontmatter$,
   removeLink$,
   rootEditor$,
@@ -324,6 +327,7 @@ export {
   useLexicalNodeRemove,
   useMdastNodeUpdater,
   useNestedEditorContext,
+  useRemoteMDXEditorRealm,
   useTranslation,
   usedLexicalNodes$,
   uuidv4,

package/dist/plugins/remote/index.js

@@ -0,0 +1,51 @@
+import React__default, { useEffect, useCallback, useMemo, createContext } from "react";
+import { realmPlugin } from "../../RealmWithPlugins.js";
+import { addComposerChild$ } from "../core/index.js";
+const RemoteMDXEditorRealmContextValueStub = {
+  editorMap: /* @__PURE__ */ new Map(),
+  registerEditor: (_id, _realm) => void 0
+};
+const RemoteMDXEditorRealmContext = createContext(RemoteMDXEditorRealmContextValueStub);
+const RemoteMDXEditorRealmProvider = ({ children }) => {
+  const [editorMap, setEditorMap] = React__default.useState(/* @__PURE__ */ new Map());
+  useEffect(() => {
+    return () => {
+      setEditorMap(/* @__PURE__ */ new Map());
+    };
+  }, []);
+  const registerEditor = useCallback((id, realm) => {
+    setEditorMap((prev) => {
+      return new Map(prev).set(id, realm);
+    });
+  }, []);
+  const contextValue = useMemo(
+    () => ({
+      editorMap,
+      registerEditor
+    }),
+    [editorMap, registerEditor]
+  );
+  return /* @__PURE__ */ React__default.createElement(RemoteMDXEditorRealmContext.Provider, { value: contextValue }, children);
+};
+const RemotePluginRegister = ({ realm, editorId }) => {
+  const { registerEditor } = React__default.useContext(RemoteMDXEditorRealmContext);
+  useEffect(() => {
+    registerEditor(editorId, realm);
+  }, [realm, editorId, registerEditor]);
+  return null;
+};
+const remoteRealmPlugin = realmPlugin({
+  init: (realm, params) => {
+    if (params == null ? void 0 : params.editorId) {
+      realm.pub(addComposerChild$, () => /* @__PURE__ */ React__default.createElement(RemotePluginRegister, { realm, editorId: params.editorId }));
+    }
+  }
+});
+function useRemoteMDXEditorRealm(editorId) {
+  return React__default.useContext(RemoteMDXEditorRealmContext).editorMap.get(editorId);
+}
+export {
+  RemoteMDXEditorRealmProvider,
+  remoteRealmPlugin,
+  useRemoteMDXEditorRealm
+};

package/package.json

@@ -11,7 +11,7 @@
     "*.css"
   ],
   "type": "module",
-  "version": "3.36.0",
+  "version": "3.38.0",
   "description": "React component for rich text markdown editing",
   "scripts": {
     "build": "vite build",
@@ -44,15 +44,15 @@
     "@codemirror/state": "^6.4.0",
     "@codemirror/view": "^6.23.0",
     "@codesandbox/sandpack-react": "^2.20.0",
-    "@lexical/clipboard": "^0.27.1",
-    "@lexical/link": "^0.27.1",
-    "@lexical/list": "^0.27.1",
-    "@lexical/markdown": "^0.27.1",
-    "@lexical/plain-text": "^0.27.1",
-    "@lexical/react": "^0.27.1",
-    "@lexical/rich-text": "^0.27.1",
-    "@lexical/selection": "^0.27.1",
-    "@lexical/utils": "^0.27.1",
+    "@lexical/clipboard": "^0.32.1",
+    "@lexical/link": "^0.32.1",
+    "@lexical/list": "^0.32.1",
+    "@lexical/markdown": "^0.32.1",
+    "@lexical/plain-text": "^0.32.1",
+    "@lexical/react": "^0.32.1",
+    "@lexical/rich-text": "^0.32.1",
+    "@lexical/selection": "^0.32.1",
+    "@lexical/utils": "^0.32.1",
     "@mdxeditor/gurx": "^1.1.4",
     "@radix-ui/colors": "^3.0.0",
     "@radix-ui/react-dialog": "^1.1.11",
@@ -68,7 +68,7 @@
     "codemirror": "^6.0.1",
     "downshift": "^7.6.0",
     "js-yaml": "4.1.0",
-    "lexical": "^0.27.1",
+    "lexical": "^0.32.1",
     "mdast-util-directive": "^3.0.0",
     "mdast-util-from-markdown": "^2.0.0",
     "mdast-util-frontmatter": "^2.0.1",