@mdxeditor/editor 0.11.1 → 0.13.0

package/dist/MDXEditor.d.ts

@@ -34,6 +34,14 @@ export interface MDXEditorProps {
      * For a content-specific styling, Use `contentEditableClassName` property.
      */
     className?: string;
+    /**
+     * pass if you would like to have the editor automatically focused when mounted.
+     */
+    autoFocus?: boolean;
+    /**
+     * The placeholder contents, displayed when the editor is empty.
+     */
+    placeholder?: React.ReactNode;
 }
 /**
  * The interface for the {@link MDXEditor} object reference.

package/dist/MDXEditor.js

@@ -1,11 +1,11 @@
 import React__default from "react";
 import { corePlugin, corePluginHooks } from "./plugins/core/index.js";
 import { lexicalTheme } from "./styles/lexicalTheme.js";
-import { LexicalComposer } from "@lexical/react/LexicalComposer";
+import { LexicalComposer } from "@lexical/react/LexicalComposer.js";
 import styles from "./styles/ui.module.css.js";
-import { RichTextPlugin } from "@lexical/react/LexicalRichTextPlugin";
-import { ContentEditable } from "@lexical/react/LexicalContentEditable";
-import LexicalErrorBoundary from "@lexical/react/LexicalErrorBoundary";
+import { RichTextPlugin } from "@lexical/react/LexicalRichTextPlugin.js";
+import { ContentEditable } from "@lexical/react/LexicalContentEditable.js";
+import LexicalErrorBoundary from "@lexical/react/LexicalErrorBoundary.js";
 import classNames from "classnames";
 import { noop } from "./utils/fp.js";
 import { RealmPluginInitializer } from "./gurx/react.js";
@@ -28,20 +28,21 @@ const LexicalProvider = ({ children }) => {
   );
 };
 const RichTextEditor = () => {
-  const [contentEditableClassName, composerChildren, topAreaChildren, editorWrappers] = corePluginHooks.useEmitterValues(
+  const [contentEditableClassName, composerChildren, topAreaChildren, editorWrappers, placeholder] = corePluginHooks.useEmitterValues(
     "contentEditableClassName",
     "composerChildren",
     "topAreaChildren",
-    "editorWrappers"
+    "editorWrappers",
+    "placeholder"
   );
-  return /* @__PURE__ */ React__default.createElement(React__default.Fragment, null, topAreaChildren.map((Child, index) => /* @__PURE__ */ React__default.createElement(Child, { key: index })), /* @__PURE__ */ React__default.createElement(RenderRecurisveWrappers, { wrappers: editorWrappers }, /* @__PURE__ */ React__default.createElement(
+  return /* @__PURE__ */ React__default.createElement(React__default.Fragment, null, topAreaChildren.map((Child, index) => /* @__PURE__ */ React__default.createElement(Child, { key: index })), /* @__PURE__ */ React__default.createElement(RenderRecurisveWrappers, { wrappers: editorWrappers }, /* @__PURE__ */ React__default.createElement("div", { className: classNames(styles.rootContentEditableWrapper) }, /* @__PURE__ */ React__default.createElement(
     RichTextPlugin,
     {
       contentEditable: /* @__PURE__ */ React__default.createElement(ContentEditable, { className: classNames(styles.contentEditable, contentEditableClassName) }),
-      placeholder: /* @__PURE__ */ React__default.createElement("div", null),
+      placeholder: /* @__PURE__ */ React__default.createElement("div", { className: classNames(styles.contentEditable, styles.placeholder) }, /* @__PURE__ */ React__default.createElement("p", null, placeholder)),
       ErrorBoundary: LexicalErrorBoundary
     }
-  )), composerChildren.map((Child, index) => /* @__PURE__ */ React__default.createElement(Child, { key: index })));
+  ))), composerChildren.map((Child, index) => /* @__PURE__ */ React__default.createElement(Child, { key: index })));
 };
 const DEFAULT_MARKDOWN_OPTIONS = {
   listItemIndent: "one"
@@ -91,7 +92,9 @@ const MDXEditor = React__default.forwardRef((props, ref) => {
           contentEditableClassName: props.contentEditableClassName ?? "",
           initialMarkdown: props.markdown,
           onChange: props.onChange ?? noop,
-          toMarkdownOptions: props.toMarkdownOptions ?? DEFAULT_MARKDOWN_OPTIONS
+          toMarkdownOptions: props.toMarkdownOptions ?? DEFAULT_MARKDOWN_OPTIONS,
+          autoFocus: props.autoFocus ?? false,
+          placeholder: props.placeholder ?? ""
         }),
         ...props.plugins || []
       ]

package/dist/exportMarkdownFromLexical.d.ts

@@ -74,15 +74,31 @@ export interface LexicalExportVisitor<LN extends LexicalNode, UN extends Mdast.C
      */
     join?<T extends Mdast.Content>(prevNode: T, currentNode: T): T;
 }
+/**
+ * The "any" type for LexicalExportVisitor.
+ * @internal
+ */
 export type LexicalVisitor = LexicalExportVisitor<LexicalNode, Mdast.Content>;
+/**
+ * @internal
+ */
 export interface ExportLexicalTreeOptions {
     root: LexicalRootNode;
     visitors: LexicalVisitor[];
     jsxComponentDescriptors: JsxComponentDescriptor[];
     jsxIsAvailable: boolean;
 }
+/**
+ * @internal
+ */
 export declare function exportLexicalTreeToMdast({ root, visitors, jsxComponentDescriptors, jsxIsAvailable }: ExportLexicalTreeOptions): Mdast.Root;
+/**
+ * @internal
+ */
 export type ToMarkdownExtension = NonNullable<ToMarkdownOptions['extensions']>[number];
+/**
+ * @internal
+ */
 export interface ExportMarkdownFromLexicalOptions extends ExportLexicalTreeOptions {
     visitors: LexicalVisitor[];
     /**
@@ -111,4 +127,7 @@ export interface LexicalConvertOptions {
      */
     toMarkdownOptions?: ToMarkdownOptions;
 }
+/**
+ * @internal
+ */
 export declare function exportMarkdownFromLexical({ root, toMarkdownOptions, toMarkdownExtensions, visitors, jsxComponentDescriptors, jsxIsAvailable }: ExportMarkdownFromLexicalOptions): string;

package/dist/gurx/react.d.ts

@@ -4,7 +4,7 @@ import type { ValuesForKeys, TypedRealm,  System,  RealmFactory,  ValueForKey,
 /**
  * Describes the mapping between the system streams and the component properties.
  * Each property uses the keys as the names of the properties and the values as the corresponding stream names.
- * @typeParam SS the type of the system.
+ * @typeParam SS - the type of the system.
  */
 export interface SystemPropsMap<Sys extends System, K = keyof Sys, D = {
     [name: string]: K;
@@ -42,8 +42,10 @@ export type MethodsFromPropMap<Sys extends System, Map extends SystemPropsMap<Sy
     [K in StringKeys<Map['methods']>]: Map['methods'][K] extends string ? Sys[Map['methods'][K]] extends RealmNode<infer R> ? (value: R) => void : never : never;
 };
 /**
- * Used to correctly specify type refs for system components
+ * @internal
+ * Used to correctly specify type refs for system components.
  *
+ * @example
  * ```tsx
  * const s = system(() => { return { a: statefulStream(0) } })
  * const { Component } = systemToComponent(s)
@@ -54,15 +56,15 @@ export type MethodsFromPropMap<Sys extends System, Map extends SystemPropsMap<Sy
  * }
  * ```
  *
- * @typeParam T the type of the component
+ * @typeParam T - the type of the component
  */
 export type RefHandle<T> = T extends React.ForwardRefExoticComponent<React.RefAttributes<infer Handle>> ? Handle : never;
 /**
  * Converts a system spec to React component by mapping the system streams to component properties, events and methods. Returns hooks for querying and modifying
  * the system streams from the component's child components.
- * @param realmFactory The return value from a [[system]] call.
- * @param map The streams to props / events / methods mapping Check [[SystemPropsMap]] for more details.
- * @param Root The optional React component to render. By default, the resulting component renders nothing, acting as a logical wrapper for its children.
+ * @param realmFactory - The return value from a [[system]] call.
+ * @param map - The streams to props / events / methods mapping Check [[SystemPropsMap]] for more details.
+ * @param Root - The optional React component to render. By default, the resulting component renders nothing, acting as a logical wrapper for its children.
  * @returns an object containing the following:
  *  - `Component`: the React component.
  *  - `useEmitterValue`: a hook that lets child components use values emitted from the specified output stream.
@@ -80,6 +82,7 @@ export declare function realmFactoryToComponent<RootComp, RF extends RealmFactor
         children?: React.ReactNode;
     })> & React.RefAttributes<MethodsFromPropMap<Sys, M>>>;
 };
+/** @internal */
 export declare function sysHooks<Sys extends System>(): {
     useRealmContext: () => TypedRealm<Sys>;
     useEmitter: <K extends Extract<keyof Sys, string>>(key: K, callback: (value: ValueForKey<Sys, K>) => void) => void;
@@ -88,18 +91,40 @@ export declare function sysHooks<Sys extends System>(): {
     usePublisher: <K_2 extends keyof Sys>(key: K_2) => (value: ValueForKey<Sys, K_2>) => void;
 };
 type SystemAndDependencies<Spec extends AnySystemSpec> = SystemOfSpecs<[Spec]> & SystemOfSpecs<Spec['dependencies']>;
+/**
+ * The parameters of a plugin declaration. THe best way to understand what each one does is to examine the source code of the existing plugins.
+ */
 export interface RealmPluginParams<Spec extends AnySystemSpec, Params extends object> {
+    /**
+     * The id of the plugin. Used to declare conditional features that are activated only if the plugin is present.
+     */
     id: string;
+    /**
+     * The ids of the plugins that this plugin depends on. The plugin will not be activated if any of the dependencies is not present.
+     */
     dependencies?: string[];
+    /**
+     * The system spec of the plugin. Construct one using {@link system}.
+     */
     systemSpec: Spec;
+    /**
+     * The callback is executed every time the react component is re-rendered.
+     */
     applyParamsToSystem?: (realm: TypedRealm<SystemAndDependencies<Spec>>, props: Params) => void;
+    /**
+     * Executed when the component mounts. Use this to register import/export visitors, add lexical nodes to the editor, etc.
+     */
     init?: (realm: TypedRealm<SystemAndDependencies<Spec>>, props: Params) => void;
 }
+/** @internal */
 export interface PluginConstructor<Spec extends AnySystemSpec, Params extends object> {
     (params?: Params): {
         pluginParams?: Params;
     } & RealmPluginParams<Spec, Params>;
 }
+/**
+ * Declares a new MDXEditor plugin.
+ */
 export declare function realmPlugin<Spec extends AnySystemSpec, Params extends object>(params: RealmPluginParams<Spec, Params>): readonly [PluginConstructor<Spec, Params>, {
     useRealmContext: () => TypedRealm<SystemAndDependencies<Spec>>;
     useEmitter: <K extends Extract<keyof (Spec extends AnySystemSpec ? {} & ReturnType<Spec["constructor"]> : never), string> | Extract<keyof SystemOfSpecs<Spec["dependencies"]>, string>>(key: K, callback: (value: ValueForKey<SystemAndDependencies<Spec>, K>) => void) => void;
@@ -107,13 +132,16 @@ export declare function realmPlugin<Spec extends AnySystemSpec, Params extends o
     usePubKeys: () => (values: SystemDict<SystemAndDependencies<Spec>>) => void;
     usePublisher: <K_2 extends keyof (Spec extends AnySystemSpec ? {} & ReturnType<Spec["constructor"]> : never) | keyof SystemOfSpecs<Spec["dependencies"]>>(key: K_2) => (value: ValueForKey<SystemAndDependencies<Spec>, K_2>) => void;
 }];
+/** @internal */
 export declare const RealmPluginInitializer: <P extends ({
     pluginParams?: any;
 } & RealmPluginParams<AnySystemSpec, any>)[]>({ plugins, children }: {
     plugins: P;
     children?: React.ReactNode;
 }) => React.FunctionComponentElement<React.ProviderProps<TypedRealm<any>>>;
+/** @internal */
 export declare function useHasPlugin(id: string): boolean;
+/** @internal */
 export declare const RequirePlugin: React.FC<{
     id: string;
     children: React.ReactNode;

package/dist/gurx/realm.d.ts

@@ -1,20 +1,26 @@
 import { LongTuple } from './realmFactory';
+/** @internal */
 export type NodeKey = string;
-export interface RealmNode<T = unknown> {
+/** @internal */
+export interface RealmNode<_T = unknown> {
     key: NodeKey;
     toString(): string;
 }
 /** @internal */
 type RN<T = unknown> = RealmNode<T>;
+/** @internal **/
 export type Subscription<T = any> = (value: T) => unknown;
+/** @internal */
 export type UnsubscribeHandle = () => void;
 type ProjectionFunc<T extends unknown[] = unknown[]> = (done: (...values: unknown[]) => void) => (...args: T) => void;
+/** @internal */
 export interface RealmProjection<T extends unknown[] = unknown[]> {
     sources: Set<NodeKey>;
     pulls: Set<NodeKey>;
     sink: NodeKey;
     map: ProjectionFunc<T>;
 }
+/** @internal */
 export interface RealmProjectionSpec<T extends unknown[] = unknown[]> {
     sources: RealmNode[];
     pulls?: RealmNode[];
@@ -23,14 +29,18 @@ export interface RealmProjectionSpec<T extends unknown[] = unknown[]> {
 }
 /**
  * A function which determines if two values are equal.
- * Implement custom comparators when [[distinctUntilChanged]] needs to work on non-primitive objects.
+ * Implement custom comparators when the distinctUntilChanged operator needs to work on non-primitive objects.
  * @returns true if values should be considered equal.
  */
 export interface Comparator<T = any> {
     (current: T, next: T): boolean;
 }
 type NodesFromValuesRec<T extends unknown[], Acc extends unknown[]> = T extends [infer Head, ...infer Tail] ? NodesFromValuesRec<Tail, [...Acc, Head extends unknown ? RealmNode<Head> : never]> : Acc;
+/** @internal */
 export type NodesFromValues<T extends unknown[]> = T extends unknown[] ? NodesFromValuesRec<T, []> : never;
+/**
+ * A comparator function to determine if two values are equal. Used by distinctUntilChanged  operator.
+ */
 export declare function defaultComparator<T>(current: T, next: T): boolean;
 declare class SetMap<T> {
     map: Map<string, Set<T>>;
@@ -39,6 +49,9 @@ declare class SetMap<T> {
     use(key: NodeKey, cb: (value: Set<T>) => unknown): void;
     delete(key: NodeKey): boolean;
 }
+/**
+ * @internal
+ */
 export declare class RefCount {
     map: Map<NodeKey, number>;
     constructor(map?: Map<string, number>);
@@ -46,7 +59,9 @@ export declare class RefCount {
     increment(key: NodeKey): void;
     decrement(key: NodeKey, ifZero: () => void): void;
 }
+/** @internal */
 export type RealmGraph = SetMap<RealmProjection>;
+/** @internal */
 export declare function realm(): {
     combine: {
         <T1>(nodes_0: RN<T1>): RN<T1>;
@@ -128,6 +143,7 @@ export declare function realm(): {
     subKey: (key: string, subscription: Subscription<unknown>) => UnsubscribeHandle;
     subKeys: (keys: string[], subscription: Subscription<unknown>) => UnsubscribeHandle;
 };
+/** @internal */
 export interface Realm extends ReturnType<typeof realm> {
 }
 export {};

package/dist/gurx/realmFactory.d.ts

@@ -1,4 +1,7 @@
 import { Realm, RealmNode, Subscription, UnsubscribeHandle } from './realm';
+/**
+ * The system interface is the runtime representation of a state management module, a a record of nodes.
+ */
 export interface System {
     [key: string]: RealmNode<any>;
 }
@@ -12,11 +15,13 @@ export interface SystemSpec<Dependencies extends AnySystemSpecs, /** @internal *
     constructor: Constructor;
     dependencies: Dependencies;
 }
+/** @internal **/
 export interface AnySystemSpec extends SystemSpec<AnySystemSpecs, any> {
     id: string;
 }
-export interface AnySystemSpecs extends Array<AnySystemSpec> {
-}
+/** @internal **/
+export type AnySystemSpecs = Array<AnySystemSpec>;
+/** @internal **/
 export type SystemOfSpec<Spec extends AnySystemSpec> = ReturnType<Spec['constructor']>;
 /** @internal **/
 export type SSR<Spec extends AnySystemSpec> = SystemOfSpec<Spec>;
@@ -30,19 +35,32 @@ type SystemsFromSpecsRec<ST extends unknown[], Acc extends unknown[]> = ST exten
 export interface SystemConstructor<D extends AnySystemSpecs> {
     (r: Realm, dependencies: SystemsFromSpecs<D>): System;
 }
+/**
+ * Declare a new state management module (system). The constructor receives the realm and the dependencies as arguments.
+ * @param constructor - The system constructor.
+ * @param dependencies - The dependencies of the system - other systems.
+ */
 export declare function system<Dependencies extends LongTuple<AnySystemSpec>, Constructor extends SystemConstructor<Dependencies>>(constructor: Constructor, dependencies?: Dependencies): SystemSpec<Dependencies, Constructor>;
 type SystemKey<S extends System> = Extract<keyof S, string>;
+/** @internal */
 export type ValuesForKeys<S extends System, K extends SystemKey<S>[]> = K extends unknown[] ? ValuesForKeysRec<S, K, []> : never;
 type ValuesForKeysRec<S extends Record<any, RealmNode>, K extends unknown[], Acc extends unknown[]> = K extends [infer Head, ...infer Tail] ? ValuesForKeysRec<S, Tail, [...Acc, S[Head] extends RealmNode<infer R> ? R : never]> : Acc;
+/** @internal **/
 export type SystemOfSpecs<Specs extends AnySystemSpec[]> = Specs extends unknown[] ? SystemOfSpecsRec<Specs, {}> : Specs;
 type SystemOfSpecsRec<Specs extends unknown[], Acc extends {}> = Specs extends [infer Head, ...infer Tail] ? SystemOfSpecsRec<Tail, Head extends AnySystemSpec ? Acc & SystemOfSpec<Head> : never> : Acc;
+/** @internal */
 export type LongTuple<K> = [] | [K] | [K, K] | [K, K, K] | [K, K, K, K] | [K, K, K, K, K] | [K, K, K, K, K, K] | [K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K] | [K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K, K];
+/** @internal */
 export type SystemKeys<S extends System, K extends Extract<keyof S, string> = Extract<keyof S, string>> = LongTuple<K>;
+/** @internal */
 export type ValueForKey<S extends System, K extends keyof S> = S[K] extends RealmNode<infer V> ? V : never;
+/** @internal */
 export type SystemDict<S extends System> = {
     [K in keyof S]?: ValueForKey<S, K>;
 };
+/** @internal */
 export type SystemKeysArray<S extends System> = Array<keyof S>;
+/** @internal */
 export interface TypedRealm<S extends System> extends Pick<Realm, 'sub' | 'pub' | 'spread' | 'derive' | 'singletonSubKey' | 'resetSingletonSubs'> {
     getKeyValues<K extends SystemKeys<S>>(keys: K): ValuesForKeys<S, K>;
     getKeyValue<K extends keyof S>(key: K): ValueForKey<S, K>;
@@ -52,7 +70,10 @@ export interface TypedRealm<S extends System> extends Pick<Realm, 'sub' | 'pub'
     subKey<K extends keyof S>(key: K, subscription: Subscription<ValueForKey<S, K>>): UnsubscribeHandle;
     subKeys<K extends SystemKeys<S>>(keys: K, subscription: Subscription<ValuesForKeys<S, K>>): UnsubscribeHandle;
 }
+/** @internal */
 export declare function realmFactory<Specs extends LongTuple<AnySystemSpec>>(...specs: Specs): TypedRealm<SystemOfSpecs<Specs>>;
+/** @internal */
 export type RealmFactory<Sys extends System> = () => TypedRealm<Sys>;
+/** @internal */
 export declare function getRealmFactory<Specs extends LongTuple<AnySystemSpec>>(...specs: Specs): () => TypedRealm<SystemOfSpecs<[...Specs]>>;
 export {};

package/dist/icons/rich_text.svg.js

@@ -1,7 +1,7 @@
 import * as React from "react";
-const SvgRichText = (props) => /* @__PURE__ */ React.createElement("svg", { width: 24, height: 24, viewBox: "0 0 24 24", fill: "none", xmlns: "http://www.w3.org/2000/svg", ...props }, /* @__PURE__ */ React.createElement("mask", { id: "mask0_318_249", style: {
+const SvgRichText = (props) => /* @__PURE__ */ React.createElement("svg", { width: 24, height: 24, viewBox: "0 0 24 24", fill: "none", xmlns: "http://www.w3.org/2000/svg", ...props }, /* @__PURE__ */ React.createElement("mask", { id: "mask0_447_68", style: {
   maskType: "alpha"
-}, maskUnits: "userSpaceOnUse", x: 0, y: 0, width: 24, height: 24 }, /* @__PURE__ */ React.createElement("rect", { width: 24, height: 24, fill: "#D9D9D9" })), /* @__PURE__ */ React.createElement("g", { mask: "url(#mask0_318_249)" }, /* @__PURE__ */ React.createElement("path", { d: "M5 22V20H19V22H5Z", fill: "currentColor" }), /* @__PURE__ */ React.createElement("path", { d: "M6.80005 18V4H12.325C13.4084 4 14.4084 4.33333 15.325 5C16.2417 5.66667 16.7001 6.59167 16.7001 7.775C16.7001 8.625 16.5084 9.279 16.125 9.737C15.7417 10.1957 15.3834 10.525 15.05 10.725C15.4667 10.9083 15.9294 11.25 16.438 11.75C16.946 12.25 17.2001 13 17.2001 14C17.2001 15.4833 16.6584 16.521 15.575 17.113C14.4917 17.7043 13.475 18 12.525 18H6.80005ZM9.82505 15.2H12.425C13.225 15.2 13.7124 14.9957 13.887 14.587C14.0624 14.179 14.15 13.8833 14.15 13.7C14.15 13.5167 14.0624 13.2207 13.887 12.812C13.7124 12.404 13.2 12.2 12.35 12.2H9.82505V15.2ZM9.82505 9.5H12.15C12.7 9.5 13.1 9.35833 13.35 9.075C13.6 8.79167 13.725 8.475 13.725 8.125C13.725 7.725 13.5834 7.4 13.3 7.15C13.0167 6.9 12.65 6.775 12.2 6.775H9.82505V9.5Z", fill: "currentColor" })));
+}, maskUnits: "userSpaceOnUse", x: 0, y: 0, width: 24, height: 24 }, /* @__PURE__ */ React.createElement("rect", { width: 24, height: 24, fill: "#D9D9D9" })), /* @__PURE__ */ React.createElement("g", { mask: "url(#mask0_447_68)" }, /* @__PURE__ */ React.createElement("path", { d: "M6 17H18L14.25 12L11.25 16L9 13L6 17ZM3 21V3H21V21H3ZM5 19H19V5H5V19Z", fill: "currentColor" }), /* @__PURE__ */ React.createElement("path", { d: "M6 12V6H11V12H9.5V10.5H7.5V12H6ZM7.5 9H9.5V7.5H7.5V9Z", fill: "currentColor" }), /* @__PURE__ */ React.createElement("path", { d: "M12 6H18V7.5H12V6Z", fill: "currentColor" }), /* @__PURE__ */ React.createElement("path", { d: "M12 9H18V10.5H12V9Z", fill: "currentColor" })));
 const RichTextIcon = SvgRichText;
 export {
   RichTextIcon as default

package/dist/importMarkdownToLexical.d.ts

@@ -3,6 +3,7 @@ import * as Mdast from 'mdast';
 import { fromMarkdown } from 'mdast-util-from-markdown';
 import { ParseOptions } from 'micromark-util-types';
 import { IS_BOLD, IS_ITALIC, IS_UNDERLINE } from './FormatConstants';
+/** @internal */
 export type MdastExtensions = NonNullable<Parameters<typeof fromMarkdown>[1]>['mdastExtensions'];
 /**
  * A set of actions that can be used to modify the lexical tree while visiting the mdast tree.
@@ -61,12 +62,14 @@ export interface MdastImportVisitor<UN extends Mdast.Content> {
 }
 /**
  * The options of the tree import utility. Not meant to be used directly.
+ * @internal
  */
 export interface MdastTreeImportOptions {
     root: LexicalRootNode;
     visitors: MdastImportVisitor<Mdast.Content>[];
     mdastRoot: Mdast.Root;
 }
+/** @internal */
 export interface MarkdownParseOptions extends Omit<MdastTreeImportOptions, 'mdastRoot'> {
     markdown: string;
     syntaxExtensions: NonNullable<ParseOptions['extensions']>;
@@ -74,11 +77,15 @@ export interface MarkdownParseOptions extends Omit<MdastTreeImportOptions, 'mdas
 }
 /**
  * An extension for the `fromMarkdown` utility tree construction.
+ * @internal
  */
 export type MdastExtension = NonNullable<MdastExtensions>[number];
 /**
  * An extension for the `fromMarkdown` utility markdown parse.
+ * @internal
  */
 export type SyntaxExtension = MarkdownParseOptions['syntaxExtensions'][number];
+/** @internal */
 export declare function importMarkdownToLexical({ root, markdown, visitors, syntaxExtensions, mdastExtensions }: MarkdownParseOptions): void;
+/** @internal */
 export declare function importMdastTreeToLexical({ root, mdastRoot, visitors }: MdastTreeImportOptions): void;

package/dist/plugins/codeblock/index.d.ts

@@ -1,4 +1,4 @@
-import type { RefObject, ComponentType, ReactNode } from 'react';
+import type { RefObject, ReactNode, ComponentType } from 'react';
 import type { Options } from 'mdast-util-to-markdown';
 import type { Config } from 'mdast-util-from-markdown/lib';
 import type { Extension } from 'micromark-util-types';
@@ -94,6 +94,8 @@ export declare const codeBlockSystem: SystemSpec<[SystemSpec<[], (r: Realm) => {
     markdown: RealmNode<string>;
     editorRootElementRef: RealmNode<RefObject<HTMLDivElement> | null>;
     contentEditableClassName: RealmNode<string>;
+    placeholder: RealmNode<ReactNode>;
+    autoFocus: RealmNode<boolean>;
     composerChildren: RealmNode<ComponentType<{}>[]>;
     addComposerChild: RealmNode<ComponentType<{}>>;
     topAreaChildren: RealmNode<ComponentType<{}>[]>;
@@ -142,6 +144,8 @@ export declare const codeBlockSystem: SystemSpec<[SystemSpec<[], (r: Realm) => {
     markdown: RealmNode<string>;
     editorRootElementRef: RealmNode<RefObject<HTMLDivElement> | null>;
     contentEditableClassName: RealmNode<string>;
+    placeholder: RealmNode<ReactNode>;
+    autoFocus: RealmNode<boolean>;
     composerChildren: RealmNode<ComponentType<{}>[]>;
     addComposerChild: RealmNode<ComponentType<{}>>;
     topAreaChildren: RealmNode<ComponentType<{}>[]>;
@@ -213,6 +217,8 @@ codeBlockPlugin: PluginConstructor<SystemSpec<[SystemSpec<[], (r: Realm) => {
     markdown: RealmNode<string>;
     editorRootElementRef: RealmNode<RefObject<HTMLDivElement> | null>;
     contentEditableClassName: RealmNode<string>;
+    placeholder: RealmNode<ReactNode>;
+    autoFocus: RealmNode<boolean>;
     composerChildren: RealmNode<ComponentType<{}>[]>;
     addComposerChild: RealmNode<ComponentType<{}>>;
     topAreaChildren: RealmNode<ComponentType<{}>[]>;
@@ -261,6 +267,8 @@ codeBlockPlugin: PluginConstructor<SystemSpec<[SystemSpec<[], (r: Realm) => {
     markdown: RealmNode<string>;
     editorRootElementRef: RealmNode<RefObject<HTMLDivElement> | null>;
     contentEditableClassName: RealmNode<string>;
+    placeholder: RealmNode<ReactNode>;
+    autoFocus: RealmNode<boolean>;
     composerChildren: RealmNode<ComponentType<{}>[]>;
     addComposerChild: RealmNode<ComponentType<{}>>;
     topAreaChildren: RealmNode<ComponentType<{}>[]>;
@@ -324,6 +332,8 @@ codeBlockPluginHooks: {
         markdown: RealmNode<string>;
         editorRootElementRef: RealmNode<RefObject<HTMLDivElement> | null>;
         contentEditableClassName: RealmNode<string>;
+        placeholder: RealmNode<ReactNode>;
+        autoFocus: RealmNode<boolean>;
         composerChildren: RealmNode<ComponentType<{}>[]>;
         addComposerChild: RealmNode<ComponentType<{}>>;
         topAreaChildren: RealmNode<ComponentType<{}>[]>;
@@ -344,7 +354,7 @@ codeBlockPluginHooks: {
         convertSelectionToNode: RealmNode<() => ElementNode>;
         insertDecoratorNode: RealmNode<() => DecoratorNode<unknown>>;
     }>;
-    useEmitter: <K extends "jsxComponentDescriptors" | "jsxIsAvailable" | "toMarkdownOptions" | "toMarkdownExtensions" | "mdastExtensions" | "syntaxExtensions" | "markdown" | "activeEditor" | "inFocus" | "historyState" | "currentSelection" | "initialRootEditorState" | "rootEditor" | "createRootEditorSubscription" | "createActiveEditorSubscription" | "importVisitors" | "usedLexicalNodes" | "addImportVisitor" | "addLexicalNode" | "addSyntaxExtension" | "addMdastExtension" | "addToMarkdownExtension" | "addExportVisitor" | "exportVisitors" | "initialMarkdown" | "setMarkdown" | "editorRootElementRef" | "contentEditableClassName" | "composerChildren" | "addComposerChild" | "topAreaChildren" | "addTopAreaChild" | "nestedEditorChildren" | "addNestedEditorChild" | "editorWrappers" | "addEditorWrapper" | "currentFormat" | "editorInFocus" | "applyFormat" | "currentBlockType" | "applyBlockType" | "convertSelectionToNode" | "insertDecoratorNode" | "codeBlockEditorDescriptors" | "defaultCodeBlockLanguage" | "appendCodeBlockEditorDescriptor" | "insertCodeBlock">(key: K, callback: (value: ValueForKey<{
+    useEmitter: <K extends "jsxComponentDescriptors" | "jsxIsAvailable" | "toMarkdownOptions" | "toMarkdownExtensions" | "mdastExtensions" | "syntaxExtensions" | "markdown" | "activeEditor" | "inFocus" | "historyState" | "currentSelection" | "initialRootEditorState" | "rootEditor" | "createRootEditorSubscription" | "createActiveEditorSubscription" | "importVisitors" | "usedLexicalNodes" | "addImportVisitor" | "addLexicalNode" | "addSyntaxExtension" | "addMdastExtension" | "addToMarkdownExtension" | "addExportVisitor" | "exportVisitors" | "initialMarkdown" | "setMarkdown" | "editorRootElementRef" | "contentEditableClassName" | "placeholder" | "autoFocus" | "composerChildren" | "addComposerChild" | "topAreaChildren" | "addTopAreaChild" | "nestedEditorChildren" | "addNestedEditorChild" | "editorWrappers" | "addEditorWrapper" | "currentFormat" | "editorInFocus" | "applyFormat" | "currentBlockType" | "applyBlockType" | "convertSelectionToNode" | "insertDecoratorNode" | "codeBlockEditorDescriptors" | "defaultCodeBlockLanguage" | "appendCodeBlockEditorDescriptor" | "insertCodeBlock">(key: K, callback: (value: ValueForKey<{
         codeBlockEditorDescriptors: RealmNode<CodeBlockEditorDescriptor[]>;
         defaultCodeBlockLanguage: RealmNode<string>;
         appendCodeBlockEditorDescriptor: RealmNode<CodeBlockEditorDescriptor>;
@@ -378,6 +388,8 @@ codeBlockPluginHooks: {
         markdown: RealmNode<string>;
         editorRootElementRef: RealmNode<RefObject<HTMLDivElement> | null>;
         contentEditableClassName: RealmNode<string>;
+        placeholder: RealmNode<ReactNode>;
+        autoFocus: RealmNode<boolean>;
         composerChildren: RealmNode<ComponentType<{}>[]>;
         addComposerChild: RealmNode<ComponentType<{}>>;
         topAreaChildren: RealmNode<ComponentType<{}>[]>;
@@ -432,6 +444,8 @@ codeBlockPluginHooks: {
         markdown: RealmNode<string>;
         editorRootElementRef: RealmNode<RefObject<HTMLDivElement> | null>;
         contentEditableClassName: RealmNode<string>;
+        placeholder: RealmNode<ReactNode>;
+        autoFocus: RealmNode<boolean>;
         composerChildren: RealmNode<ComponentType<{}>[]>;
         addComposerChild: RealmNode<ComponentType<{}>>;
         topAreaChildren: RealmNode<ComponentType<{}>[]>;
@@ -485,6 +499,8 @@ codeBlockPluginHooks: {
         markdown: RealmNode<string>;
         editorRootElementRef: RealmNode<RefObject<HTMLDivElement> | null>;
         contentEditableClassName: RealmNode<string>;
+        placeholder: RealmNode<ReactNode>;
+        autoFocus: RealmNode<boolean>;
         composerChildren: RealmNode<ComponentType<{}>[]>;
         addComposerChild: RealmNode<ComponentType<{}>>;
         topAreaChildren: RealmNode<ComponentType<{}>[]>;
@@ -539,6 +555,8 @@ codeBlockPluginHooks: {
         markdown: RealmNode<string>;
         editorRootElementRef: RealmNode<RefObject<HTMLDivElement> | null>;
         contentEditableClassName: RealmNode<string>;
+        placeholder: RealmNode<ReactNode>;
+        autoFocus: RealmNode<boolean>;
         composerChildren: RealmNode<ComponentType<{}>[]>;
         addComposerChild: RealmNode<ComponentType<{}>>;
         topAreaChildren: RealmNode<ComponentType<{}>[]>;
@@ -559,7 +577,7 @@ codeBlockPluginHooks: {
         convertSelectionToNode: RealmNode<() => ElementNode>;
         insertDecoratorNode: RealmNode<() => DecoratorNode<unknown>>;
     }>) => void;
-    usePublisher: <K_2 extends "jsxComponentDescriptors" | "jsxIsAvailable" | "toMarkdownOptions" | "toMarkdownExtensions" | "mdastExtensions" | "syntaxExtensions" | "markdown" | "activeEditor" | "inFocus" | "historyState" | "currentSelection" | "initialRootEditorState" | "rootEditor" | "createRootEditorSubscription" | "createActiveEditorSubscription" | "importVisitors" | "usedLexicalNodes" | "addImportVisitor" | "addLexicalNode" | "addSyntaxExtension" | "addMdastExtension" | "addToMarkdownExtension" | "addExportVisitor" | "exportVisitors" | "initialMarkdown" | "setMarkdown" | "editorRootElementRef" | "contentEditableClassName" | "composerChildren" | "addComposerChild" | "topAreaChildren" | "addTopAreaChild" | "nestedEditorChildren" | "addNestedEditorChild" | "editorWrappers" | "addEditorWrapper" | "currentFormat" | "editorInFocus" | "applyFormat" | "currentBlockType" | "applyBlockType" | "convertSelectionToNode" | "insertDecoratorNode" | "codeBlockEditorDescriptors" | "defaultCodeBlockLanguage" | "appendCodeBlockEditorDescriptor" | "insertCodeBlock">(key: K_2) => (value: ValueForKey<{
+    usePublisher: <K_2 extends "jsxComponentDescriptors" | "jsxIsAvailable" | "toMarkdownOptions" | "toMarkdownExtensions" | "mdastExtensions" | "syntaxExtensions" | "markdown" | "activeEditor" | "inFocus" | "historyState" | "currentSelection" | "initialRootEditorState" | "rootEditor" | "createRootEditorSubscription" | "createActiveEditorSubscription" | "importVisitors" | "usedLexicalNodes" | "addImportVisitor" | "addLexicalNode" | "addSyntaxExtension" | "addMdastExtension" | "addToMarkdownExtension" | "addExportVisitor" | "exportVisitors" | "initialMarkdown" | "setMarkdown" | "editorRootElementRef" | "contentEditableClassName" | "placeholder" | "autoFocus" | "composerChildren" | "addComposerChild" | "topAreaChildren" | "addTopAreaChild" | "nestedEditorChildren" | "addNestedEditorChild" | "editorWrappers" | "addEditorWrapper" | "currentFormat" | "editorInFocus" | "applyFormat" | "currentBlockType" | "applyBlockType" | "convertSelectionToNode" | "insertDecoratorNode" | "codeBlockEditorDescriptors" | "defaultCodeBlockLanguage" | "appendCodeBlockEditorDescriptor" | "insertCodeBlock">(key: K_2) => (value: ValueForKey<{
         codeBlockEditorDescriptors: RealmNode<CodeBlockEditorDescriptor[]>;
         defaultCodeBlockLanguage: RealmNode<string>;
         appendCodeBlockEditorDescriptor: RealmNode<CodeBlockEditorDescriptor>;
@@ -593,6 +611,8 @@ codeBlockPluginHooks: {
         markdown: RealmNode<string>;
         editorRootElementRef: RealmNode<RefObject<HTMLDivElement> | null>;
         contentEditableClassName: RealmNode<string>;
+        placeholder: RealmNode<ReactNode>;
+        autoFocus: RealmNode<boolean>;
         composerChildren: RealmNode<ComponentType<{}>[]>;
         addComposerChild: RealmNode<ComponentType<{}>>;
         topAreaChildren: RealmNode<ComponentType<{}>[]>;