@dxos/react-ui-editor 0.8.4-main.406dc2a → 0.8.4-main.422d1c7879

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@dxos/react-ui-editor",
-  "version": "0.8.4-main.406dc2a",
-  "description": "Document editing experience within a DXOS shell.",
+  "version": "0.8.4-main.422d1c7879",
+  "description": "Text editor components.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
-  "sideEffects": true,
+  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
@@ -14,128 +18,120 @@
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
-    },
-    "./types": {
-      "source": "./src/types/index.ts",
-      "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",
-  "typesVersions": {
-    "*": {}
-  },
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
-    "@automerge/automerge": "3.1.2",
+    "@automerge/automerge": "3.2.3",
     "@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-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",
+    "@codemirror/lint": "6.8.5",
     "@codemirror/search": "^6.5.11",
     "@codemirror/state": "^6.5.2",
     "@codemirror/theme-one-dark": "^6.1.3",
     "@codemirror/view": "^6.38.4",
-    "@fluentui/react-tabster": "^9.24.2",
+    "@fluentui/react-tabster": "9.26.11",
     "@lezer/common": "^1.2.2",
     "@lezer/generator": "^1.7.1",
     "@lezer/highlight": "^1.2.1",
     "@lezer/markdown": "^1.3.1",
-    "@preact-signals/safe-react": "^0.9.0",
-    "@preact/signals-react": "^3.3.0",
     "@radix-ui/react-context": "1.1.1",
     "@radix-ui/react-use-controllable-state": "1.1.0",
     "@replit/codemirror-vim": "^6.2.1",
     "@replit/codemirror-vscode-keymap": "^6.0.2",
     "@uiw/codemirror-theme-vscode": "^4.25.2",
-    "ajv": "^8.17.1",
+    "ajv": "^8.18.0",
+    "bind-event-listener": "^3.0.0",
     "codemirror": "^6.0.1",
     "lib0": "^0.2.65",
     "lodash.defaultsdeep": "^4.6.1",
     "lodash.merge": "^4.6.2",
     "lodash.sortby": "^4.7.0",
     "style-mod": "^4.1.0",
-    "@dxos/app-graph": "0.8.4-main.406dc2a",
-    "@dxos/async": "0.8.4-main.406dc2a",
-    "@dxos/debug": "0.8.4-main.406dc2a",
-    "@dxos/context": "0.8.4-main.406dc2a",
-    "@dxos/display-name": "0.8.4-main.406dc2a",
-    "@dxos/echo": "0.8.4-main.406dc2a",
-    "@dxos/invariant": "0.8.4-main.406dc2a",
-    "@dxos/lit-ui": "0.8.4-main.406dc2a",
-    "@dxos/log": "0.8.4-main.406dc2a",
-    "@dxos/protocols": "0.8.4-main.406dc2a",
-    "@dxos/live-object": "0.8.4-main.406dc2a",
-    "@dxos/react-hooks": "0.8.4-main.406dc2a",
-    "@dxos/react-ui-menu": "0.8.4-main.406dc2a",
-    "@dxos/react-ui-stack": "0.8.4-main.406dc2a",
-    "@dxos/react-ui-types": "0.8.4-main.406dc2a",
-    "@dxos/util": "0.8.4-main.406dc2a"
+    "@dxos/async": "0.8.4-main.422d1c7879",
+    "@dxos/app-graph": "0.8.4-main.422d1c7879",
+    "@dxos/debug": "0.8.4-main.422d1c7879",
+    "@dxos/client": "0.8.4-main.422d1c7879",
+    "@dxos/display-name": "0.8.4-main.422d1c7879",
+    "@dxos/echo": "0.8.4-main.422d1c7879",
+    "@dxos/context": "0.8.4-main.422d1c7879",
+    "@dxos/effect": "0.8.4-main.422d1c7879",
+    "@dxos/invariant": "0.8.4-main.422d1c7879",
+    "@dxos/echo-db": "0.8.4-main.422d1c7879",
+    "@dxos/lit-ui": "0.8.4-main.422d1c7879",
+    "@dxos/log": "0.8.4-main.422d1c7879",
+    "@dxos/protocols": "0.8.4-main.422d1c7879",
+    "@dxos/react-ui-menu": "0.8.4-main.422d1c7879",
+    "@dxos/react-hooks": "0.8.4-main.422d1c7879",
+    "@dxos/react-ui-mosaic": "0.8.4-main.422d1c7879",
+    "@dxos/ui-editor": "0.8.4-main.422d1c7879",
+    "@dxos/ui-theme": "0.8.4-main.422d1c7879",
+    "@dxos/util": "0.8.4-main.422d1c7879",
+    "@dxos/ui": "0.8.4-main.422d1c7879"
   },
   "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",
-    "@effect/platform": "0.92.1",
+    "@automerge/automerge": "3.2.3",
+    "@automerge/automerge-repo": "2.5.1",
+    "@automerge/automerge-repo-network-broadcastchannel": "2.5.1",
+    "@effect-atom/atom-react": "^0.5.0",
+    "@effect/ai": "0.33.2",
+    "@effect/platform": "0.94.4",
     "@types/chai": "^4.2.15",
     "@types/chai-dom": "^1.11.0",
     "@types/lodash.defaultsdeep": "^4.6.6",
     "@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": "~19.2.7",
+    "@types/react-dom": "~19.2.3",
     "@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",
+    "effect": "3.20.0",
+    "happy-dom": "^20.0.0",
     "jsdom": "^27.0.0",
     "mocha": "^10.6.0",
-    "react": "~19.2.0",
-    "react-dom": "~19.2.0",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
     "react-test-renderer": "~19.2.0",
-    "vite": "7.1.9",
+    "vite": "^7.1.11",
     "vite-plugin-top-level-await": "^1.6.0",
     "vite-plugin-wasm": "^3.5.0",
-    "@dxos/echo": "0.8.4-main.406dc2a",
-    "@dxos/config": "0.8.4-main.406dc2a",
-    "@dxos/echo-signals": "0.8.4-main.406dc2a",
-    "@dxos/keyboard": "0.8.4-main.406dc2a",
-    "@dxos/random": "0.8.4-main.406dc2a",
-    "@dxos/react-client": "0.8.4-main.406dc2a",
-    "@dxos/react-ui": "0.8.4-main.406dc2a",
-    "@dxos/react-ui-attention": "0.8.4-main.406dc2a",
-    "@dxos/react-ui-stack": "0.8.4-main.406dc2a",
-    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.406dc2a",
-    "@dxos/react-ui-theme": "0.8.4-main.406dc2a",
-    "@dxos/schema": "0.8.4-main.406dc2a",
-    "@dxos/storybook-utils": "0.8.4-main.406dc2a"
+    "@dxos/config": "0.8.4-main.422d1c7879",
+    "@dxos/ai": "0.8.4-main.422d1c7879",
+    "@dxos/echo-atom": "0.8.4-main.422d1c7879",
+    "@dxos/echo": "0.8.4-main.422d1c7879",
+    "@dxos/random": "0.8.4-main.422d1c7879",
+    "@dxos/keyboard": "0.8.4-main.422d1c7879",
+    "@dxos/react-client": "0.8.4-main.422d1c7879",
+    "@dxos/react-ui-attention": "0.8.4-main.422d1c7879",
+    "@dxos/schema": "0.8.4-main.422d1c7879",
+    "@dxos/react-ui": "0.8.4-main.422d1c7879",
+    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.422d1c7879",
+    "@dxos/storybook-utils": "0.8.4-main.422d1c7879",
+    "@dxos/ui-types": "0.8.4-main.422d1c7879",
+    "@dxos/ui-theme": "0.8.4-main.422d1c7879"
   },
   "peerDependencies": {
-    "@effect-rx/rx-react": "^0.34.1",
-    "@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.406dc2a",
-    "@dxos/react-ui-theme": "0.8.4-main.406dc2a",
-    "@dxos/react-ui": "0.8.4-main.406dc2a"
+    "@effect-atom/atom-react": "^0.5.0",
+    "@effect/platform": "0.94.4",
+    "effect": "3.20.0",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-client": "0.8.4-main.422d1c7879",
+    "@dxos/react-ui": "0.8.4-main.422d1c7879",
+    "@dxos/ui-theme": "0.8.4-main.422d1c7879"
   },
   "publishConfig": {
     "access": "public"

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

@@ -2,71 +2,88 @@
 // Copyright 2025 DXOS.org
 //
 
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React from 'react';
-import { useMemo } from 'react';
+import { type Decorator, type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useMemo } from 'react';
 
-import { createDocAccessor, createObject } from '@dxos/client/echo';
+import { createDocAccessor, createObject } from '@dxos/echo-db';
+import { random } from '@dxos/random';
 import { useThemeContext } from '@dxos/react-ui';
-import { withTheme } from '@dxos/react-ui/testing';
-import { DataType } from '@dxos/schema';
+import { withAttention } from '@dxos/react-ui-attention/testing';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { Text } from '@dxos/schema';
+import {
+  automerge,
+  createBasicExtensions,
+  createMarkdownExtensions,
+  createThemeExtensions,
+  decorateMarkdown,
+} from '@dxos/ui-editor';
 
-import { automerge, createBasicExtensions, createThemeExtensions } from '../../extensions';
-import { Editor } from '../Editor';
+import { createMenuGroup } from '../EditorMenuProvider';
+import { Editor, type EditorViewProps } from './Editor';
+
+random.seed(1234);
+
+const initialValue = ['# Blue Monday', '', 'How does it **feel**?', ''].join('\n');
+
+const items = random.helpers.multiple(random.commerce.productName, { count: 10 }).sort();
+
+const withExtensions: Decorator<EditorViewProps> = (Story, { args }) => {
+  const { themeMode } = useThemeContext();
+  const extensions = useMemo(
+    () => [
+      createBasicExtensions(),
+      createThemeExtensions({ themeMode }),
+      createMarkdownExtensions(),
+      decorateMarkdown(),
+      automerge(createDocAccessor(createObject(Text.make({ content: args.initialValue })), ['content'])),
+    ],
+    [themeMode],
+  );
+
+  return <Story args={{ ...args, extensions }} />;
+};
 
 const meta = {
   title: 'ui/react-ui-editor/Editor',
-  component: Editor,
-  decorators: [withTheme],
+  component: Editor.View,
+  decorators: [withExtensions, withTheme(), withLayout({ layout: 'column' }), withAttention()],
   parameters: {
-    layout: 'column',
+    layout: 'fullscreen',
+  },
+  args: {
+    initialValue,
   },
-} satisfies Meta<typeof Editor>;
+} satisfies Meta<typeof Editor.View>;
 
 export default meta;
 
-type Story = StoryObj<typeof meta>;
+type Story = StoryObj<EditorViewProps>;
 
 export const Default: Story = {
-  render: (args) => {
-    const { themeMode } = useThemeContext();
-    const extensions = useMemo(
-      () => [
-        // Basic extensions.
-        createBasicExtensions(),
-        createThemeExtensions({ themeMode }),
-      ],
-      [],
-    );
-
-    return <Editor classNames='p-2' {...args} extensions={extensions} />;
-  },
-  args: {
-    moveToEnd: true,
-    value: 'Hello world!',
-    onChange: (value) => console.log(value),
-  },
+  render: (args) => (
+    <Editor.Root>
+      <Editor.View {...args} />
+    </Editor.Root>
+  ),
 };
 
-export const Automerge: Story = {
-  render: ({ value, ...props }) => {
-    const { themeMode } = useThemeContext();
-    const extensions = useMemo(
-      () => [
-        // Basic extensions.
-        createBasicExtensions(),
-        createThemeExtensions({ themeMode }),
-        automerge(createDocAccessor(createObject(DataType.makeText(value)), ['content'])),
-      ],
-      [],
-    );
+export const WithToolbar: Story = {
+  render: (args) => (
+    <Editor.Root>
+      <Editor.Toolbar />
+      <Editor.View {...args} />
+    </Editor.Root>
+  ),
+};
 
-    // TODO(burdon): Remove the need for initialValue.
-    return <Editor classNames='p-2' {...props} initialValue={value} extensions={extensions} />;
-  },
-  args: {
-    moveToEnd: true,
-    value: 'Hello world!',
-    onChange: (value) => console.log(value),
-  },
+export const WithPopover: Story = {
+  render: (args) => (
+    <Editor.Root trigger={['@']} getMenu={({ text }) => [createMenuGroup({ items, filter: text })]}>
+      <Editor.Content>
+        <Editor.Toolbar />
+        <Editor.View {...args} />
+      </Editor.Content>
+    </Editor.Root>
+  ),
 };

package/src/components/Editor/Editor.tsx

@@ -2,81 +2,191 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Transaction } from '@codemirror/state';
-import { EditorView } from '@codemirror/view';
-import React, { forwardRef, useEffect, useImperativeHandle } from 'react';
+import { type Extension } from '@codemirror/state';
+import { Atom } from '@effect-atom/atom-react';
+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 { mx } from '@dxos/ui-theme';
+import { isNonNullable } from '@dxos/util';
 
-import { initialSync } from '../../extensions';
-import { type UseTextEditorProps, useTextEditor } from '../../hooks';
+import {
+  EditorMenuProvider,
+  type EditorMenuProviderProps,
+  type UseEditorMenuProps,
+  useEditorMenu,
+} from '../EditorMenuProvider';
+import {
+  type EditorToolbarState,
+  EditorToolbar as NaturalEditorToolbar,
+  type EditorToolbarProps as NaturalEditorToolbarProps,
+} from '../EditorToolbar';
+import {
+  type EditorController,
+  EditorView as NaturalEditorContent,
+  type EditorViewProps as NaturalEditorContentProps,
+  createEditorController,
+  noopController,
+} from './EditorView';
 
-// TODO(burdon): Convert to radix-style (support hooks inside).
-// <Editor.Root>
-//   <Editor.Toolbar />
-//   <Editor.TextEditor />
-// </Editor.Root>
+//
+// Context
+//
 
-export type EditorController = {
-  view: EditorView | null;
-  focus: () => void;
+type EditorContextValue = {
+  controller?: EditorController;
+  setController: (controller: EditorController) => void;
+  extensions?: Extension[];
+  state: Atom.Writable<EditorToolbarState>;
 };
 
-export type EditorProps = ThemedClassName<
-  {
-    moveToEnd?: boolean;
-    value?: string;
-    onChange?: (value: string) => void;
-  } & UseTextEditorProps
+const [EditorContextProvider, useEditorContext] = createContext<EditorContextValue>('Editor');
+
+/**
+ * Access the editor context. Must be used within `Editor.Root`.
+ */
+export { useEditorContext };
+
+//
+// Root
+//
+
+type EditorRootProps = PropsWithChildren<
+  Pick<EditorContextValue, 'extensions'> &
+    Omit<UseEditorMenuProps, 'viewRef'> &
+    Pick<EditorMenuProviderProps, 'numItems'> & {
+      viewMode?: 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, moveToEnd, value, onChange, ...props }, forwardedRef) => {
-    const { parentRef, focusAttributes, view } = useTextEditor(
-      () => ({
-        id,
-        initialValue: value,
-        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],
+const EditorRoot = forwardRef<EditorController | null, EditorRootProps>(
+  ({ children, extensions: extensionsProp, viewMode, numItems, ...props }, forwardedRef) => {
+    // TODO(wittjosiah): Including initialState in the deps causes reactivity issues.
+    const state = useMemo(() => Atom.make<EditorToolbarState>({ viewMode }), [viewMode]);
+
+    // TODO(burdon): Consider lighter-weight approach if EditorMenuProvider is not needed.
+    const { groupsRef, extension, ...menuProps } = useEditorMenu(props);
+    const extensions = useMemo(
+      () => [extension, extensionsProp].filter(isNonNullable).flat(),
+      [extension, extensionsProp],
     );
 
     // External controller.
-    useImperativeHandle(
-      forwardedRef,
-      () => ({
-        view,
-        focus: () => view?.focus(),
-      }),
-      [view],
-    );
+    const [controller, setController] = useState<EditorController>(noopController);
+    useImperativeHandle(forwardedRef, () => controller, [controller]);
 
-    // 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: moveToEnd ? { anchor: view?.state.doc.length ?? 0 } : undefined,
-        });
-        view?.focus();
-      });
-    }, [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} numItems={numItems} {...menuProps}>
+          {children}
+        </EditorMenuProvider>
+      </EditorContextProvider>
+    );
   },
 );
+
+EditorRoot.displayName = 'Editor.Root';
+
+//
+// Content
+//
+
+const EDITOR_CONTENT_NAME = 'Editor.Content';
+
+type EditorContentProps = ThemedClassName<PropsWithChildren<{}>>;
+
+/**
+ * Content component that wraps the toolbar and editor view area.
+ */
+const EditorContent = ({ classNames, children }: EditorContentProps) => {
+  return (
+    <div role='none' className={mx('grid grid-rows-[min-content_1fr] h-full overflow-hidden', classNames)}>
+      {children}
+    </div>
+  );
+};
+
+EditorContent.displayName = EDITOR_CONTENT_NAME;
+
+//
+// View
+//
+
+const EDITOR_VIEW_NAME = 'Editor.View';
+
+type EditorViewProps = Omit<NaturalEditorContentProps, 'ref'>;
+
+/**
+ * View component that renders the actual CodeMirror editor.
+ * Automatically registers the editor controller with the context.
+ */
+const EditorView = ({ extensions: providedExtensions, ...props }: EditorViewProps) => {
+  const { extensions: additionalExtensions = [], setController } = useEditorContext(EDITOR_VIEW_NAME);
+  const extensions = useMemo(
+    () => [additionalExtensions, providedExtensions].filter(isNonNullable).flat(),
+    [providedExtensions, additionalExtensions],
+  );
+
+  return <NaturalEditorContent {...props} extensions={extensions} ref={setController} />;
+};
+
+EditorView.displayName = EDITOR_VIEW_NAME;
+
+//
+// Toolbar
+//
+
+const EDITOR_TOOLBAR_NAME = 'Editor.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(EDITOR_TOOLBAR_NAME);
+
+  // 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_NAME;
+
+//
+// Editor
+//
+
+export const Editor = {
+  Root: EditorRoot,
+  Content: EditorContent,
+  View: EditorView,
+  Toolbar: EditorToolbar,
+};
+
+export type {
+  EditorController,
+  EditorRootProps,
+  EditorContentProps,
+  EditorViewProps,
+  EditorToolbarProps,
+  EditorToolbarState,
+};
+
+export { createEditorController };