@dxos/react-ui-editor 0.8.4-main.72ec0f3 → 0.8.4-main.74a063c4e0

package/src/components/EditorToolbar/search.ts

@@ -5,19 +5,21 @@
 import { openSearchPanel } from '@codemirror/search';
 import { type EditorView } from '@codemirror/view';
 
-import { createEditorAction } from './actions';
+import { type ActionGroupBuilderFn } from '@dxos/react-ui-menu';
 
-const createSearchAction = (getView: () => EditorView) =>
-  createEditorAction(
-    'search',
-    {
-      testId: 'editor.toolbar.search',
-      icon: 'ph--magnifying-glass--regular',
-    },
-    () => openSearchPanel(getView()),
-  );
+import { translationKey } from '../../translations';
 
-export const createSearch = (getView: () => EditorView) => ({
-  nodes: [createSearchAction(getView)],
-  edges: [{ source: 'root', target: 'search' }],
-});
+/** Add search action to the builder. */
+export const addSearch =
+  (getView: () => EditorView): ActionGroupBuilderFn =>
+  (builder) => {
+    builder.action(
+      'search',
+      {
+        label: ['search.label', { ns: translationKey }],
+        testId: 'editor.toolbar.search',
+        icon: 'ph--magnifying-glass--regular',
+      },
+      () => openSearchPanel(getView()),
+    );
+  };

package/src/components/EditorToolbar/useEditorToolbar.ts

@@ -2,19 +2,19 @@
 // Copyright 2025 DXOS.org
 //
 
+import { Atom } from '@effect-atom/atom-react';
 import { useMemo } from 'react';
 
-import { type Live, live } from '@dxos/live-object';
-
-import { type Formatting } from '../../extensions';
-import { type EditorViewMode } from '../../types';
+import { type EditorViewMode, type Formatting } from '@dxos/ui-editor';
 
 // TODO(burdon): Move to extensions.
 export type EditorToolbarState = { viewMode?: EditorViewMode } & Formatting;
 
 /**
+ * Creates an atom for editor toolbar state.
  * @deprecated Use Editor.Root
  */
-export const useEditorToolbar = (initialState: Partial<EditorToolbarState> = {}): Live<EditorToolbarState> => {
-  return useMemo(() => live<EditorToolbarState>(initialState), []);
+export const useEditorToolbar = (initialState: EditorToolbarState = {}): Atom.Writable<EditorToolbarState> => {
+  // TODO(wittjosiah): Including initialState in the deps causes reactivity issues.
+  return useMemo(() => Atom.make<EditorToolbarState>(initialState), []);
 };

package/src/components/EditorToolbar/view-mode.ts

@@ -2,54 +2,47 @@
 // Copyright 2025 DXOS.org
 //
 
-import { type NodeArg } from '@dxos/app-graph';
-import { type ToolbarMenuActionGroupProperties } from '@dxos/react-ui-menu';
+import { type ActionGroupBuilderFn, type ToolbarMenuActionGroupProperties } from '@dxos/react-ui-menu';
+import { type EditorViewMode } from '@dxos/ui-editor';
 
 import { translationKey } from '../../translations';
-import { type EditorViewMode } from '../../types';
-
-import { createEditorAction, createEditorActionGroup } from './actions';
 import { type EditorToolbarState } from './useEditorToolbar';
 
-const createViewModeGroupAction = (value: string) =>
-  createEditorActionGroup(
-    'viewMode',
-    {
-      variant: 'dropdownMenu',
-      applyActive: true,
-      selectCardinality: 'single',
-      value,
-    } as ToolbarMenuActionGroupProperties,
-    'ph--eye--regular',
-  );
+const viewModes = {
+  preview: 'ph--eye--regular',
+  source: 'ph--pencil-simple--regular',
+  readonly: 'ph--pencil-slash--regular',
+};
 
-const createViewModeActions = (value: string, onViewModeChange: (mode: EditorViewMode) => void) =>
-  Object.entries({
-    preview: 'ph--eye--regular',
-    source: 'ph--pencil-simple--regular',
-    readonly: 'ph--pencil-slash--regular',
-  }).map(([viewMode, icon]) => {
-    const checked = viewMode === value;
-    return createEditorAction(
-      `view-mode--${viewMode}`,
+/** Add view mode actions to the builder. */
+export const addViewMode =
+  (state: EditorToolbarState, onViewModeChange: (mode: EditorViewMode) => void): ActionGroupBuilderFn =>
+  (builder) => {
+    const value = state.viewMode ?? 'source';
+    builder.group(
+      'viewMode',
       {
-        label: [`${viewMode} mode label`, { ns: translationKey }],
-        checked,
-        icon,
+        label: ['view-mode.label', { ns: translationKey }],
+        icon: 'ph--eye--regular',
+        iconOnly: true,
+        variant: 'dropdownMenu',
+        applyActive: true,
+        selectCardinality: 'single',
+        value,
+      } as ToolbarMenuActionGroupProperties,
+      (group) => {
+        for (const [viewMode, icon] of Object.entries(viewModes)) {
+          const checked = viewMode === value;
+          group.action(
+            `view-mode--${viewMode}`,
+            {
+              label: [`view-mode.${viewMode}.label`, { ns: translationKey }],
+              checked,
+              icon,
+            },
+            () => onViewModeChange(viewMode as EditorViewMode),
+          );
+        }
       },
-      () => onViewModeChange(viewMode as EditorViewMode),
     );
-  });
-
-export const createViewMode = (state: EditorToolbarState, onViewModeChange: (mode: EditorViewMode) => void) => {
-  const value = state.viewMode ?? 'source';
-  const viewModeGroupAction = createViewModeGroupAction(value);
-  const viewModeActions = createViewModeActions(value, onViewModeChange);
-  return {
-    nodes: [viewModeGroupAction as NodeArg<any>, ...viewModeActions],
-    edges: [
-      { source: 'root', target: 'viewMode' },
-      ...viewModeActions.map(({ id }) => ({ source: viewModeGroupAction.id, target: id })),
-    ],
   };
-};

package/src/components/index.ts

@@ -4,8 +4,6 @@
 
 export * from './Editor';
 
-// export { type GetMenuContext } from './EditorMenuProvider';
-
 // TODO(burdon): Remove once Editor is fully migrated.
 export { EditorContent, createEditorController } from './EditorContent';
 export * from './EditorMenuProvider';

package/src/hooks/useTextEditor.ts

@@ -17,11 +17,15 @@ import {
 } from 'react';
 
 import { log } from '@dxos/log';
+import {
+  type EditorSelection,
+  createEditorStateTransaction,
+  debugDispatcher,
+  documentId,
+  modalStateField,
+} from '@dxos/ui-editor';
 import { type MaybeProvider, getProviderValue, isTruthy } from '@dxos/util';
 
-import { type EditorSelection, createEditorStateTransaction, documentId, modalStateField } from '../extensions';
-import { debugDispatcher } from '../util';
-
 let instanceCount = 0;
 
 export type CursorInfo = {
@@ -156,7 +160,9 @@ export const useTextEditor = (
           element?.focus();
           break;
         }
+
         case 'Enter': {
+          event.preventDefault();
           if (target === currentTarget) {
             view?.focus();
           }

package/src/index.ts

@@ -4,17 +4,7 @@
 
 import { translations } from './translations';
 
-export { type Extension, EditorState } from '@codemirror/state';
-export { EditorView, keymap } from '@codemirror/view';
-export { tags } from '@lezer/highlight';
-
-export { TextKind } from '@dxos/protocols/proto/dxos/echo/model/text';
-
 export * from './components';
-export * from './defaults';
-export * from './extensions';
 export * from './hooks';
-export * from './types';
-export * from './util';
 
 export { translations };

package/src/stories/Automerge.stories.tsx

@@ -0,0 +1,173 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { Repo } from '@automerge/automerge-repo';
+import { BroadcastChannelNetworkAdapter } from '@automerge/automerge-repo-network-broadcastchannel';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useCallback, useEffect, useState } from 'react';
+
+import { Obj, Ref } from '@dxos/echo';
+import { DocAccessor, createDocAccessor } from '@dxos/echo-db';
+import { TestSchema } from '@dxos/echo/testing';
+import { log } from '@dxos/log';
+import { type Messenger } from '@dxos/protocols';
+import { Query, useQuery, useSpace } from '@dxos/react-client/echo';
+import { type Identity, useIdentity } from '@dxos/react-client/halo';
+import { useClientStory, withMultiClientProvider } from '@dxos/react-client/testing';
+import { Button, useThemeContext } from '@dxos/react-ui';
+import { withLayout, withTheme, Loading } from '@dxos/react-ui/testing';
+import { createBasicExtensions, createDataExtensions, createThemeExtensions } from '@dxos/ui-editor';
+
+import { useTextEditor } from '../hooks';
+import { translations } from '../translations';
+
+const initialContent = 'Hello world!';
+
+type TestObject = {
+  text: string;
+};
+
+type EditorProps = {
+  source: DocAccessor;
+  messenger?: Messenger;
+  identity?: Identity;
+  autoFocus?: boolean;
+};
+
+const Editor = ({ source, messenger, identity, autoFocus }: EditorProps) => {
+  const { themeMode } = useThemeContext();
+  const { parentRef } = useTextEditor(
+    () => ({
+      autoFocus,
+      initialValue: DocAccessor.getValue(source),
+      extensions: [
+        createBasicExtensions({ placeholder: 'Type here...', search: true }),
+        createThemeExtensions({ themeMode, slots: { scroll: { className: 'p-2' } } }),
+        createDataExtensions({ id: 'test', text: source, messenger, identity }),
+      ],
+    }),
+    [source, themeMode],
+  );
+
+  return <div ref={parentRef} className='flex w-full' />;
+};
+
+const DefaultStory = () => {
+  const [object1, setObject1] = useState<DocAccessor<TestObject>>();
+  const [object2, setObject2] = useState<DocAccessor<TestObject>>();
+
+  useEffect(() => {
+    queueMicrotask(async () => {
+      const repo1 = new Repo({ network: [new BroadcastChannelNetworkAdapter()] });
+      const repo2 = new Repo({ network: [new BroadcastChannelNetworkAdapter()] });
+
+      const object1 = repo1.create<TestObject>();
+      object1.change((doc: TestObject) => {
+        doc.text = initialContent;
+      });
+
+      const object2 = await repo2.find<TestObject>(object1.url);
+      await object2.whenReady();
+
+      setObject1({ handle: object1, path: ['text'] });
+      setObject2({ handle: object2, path: ['text'] });
+    });
+  }, []);
+
+  if (!object1 || !object2) {
+    return <Loading data={{ object1: !!object1, object2: !!object2 }} />;
+  }
+
+  return (
+    <div className='h-full w-full grid grid-cols-2 gap-4'>
+      <Editor source={object1} autoFocus />
+      <Editor source={object2} />
+    </div>
+  );
+};
+
+const EchoStory = () => {
+  const { spaceId, index } = useClientStory();
+  const identity = useIdentity();
+  const space = useSpace(spaceId);
+  const objects = useQuery(space?.db, Query.type(TestSchema.Expando, { type: 'test' }));
+
+  const [source, setSource] = useState<DocAccessor>();
+  const init = useCallback(() => {
+    const content = objects[0]?.content.target;
+    if (!content) {
+      if (objects.length) {
+        // TODO(burdon): Initially ref isn't ready.
+        log.warn('no content', { index, objects: JSON.stringify(objects) });
+      }
+      return;
+    }
+
+    setSource(createDocAccessor(content, ['content']));
+  }, [objects]);
+
+  useEffect(() => {
+    if (source) {
+      return;
+    }
+
+    init();
+  }, [objects, source]);
+
+  return (
+    <div className='h-full w-full flex flex-col overflow-hidden'>
+      <pre className='p-2 text-xs text-subdued'>
+        {JSON.stringify({ index, identity: identity?.identityKey.truncate(), spaceId, objects }, null, 2)}
+      </pre>
+      {identity && source ? (
+        <div className='p-2 flex grow overflow-hidden'>
+          <Editor identity={identity} messenger={space} source={source} />
+        </div>
+      ) : (
+        <div className='p-2'>
+          <Button onClick={init}>Init</Button>
+        </div>
+      )}
+    </div>
+  );
+};
+
+const meta = {
+  title: 'ui/react-ui-editor/Automerge',
+  component: Editor as any,
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+// TODO(burdon): ERROR: factories.ts:126 Error: Non-base58 character
+export const Default: Story = {
+  render: DefaultStory,
+};
+
+// TODO(burdon): Failing (doesn't sync)
+export const WithEcho: Story = {
+  decorators: [
+    withMultiClientProvider({
+      numClients: 2,
+      createIdentity: true,
+      createSpace: true,
+      onCreateSpace: async ({ space }) => {
+        space.db.add(
+          Obj.make(TestSchema.Expando, {
+            type: 'test',
+            content: Ref.make(Obj.make(TestSchema.Expando, { content: initialContent })),
+          }),
+        );
+      },
+    }),
+  ],
+  render: EchoStory,
+};

package/src/stories/Comments.stories.tsx

@@ -2,25 +2,24 @@
 // Copyright 2023 DXOS.org
 //
 
-import { effect, useSignal } from '@preact/signals-react';
+import { Atom, RegistryContext } from '@effect-atom/atom-react';
 import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React, { type FC } from 'react';
+import React, { type FC, useContext, useMemo } from 'react';
 
 import { keySymbols, parseShortcut } from '@dxos/keyboard';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
-import { withTheme } from '@dxos/react-ui/testing';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { withRegistry } from '@dxos/storybook-utils';
+import { type Comment, annotations, comments, createExternalCommentSync } from '@dxos/ui-editor';
 
-import { annotations, comments, createExternalCommentSync } from '../extensions';
-import { type Comment } from '../types';
 import { createRenderer, str } from '../util';
-
 import { EditorStory, content, longText } from './components';
 
 const meta = {
   title: 'ui/react-ui-editor/Comments',
   component: EditorStory,
-  decorators: [withTheme],
+  decorators: [withRegistry, withTheme(), withLayout({ layout: 'fullscreen' })],
   parameters: {
     layout: 'fullscreen',
   },
@@ -34,52 +33,57 @@ type Story = StoryObj<typeof meta>;
 // Comments
 //
 
+const CommentsStory = () => {
+  const registry = useContext(RegistryContext);
+  const commentsAtom = useMemo(() => Atom.make<Comment[]>([]), []);
+
+  return (
+    <EditorStory
+      text={str('# Comments', '', content.paragraphs, content.footer)}
+      extensions={[
+        createExternalCommentSync(
+          'test',
+          (sink) => registry.subscribe(commentsAtom, () => sink()),
+          () => registry.get(commentsAtom),
+        ),
+        comments({
+          id: 'test',
+          renderTooltip: createRenderer(CommentTooltip),
+          onCreate: ({ cursor }) => {
+            const id = PublicKey.random().toHex();
+            const current = registry.get(commentsAtom);
+            registry.set(commentsAtom, [...current, { id, cursor }]);
+            return id;
+          },
+          onSelect: (state) => {
+            const debug = false;
+            if (debug) {
+              log.info('update', {
+                comments: state.comments.length,
+                active: state.selection.current?.slice(0, 8),
+                closest: state.selection.closest?.slice(0, 8),
+              });
+            }
+          },
+        }),
+      ]}
+    />
+  );
+};
+
 export const Comments: Story = {
-  render: () => {
-    const _comments = useSignal<Comment[]>([]);
-    return (
-      <EditorStory
-        text={str('# Comments', '', content.paragraphs, content.footer)}
-        extensions={[
-          createExternalCommentSync(
-            'test',
-            (sink) => effect(() => sink()),
-            () => _comments.value,
-          ),
-          comments({
-            id: 'test',
-            renderTooltip: createRenderer(CommentTooltip),
-            onCreate: ({ cursor }) => {
-              const id = PublicKey.random().toHex();
-              _comments.value = [..._comments.value, { id, cursor }];
-              return id;
-            },
-            onSelect: (state) => {
-              const debug = false;
-              if (debug) {
-                log.info('update', {
-                  comments: state.comments.length,
-                  active: state.selection.current?.slice(0, 8),
-                  closest: state.selection.closest?.slice(0, 8),
-                });
-              }
-            },
-          }),
-        ]}
-      />
-    );
-  },
+  render: () => <CommentsStory />,
 };
 
 const Key: FC<{ char: string }> = ({ char }) => (
-  <span className='flex justify-center items-center is-[24px] bs-[24px] rounded text-xs bg-neutral-200 text-black'>
+  <span className='flex justify-center items-center w-[24px] h-[24px] rounded-sm text-xs bg-neutral-200 text-black'>
     {char}
   </span>
 );
 
 const CommentTooltip: FC<{ shortcut: string }> = ({ shortcut }) => {
   return (
-    <div className='flex items-center gap-2 pli-2 plb-2 bg-neutral-700 text-white text-xs rounded'>
+    <div className='flex items-center gap-2 px-2 py-2 bg-neutral-700 text-white text-xs rounded-sm'>
       <div>Create comment</div>
       <div className='flex gap-1'>
         {keySymbols(parseShortcut(shortcut)).map((char) => (

package/src/stories/EditorToolbar.stories.tsx

@@ -2,36 +2,47 @@
 // Copyright 2024 DXOS.org
 //
 
+import { RegistryContext, useAtomValue } from '@effect-atom/atom-react';
 import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React, { useCallback, useState } from 'react';
+import React, { useCallback, useContext, useState } from 'react';
 
 import { invariant } from '@dxos/invariant';
-import { useThemeContext } from '@dxos/react-ui';
-import { withTheme } from '@dxos/react-ui/testing';
-import { attentionSurface, mx } from '@dxos/react-ui-theme';
-
-import { EditorToolbar, useEditorToolbar } from '../components';
-import { editorWidth } from '../defaults';
+import { Panel, useThemeContext } from '@dxos/react-ui';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { withRegistry } from '@dxos/storybook-utils';
 import {
+  type EditorInputMode,
+  type EditorViewMode,
   InputModeExtensions,
   createBasicExtensions,
   createMarkdownExtensions,
   createThemeExtensions,
   decorateMarkdown,
+  documentSlots,
   formattingKeymap,
   formattingListener,
-} from '../extensions';
+} from '@dxos/ui-editor';
+
+import { EditorToolbar, type EditorToolbarState, useEditorToolbar } from '../components';
 import { type UseTextEditorProps, useTextEditor } from '../hooks';
 import { translations } from '../translations';
-import { type EditorInputMode, type EditorViewMode } from '../types';
 
-type StoryProps = { placeholder?: string } & UseTextEditorProps;
+type DefaultStoryProps = { placeholder?: string } & UseTextEditorProps;
 
-const DefaultStory = ({ autoFocus, initialValue, placeholder }: StoryProps) => {
+const DefaultStory = ({ autoFocus, initialValue, placeholder }: DefaultStoryProps) => {
   const { themeMode } = useThemeContext();
+  const registry = useContext(RegistryContext);
 
   const toolbarState = useEditorToolbar({ viewMode: 'source' });
-  const viewMode = toolbarState.viewMode;
+  const { viewMode } = useAtomValue(toolbarState);
+
+  const updateToolbarState = useCallback(
+    (formatting: EditorToolbarState) => {
+      registry.update(toolbarState, (state) => ({ ...state, ...formatting }));
+    },
+    [registry, toolbarState],
+  );
+
   // TODO(wittjosiah): Provide way to change the input mode.
   const [editorInputMode, _setEditorInputMode] = useState<EditorInputMode>('default');
   const { parentRef, view } = useTextEditor(
@@ -41,12 +52,21 @@ const DefaultStory = ({ autoFocus, initialValue, placeholder }: StoryProps) => {
       selectionEnd: true,
       extensions: [
         editorInputMode ? InputModeExtensions[editorInputMode] : [],
-        createBasicExtensions({ placeholder, lineWrapping: true, readOnly: viewMode === 'readonly', search: true }),
+        createBasicExtensions({
+          placeholder,
+          lineWrapping: true,
+          readOnly: viewMode === 'readonly',
+          search: true,
+        }),
+        createThemeExtensions({
+          themeMode,
+          syntaxHighlighting: true,
+          slots: documentSlots,
+        }),
         createMarkdownExtensions(),
-        createThemeExtensions({ themeMode, syntaxHighlighting: true }),
         viewMode === 'source' ? [] : decorateMarkdown(),
         formattingKeymap(),
-        formattingListener(() => toolbarState),
+        formattingListener(updateToolbarState),
       ],
     }),
     [editorInputMode, viewMode, themeMode, placeholder],
@@ -57,26 +77,36 @@ const DefaultStory = ({ autoFocus, initialValue, placeholder }: StoryProps) => {
     return view;
   }, [view]);
 
-  const handleViewModeChange = useCallback((mode: EditorViewMode) => {
-    toolbarState.viewMode = mode;
-  }, []);
+  const handleViewModeChange = useCallback(
+    (mode: EditorViewMode) => {
+      registry.update(toolbarState, (state) => ({ ...state, viewMode: mode }));
+    },
+    [registry, toolbarState],
+  );
 
-  // TODO(marijn): This doesn't update the state on view changes.
-  //  Also not sure if view is even guaranteed to exist at this point.
   return (
-    <div role='none' className={mx('fixed inset-0 flex flex-col')}>
-      {toolbarState && <EditorToolbar state={toolbarState} getView={getView} onViewModeChange={handleViewModeChange} />}
-      <div role='none' className={mx('grow overflow-hidden', attentionSurface)}>
-        <div className={mx(editorWidth)} ref={parentRef} />
-      </div>
-    </div>
+    <Panel.Root>
+      {toolbarState && (
+        <Panel.Toolbar>
+          <EditorToolbar
+            classNames='dx-document'
+            state={toolbarState}
+            getView={getView}
+            onViewModeChange={handleViewModeChange}
+          />
+        </Panel.Toolbar>
+      )}
+      <Panel.Content>
+        <div role='none' className='dx-container dx-document bg-base-surface' ref={parentRef} />
+      </Panel.Content>
+    </Panel.Root>
   );
 };
 
 const meta = {
   title: 'ui/react-ui-editor/EditorToolbar',
   render: DefaultStory,
-  decorators: [withTheme],
+  decorators: [withRegistry, withTheme(), withLayout({ layout: 'fullscreen', classNames: 'bg-sidebar-surface' })],
   parameters: {
     layout: 'fullscreen',
     translations,