@dxos/react-ui-editor 0.8.4-main.5ad4a44 → 0.8.4-main.66e292d

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dxos/react-ui-editor",
-  "version": "0.8.4-main.5ad4a44",
-  "description": "Document editing experience within a DXOS shell.",
+  "version": "0.8.4-main.66e292d",
+  "description": "Text editor components.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
   "license": "MIT",
@@ -20,12 +20,6 @@
       "types": "./dist/types/src/types/index.d.ts",
       "browser": "./dist/lib/browser/types/index.mjs",
       "node": "./dist/lib/node-esm/types/index.mjs"
-    },
-    "./testing": {
-      "source": "./src/testing/index.ts",
-      "types": "./dist/types/src/testing/index.d.ts",
-      "browser": "./dist/lib/browser/testing/index.mjs",
-      "node": "./dist/lib/node-esm/testing/index.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
@@ -40,10 +34,12 @@
     "@automerge/automerge": "3.1.2",
     "@codemirror/autocomplete": "^6.19.0",
     "@codemirror/commands": "^6.8.1",
+    "@codemirror/lang-html": "^6.4.11",
     "@codemirror/lang-javascript": "^6.2.4",
     "@codemirror/lang-json": "^6.0.2",
     "@codemirror/lang-markdown": "^6.3.4",
     "@codemirror/lang-xml": "^6.1.0",
+    "@codemirror/lang-yaml": "^6.1.2",
     "@codemirror/language": "^6.11.3",
     "@codemirror/language-data": "^6.5.1",
     "@codemirror/lint": "^6.8.5",
@@ -70,28 +66,30 @@
     "lodash.merge": "^4.6.2",
     "lodash.sortby": "^4.7.0",
     "style-mod": "^4.1.0",
-    "@dxos/app-graph": "0.8.4-main.5ad4a44",
-    "@dxos/async": "0.8.4-main.5ad4a44",
-    "@dxos/context": "0.8.4-main.5ad4a44",
-    "@dxos/debug": "0.8.4-main.5ad4a44",
-    "@dxos/display-name": "0.8.4-main.5ad4a44",
-    "@dxos/invariant": "0.8.4-main.5ad4a44",
-    "@dxos/log": "0.8.4-main.5ad4a44",
-    "@dxos/lit-ui": "0.8.4-main.5ad4a44",
-    "@dxos/echo": "0.8.4-main.5ad4a44",
-    "@dxos/live-object": "0.8.4-main.5ad4a44",
-    "@dxos/protocols": "0.8.4-main.5ad4a44",
-    "@dxos/react-ui-menu": "0.8.4-main.5ad4a44",
-    "@dxos/react-hooks": "0.8.4-main.5ad4a44",
-    "@dxos/react-ui-stack": "0.8.4-main.5ad4a44",
-    "@dxos/util": "0.8.4-main.5ad4a44",
-    "@dxos/react-ui-types": "0.8.4-main.5ad4a44"
+    "@dxos/app-graph": "0.8.4-main.66e292d",
+    "@dxos/async": "0.8.4-main.66e292d",
+    "@dxos/client": "0.8.4-main.66e292d",
+    "@dxos/debug": "0.8.4-main.66e292d",
+    "@dxos/context": "0.8.4-main.66e292d",
+    "@dxos/display-name": "0.8.4-main.66e292d",
+    "@dxos/echo": "0.8.4-main.66e292d",
+    "@dxos/echo-db": "0.8.4-main.66e292d",
+    "@dxos/invariant": "0.8.4-main.66e292d",
+    "@dxos/lit-ui": "0.8.4-main.66e292d",
+    "@dxos/live-object": "0.8.4-main.66e292d",
+    "@dxos/log": "0.8.4-main.66e292d",
+    "@dxos/protocols": "0.8.4-main.66e292d",
+    "@dxos/react-hooks": "0.8.4-main.66e292d",
+    "@dxos/react-ui-menu": "0.8.4-main.66e292d",
+    "@dxos/react-ui-stack": "0.8.4-main.66e292d",
+    "@dxos/react-ui-types": "0.8.4-main.66e292d",
+    "@dxos/util": "0.8.4-main.66e292d"
   },
   "devDependencies": {
     "@automerge/automerge": "3.1.2",
-    "@automerge/automerge-repo": "2.3.1",
-    "@automerge/automerge-repo-network-broadcastchannel": "2.3.1",
-    "@effect-rx/rx-react": "0.42.4",
+    "@automerge/automerge-repo": "2.4.0",
+    "@automerge/automerge-repo-network-broadcastchannel": "2.4.0",
+    "@effect-atom/atom-react": "^0.3.4",
     "@effect/platform": "0.92.1",
     "@types/chai": "^4.2.15",
     "@types/chai-dom": "^1.11.0",
@@ -99,13 +97,13 @@
     "@types/lodash.merge": "^4.6.6",
     "@types/lodash.sortby": "^4.7.7",
     "@types/react": "~19.2.2",
-    "@types/react-dom": "~19.2.1",
+    "@types/react-dom": "~19.2.2",
     "@types/react-test-renderer": "^17.0.2",
     "chai": "^4.4.1",
     "chai-dom": "^1.11.0",
     "effect": "3.18.3",
     "happy-dom": "^13.3.1",
-    "jsdom": "^24.0.0",
+    "jsdom": "^27.0.0",
     "mocha": "^10.6.0",
     "react": "~19.2.0",
     "react-dom": "~19.2.0",
@@ -113,29 +111,29 @@
     "vite": "7.1.9",
     "vite-plugin-top-level-await": "^1.6.0",
     "vite-plugin-wasm": "^3.5.0",
-    "@dxos/config": "0.8.4-main.5ad4a44",
-    "@dxos/echo": "0.8.4-main.5ad4a44",
-    "@dxos/echo-signals": "0.8.4-main.5ad4a44",
-    "@dxos/keyboard": "0.8.4-main.5ad4a44",
-    "@dxos/random": "0.8.4-main.5ad4a44",
-    "@dxos/react-ui": "0.8.4-main.5ad4a44",
-    "@dxos/react-client": "0.8.4-main.5ad4a44",
-    "@dxos/react-ui-attention": "0.8.4-main.5ad4a44",
-    "@dxos/react-ui-stack": "0.8.4-main.5ad4a44",
-    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.5ad4a44",
-    "@dxos/react-ui-theme": "0.8.4-main.5ad4a44",
-    "@dxos/schema": "0.8.4-main.5ad4a44",
-    "@dxos/storybook-utils": "0.8.4-main.5ad4a44"
+    "@dxos/config": "0.8.4-main.66e292d",
+    "@dxos/echo": "0.8.4-main.66e292d",
+    "@dxos/echo-signals": "0.8.4-main.66e292d",
+    "@dxos/keyboard": "0.8.4-main.66e292d",
+    "@dxos/react-client": "0.8.4-main.66e292d",
+    "@dxos/react-ui": "0.8.4-main.66e292d",
+    "@dxos/random": "0.8.4-main.66e292d",
+    "@dxos/react-ui-attention": "0.8.4-main.66e292d",
+    "@dxos/react-ui-stack": "0.8.4-main.66e292d",
+    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.66e292d",
+    "@dxos/react-ui-theme": "0.8.4-main.66e292d",
+    "@dxos/schema": "0.8.4-main.66e292d",
+    "@dxos/storybook-utils": "0.8.4-main.66e292d"
   },
   "peerDependencies": {
-    "@effect-rx/rx-react": "^0.34.1",
+    "@effect-atom/atom-react": "^0.3.4",
     "@effect/platform": "^0.80.12",
     "effect": "^3.13.3",
     "react": "^19.0.0",
     "react-dom": "^19.0.0",
-    "@dxos/react-client": "0.8.4-main.5ad4a44",
-    "@dxos/react-ui-theme": "0.8.4-main.5ad4a44",
-    "@dxos/react-ui": "0.8.4-main.5ad4a44"
+    "@dxos/react-client": "0.8.4-main.66e292d",
+    "@dxos/react-ui-theme": "0.8.4-main.66e292d",
+    "@dxos/react-ui": "0.8.4-main.66e292d"
   },
   "publishConfig": {
     "access": "public"

package/src/components/Editor/Editor.stories.tsx

@@ -0,0 +1,89 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Decorator, type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useMemo } from 'react';
+
+import { faker } from '@dxos/random';
+import { useThemeContext } from '@dxos/react-ui';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { withAttention } from '@dxos/react-ui-attention/testing';
+
+import {
+  createBasicExtensions,
+  createMarkdownExtensions,
+  createThemeExtensions,
+  decorateMarkdown,
+} from '../../extensions';
+import { createMenuGroup } from '../EditorMenuProvider';
+
+import { Editor, type EditorContentProps } from './Editor';
+
+// TODO(burdon): PreviewPopoverProvider (MarkdownStream, Preview story).
+// TODO(burdon): Adapt Markdown plugin to use new Editor (plan first to check fit).
+// TODO(burdon): Remove redundant hooks and simplify props.
+
+faker.seed(1234);
+
+const initialValue = ['# Blue Monday', '', 'How does it **feel**?', ''].join('\n');
+
+// TODO(burdon): Adapter other tests in react-ui-editor/stories to use this pattern.
+const withExtensions: Decorator = (Story, { args }) => {
+  const { themeMode } = useThemeContext();
+  const extensions = useMemo(
+    () => [
+      // Basic extensions.
+      createBasicExtensions(),
+      createThemeExtensions({ themeMode }),
+      createMarkdownExtensions(),
+      decorateMarkdown(),
+    ],
+    [themeMode],
+  );
+
+  return <Story args={{ ...args, extensions, initialValue }} />;
+};
+
+const meta = {
+  title: 'ui/react-ui-editor/Editor',
+  component: Editor.Content,
+  decorators: [withExtensions, withTheme, withLayout({ container: 'column' }), withAttention],
+  parameters: {
+    layout: 'fullscreen',
+  },
+} satisfies Meta<typeof Editor.Content>;
+
+export default meta;
+
+type Story = StoryObj<EditorContentProps>;
+
+export const Default: Story = {
+  render: (args) => (
+    <Editor.Root>
+      <Editor.Content {...args} />
+    </Editor.Root>
+  ),
+};
+
+export const WithToolbar: Story = {
+  render: (args) => (
+    <Editor.Root>
+      <Editor.Toolbar />
+      <Editor.Content {...args} />
+    </Editor.Root>
+  ),
+};
+
+const items = faker.helpers.multiple(faker.commerce.productName, { count: 10 }).sort();
+
+export const WithPopover: Story = {
+  render: (args) => (
+    <Editor.Root trigger={['@']} getMenu={({ text }) => [createMenuGroup({ items, filter: text })]}>
+      <Editor.Viewport>
+        <Editor.Toolbar />
+        <Editor.Content {...args} />
+      </Editor.Viewport>
+    </Editor.Root>
+  ),
+};

package/src/components/Editor/Editor.tsx

@@ -2,73 +2,173 @@
 // Copyright 2025 DXOS.org
 //
 
-import { EditorView } from '@codemirror/view';
-import React, { forwardRef, useEffect, useImperativeHandle } from 'react';
+import { type Extension } from '@codemirror/state';
+import { createContext } from '@radix-ui/react-context';
+import React, { type PropsWithChildren, forwardRef, useCallback, useImperativeHandle, useMemo, useState } from 'react';
 
+import { invariant } from '@dxos/invariant';
 import { type ThemedClassName } from '@dxos/react-ui';
 import { mx } from '@dxos/react-ui-theme';
+import { isNonNullable } from '@dxos/util';
 
-import { type UseTextEditorProps, useTextEditor } from '../../hooks';
+import {
+  type EditorController,
+  EditorContent as NaturalEditorContent,
+  type EditorContentProps as NaturalEditorContentProps,
+  noopController,
+} from '../EditorContent';
+import { EditorMenuProvider, type UseEditorMenuProps, useEditorMenu } from '../EditorMenuProvider';
+import {
+  type EditorToolbarState,
+  EditorToolbar as NaturalEditorToolbar,
+  type EditorToolbarProps as NaturalEditorToolbarProps,
+  useEditorToolbar,
+} from '../EditorToolbar';
 
-export type EditorController = {
-  view: EditorView | null;
-  focus: () => void;
-};
+//
+// Context
+//
+
+type EditorContextValue = {
+  controller?: EditorController;
+  setController: (controller: EditorController) => void;
+  extensions?: Extension[];
+} & Pick<NaturalEditorToolbarProps, 'state'>;
+
+const [EditorContextProvider, useEditorContext] = createContext<EditorContextValue>('Editor');
+
+//
+// Root
+//
 
-export type EditorProps = ThemedClassName<
-  {
-    value?: string;
-    moveToEnd?: boolean;
-    onChange?: (value: string) => void;
-  } & Omit<UseTextEditorProps, 'initialValue'>
->;
+type EditorRootProps = PropsWithChildren<Omit<UseEditorMenuProps, 'viewRef'> & Pick<EditorToolbarState, 'viewMode'>>;
 
 /**
- * Minimal text editor.
- * NOTE: This shouold not be used with the automerge extension.
+ * Root component for the Editor compound component.
+ * Provides context for all child components and manages the editor controller state.
  */
-export const Editor = forwardRef<EditorController, EditorProps>(
-  ({ classNames, id, extensions = [], value, moveToEnd, onChange, ...props }, forwardedRef) => {
-    const { parentRef, focusAttributes, view } = useTextEditor(
-      () => ({
-        id,
-        extensions: [
-          extensions,
-          EditorView.updateListener.of((update) => {
-            const startValue = update.startState.doc.toString();
-            const value = update.state.doc.toString();
-            if (startValue !== value) {
-              onChange?.(value);
-            }
-          }),
-        ],
-        ...props,
-      }),
-      [id, extensions, onChange],
-    );
+const EditorRoot = forwardRef<EditorController | null, EditorRootProps>(
+  ({ children, viewMode, ...props }, forwardedRef) => {
+    const state = useEditorToolbar({ viewMode });
 
-    // External controller.
-    useImperativeHandle(
-      forwardedRef,
-      () => ({
-        view,
-        focus: () => view?.focus(),
-      }),
-      [view],
-    );
+    const [controller, setController] = useState<EditorController>();
+    useImperativeHandle(forwardedRef, () => controller ?? noopController, [controller]);
+
+    // TODO(burdon): Consider lighter-weight approach if EditorMenuProvider is not needed.
+    const { groupsRef, extension, ...menuProps } = useEditorMenu(props);
+    const extensions = useMemo(() => [extension], [extension]);
 
-    // Update content.
-    useEffect(() => {
-      if (value !== view?.state.doc.toString()) {
-        requestAnimationFrame(() => {
-          view?.dispatch({
-            changes: { from: 0, to: view.state.doc.length, insert: value },
-            selection: moveToEnd ? { anchor: value?.length ?? 0 } : undefined,
-          });
-        });
-      }
-    }, [view, value, moveToEnd]);
-
-    return <div role='none' className={mx('is-full', classNames)} {...focusAttributes} ref={parentRef} />;
+    return (
+      <EditorContextProvider
+        controller={controller}
+        setController={setController}
+        extensions={extensions}
+        state={state}
+      >
+        <EditorMenuProvider view={controller?.view} groups={groupsRef.current} {...menuProps}>
+          {children}
+        </EditorMenuProvider>
+      </EditorContextProvider>
+    );
   },
 );
+
+EditorRoot.displayName = 'Editor.Root';
+
+//
+// Viewport
+//
+
+type EditorViewportProps = ThemedClassName<PropsWithChildren<{}>>;
+
+/**
+ * Viewport component that wraps the toolbar and editor content area.
+ */
+const EditorViewport = ({ classNames, children }: EditorViewportProps) => {
+  return (
+    <div role='none' className={mx('grid grid-rows-[min-content_1fr] bs-full overflow-hidden', classNames)}>
+      {children}
+    </div>
+  );
+};
+
+EditorViewport.displayName = 'Editor.Viewport';
+
+//
+// Content
+//
+
+type EditorContentProps = Omit<NaturalEditorContentProps, 'ref'>;
+
+/**
+ * Content component that renders the actual CodeMirror editor.
+ * Automatically registers the editor controller with the context.
+ */
+const EditorContent = ({ extensions: providedExtensions, ...props }: EditorContentProps) => {
+  const { extensions: additionalExtensions = [], setController } = useEditorContext(EditorContent.displayName);
+
+  const extensions = useMemo(
+    () => [additionalExtensions, providedExtensions].filter(isNonNullable).flat(),
+    [providedExtensions, additionalExtensions],
+  );
+
+  return <NaturalEditorContent {...props} extensions={extensions} ref={setController} />;
+};
+
+EditorContent.displayName = 'Editor.Content';
+
+//
+// Toolbar
+//
+
+type EditorToolbarProps = Omit<NaturalEditorToolbarProps, 'getView' | 'state'>;
+
+/**
+ * Toolbar component that provides editor formatting and control actions.
+ * Automatically connects to the editor view through context.
+ */
+const EditorToolbar = (props: EditorToolbarProps) => {
+  const { controller, state } = useEditorContext(EditorToolbar.displayName);
+
+  // TODO(burdon): Fix invariant.
+  const getView = useCallback(() => {
+    invariant(controller?.view);
+    return controller?.view;
+  }, [controller]);
+
+  return <NaturalEditorToolbar {...props} getView={getView} state={state} />;
+};
+
+EditorToolbar.displayName = 'Editor.Toolbar';
+
+//
+// Editor
+//
+
+/**
+ * Compound editor component following the Radix UI pattern.
+ *
+ * @example
+ * ```tsx
+ * EditorMenuGroup.Root>
+ *   EditorMenuGroup.Toolbar />
+ *   EditorMenuGroup.Viewport>
+ *     EditorMenuGroup.Content extensions={[...]} />
+ *   </Editor.Viewport>
+ * </Editor.Root>
+ * ```
+ */
+export const Editor = {
+  Root: EditorRoot,
+  Viewport: EditorViewport,
+  Content: EditorContent,
+  Toolbar: EditorToolbar,
+};
+
+export type {
+  EditorController,
+  EditorRootProps,
+  EditorViewportProps,
+  EditorContentProps,
+  // EditorToolbarProps, // TODO(burdon): Restore once removed deprecated props.
+};

package/src/components/EditorContent/EditorContent.stories.tsx

@@ -0,0 +1,70 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React from 'react';
+import { useMemo } from 'react';
+
+import { createDocAccessor, createObject } from '@dxos/echo-db';
+import { useThemeContext } from '@dxos/react-ui';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { Text } from '@dxos/schema';
+
+import { automerge, createBasicExtensions, createThemeExtensions } from '../../extensions';
+
+import { EditorContent } from './EditorContent';
+
+const meta = {
+  title: 'ui/react-ui-editor/EditorComponent',
+  component: EditorContent,
+  decorators: [withTheme, withLayout({ container: 'column' })],
+} satisfies Meta<typeof EditorContent>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  render: (args) => {
+    const { themeMode } = useThemeContext();
+    const extensions = useMemo(
+      () => [
+        // Basic extensions.
+        createBasicExtensions(),
+        createThemeExtensions({ themeMode }),
+      ],
+      [],
+    );
+
+    return <EditorContent classNames='p-2' {...args} extensions={extensions} />;
+  },
+  args: {
+    selectionEnd: true,
+    value: 'Hello world!',
+    onChange: (value) => console.log(value),
+  },
+};
+
+export const Automerge: Story = {
+  render: ({ value, ...props }) => {
+    const { themeMode } = useThemeContext();
+    const extensions = useMemo(
+      () => [
+        // Basic extensions.
+        createBasicExtensions(),
+        createThemeExtensions({ themeMode }),
+        automerge(createDocAccessor(createObject(Text.make(value)), ['content'])),
+      ],
+      [],
+    );
+
+    // TODO(burdon): Remove the need for initialValue.
+    return <EditorContent classNames='p-2' {...props} initialValue={value} extensions={extensions} />;
+  },
+  args: {
+    selectionEnd: true,
+    value: 'Hello world!',
+    onChange: (value) => console.log(value),
+  },
+};

package/src/components/EditorContent/EditorContent.tsx

@@ -0,0 +1,70 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Transaction } from '@codemirror/state';
+import { EditorView } from '@codemirror/view';
+import React, { forwardRef, useEffect, useImperativeHandle } from 'react';
+
+import { type ThemedClassName } from '@dxos/react-ui';
+import { mx } from '@dxos/react-ui-theme';
+
+import { initialSync } from '../../extensions';
+import { type UseTextEditorProps, useTextEditor } from '../../hooks';
+
+import { type EditorController, createEditorController } from './controller';
+
+export type EditorContentProps = ThemedClassName<
+  {
+    value?: string;
+    onChange?: (value: string) => void;
+  } & UseTextEditorProps
+>;
+
+/**
+ * Minimal text editor.
+ * NOTE: This shouold not be used with the automerge extension.
+ * @deprecated Use Editor.Content
+ */
+export const EditorContent = forwardRef<EditorController, EditorContentProps>(
+  ({ classNames, id, extensions, selectionEnd, value, onChange, ...props }, forwardedRef) => {
+    const { parentRef, focusAttributes, view } = useTextEditor(
+      () => ({
+        id,
+        initialValue: value,
+        selectionEnd,
+        extensions: [
+          extensions ?? [],
+          EditorView.updateListener.of(({ view, docChanged, transactions }) => {
+            const isInitialSync = transactions.some((tr) => tr.annotation(Transaction.userEvent) === initialSync.value);
+            if (!isInitialSync && docChanged) {
+              onChange?.(view.state.doc.toString());
+            }
+          }),
+        ],
+        ...props,
+      }),
+      [id, extensions, onChange, selectionEnd],
+    );
+
+    // External controller.
+    useImperativeHandle(forwardedRef, () => {
+      return createEditorController(view);
+    }, [id, view]);
+
+    // Set initial value and cursor position.
+    useEffect(() => {
+      requestAnimationFrame(() => {
+        view?.dispatch({
+          annotations: initialSync,
+          changes: value ? [{ from: 0, to: view?.state.doc.length ?? 0, insert: value ?? '' }] : [],
+          selection: selectionEnd ? { anchor: view?.state.doc.length ?? 0 } : undefined,
+        });
+
+        view?.focus();
+      });
+    }, [view, value, selectionEnd]);
+
+    return <div role='none' className={mx('is-full', classNames)} {...focusAttributes} ref={parentRef} />;
+  },
+);

package/src/components/EditorContent/controller.ts

@@ -0,0 +1,50 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type EditorView } from '@codemirror/view';
+
+export interface EditorController {
+  get view(): EditorView | null;
+  getText: () => string;
+  setText: (text: string, focus?: boolean) => void;
+  focus: () => void;
+}
+
+export const noopController: EditorController = {
+  get view() {
+    return null;
+  },
+  getText: () => '',
+  setText: () => {},
+  focus: () => {},
+};
+
+export const createEditorController = (view: EditorView | null): EditorController => {
+  return {
+    get view() {
+      return view;
+    },
+    getText: () => {
+      return view?.state.doc.toString() ?? '';
+    },
+    setText: (text: string, focus?: boolean) => {
+      view?.dispatch({
+        changes: {
+          from: 0,
+          to: view?.state.doc.length ?? 0,
+          insert: text,
+        },
+        selection: {
+          anchor: text.length,
+          head: text.length,
+        },
+      });
+
+      if (focus) {
+        view?.focus();
+      }
+    },
+    focus: () => view?.focus(),
+  };
+};

package/src/components/EditorContent/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './controller';
+export * from './EditorContent';