@dxos/react-ui-editor 0.3.11-main.8d54a30 → 0.3.11-main.8feb6a5

package/src/components/TextEditor/TextEditor.tsx

@@ -15,6 +15,7 @@ import React, {
   useEffect,
   useImperativeHandle,
   useState,
+  useRef,
 } from 'react';
 
 import { generateName } from '@dxos/display-name';
@@ -34,48 +35,53 @@ export type CursorInfo = {
   to: number;
   line: number;
   lines: number;
+  length: number;
   after?: string;
 };
 
-export type TextEditorRef = {
-  root: HTMLDivElement | null;
-  state?: EditorState;
-  view?: EditorView;
-};
-
 export type TextEditorSlots = {
   root?: Omit<ComponentProps<'div'>, 'ref'>;
-  editor?: {
-    className?: string;
-    placeholder?: string;
-    spellCheck?: boolean;
-    tabIndex?: number;
-    theme?: ThemeStyles;
-  };
+  // editor?: {
+  //   className?: string;
+  // };
 };
 
+// TODO(burdon): Spellcheck?
 export type TextEditorProps = {
   model: EditorModel;
+  focus?: boolean;
+  selection?: { anchor: number; head?: number };
   readonly?: boolean; // TODO(burdon): Move into model.
   comments?: CommentRange[]; // TODO(burdon): Move into extension.
   extensions?: Extension[];
   editorMode?: EditorMode;
+  placeholder?: string;
+  theme?: ThemeStyles;
   slots?: TextEditorSlots;
 };
 
 /**
  * Base text editor.
- * NOTE: Rather than adding properties, try to create extensions that can be reused.
  */
-export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
-  ({ model, readonly, comments, extensions = [], editorMode, slots = defaultSlots }, forwardedRef) => {
-    const { themeMode } = useThemeContext();
+export const BaseTextEditor = forwardRef<EditorView, TextEditorProps>(
+  (
+    { model, focus, selection, readonly, comments, extensions = [], editorMode, theme, slots = defaultSlots },
+    forwardedRef,
+  ) => {
     const tabsterDOMAttribute = useFocusableGroup({ tabBehavior: 'limited' });
-    const [root, setRoot] = useState<HTMLDivElement | null>(null);
-    const [{ state = undefined, view = undefined } = {}, setEditor] = useState<
-      { state?: EditorState; view?: EditorView } | undefined
-    >();
-    useImperativeHandle(forwardedRef, () => ({ root, state, view }), [view, state, root]);
+    const { themeMode } = useThemeContext();
+
+    // The editor view ref should only be used as an escape hatch.
+    const rootRef = useRef<HTMLDivElement>(null);
+    const [view, setView] = useState<EditorView | null>(null);
+    useImperativeHandle<EditorView | null, EditorView | null>(forwardedRef, () => view, [view]);
+
+    // Focus.
+    useEffect(() => {
+      if (view && focus) {
+        view.focus();
+      }
+    }, [view, focus]);
 
     // TODO(burdon): Factor out as extension.
     const { awareness, peer } = model;
@@ -91,7 +97,7 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
 
     // TODO(burdon): Factor out as extension.
     useEffect(() => {
-      if (view && comments?.length) {
+      if (view && comments !== undefined) {
         view.dispatch({
           effects: setCommentRange.of({ model, comments }),
         });
@@ -99,14 +105,15 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
     }, [view, comments]);
 
     useEffect(() => {
-      if (!root) {
+      if (!model || !rootRef.current) {
         return;
       }
 
-      // TODO(burdon): Remember cursor position.
       // https://codemirror.net/docs/ref/#state.EditorStateConfig
       const state = EditorState.create({
         doc: model.text(),
+        // TODO(burdon): Composer should store and set selection when switching documents.
+        selection,
         extensions: [
           readonly && EditorState.readOnly.of(readonly),
 
@@ -116,7 +123,7 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
           // Theme.
           // TODO(burdon): Make theme configurable.
           EditorView.baseTheme(defaultTheme),
-          EditorView.theme(slots?.editor?.theme ?? {}),
+          EditorView.theme(theme ?? {}),
           EditorView.darkTheme.of(themeMode === 'dark'),
 
           // Storage and replication.
@@ -131,36 +138,35 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
       // If the new state is derived from the old state, it will likely not be visible other than the cursor resetting.
       // Ideally this should not happen except when changing between text objects.
       view?.destroy();
-      setEditor({
+      const newView = new EditorView({
+        parent: rootRef.current,
         state,
-        view: new EditorView({
-          state,
-          parent: root,
-          // NOTE: Uncomment to spy on all transactions.
-          // https://codemirror.net/docs/ref/#view.EditorView.dispatch
-          // dispatch: (transaction, view) => {
-          //   view.update([transaction]);
-          // },
-        }),
+        // NOTE: Uncomment to spy on all transactions.
+        // https://codemirror.net/docs/ref/#view.EditorView.dispatch
+        // dispatch: (transaction, view) => {
+        //   view.update([transaction]);
+        // },
       });
 
+      setView(newView);
       return () => {
-        view?.destroy();
-        setEditor(undefined);
+        newView?.destroy();
+        setView(null);
       };
-    }, [root, model, readonly, editorMode, themeMode]);
+    }, [rootRef, model, readonly, editorMode, themeMode]);
 
     const handleKeyUp = useCallback(
       (event: KeyboardEvent) => {
         const { key, altKey, shiftKey, metaKey, ctrlKey } = event;
         switch (key) {
-          case 'Enter': {
-            view?.contentDOM.focus();
-            break;
-          }
+          // TODO(burdon): Is this required (for vim mode?)
+          // case 'Enter': {
+          //   view?.contentDOM.focus();
+          //   break;
+          // }
 
           case 'Escape': {
-            editorMode === 'vim' && (altKey || shiftKey || metaKey || ctrlKey) && root?.focus();
+            editorMode === 'vim' && (altKey || shiftKey || metaKey || ctrlKey) && rootRef.current?.focus();
             break;
           }
         }
@@ -171,42 +177,46 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
     return (
       <div
         key={model.id}
-        ref={setRoot}
+        role='none'
+        ref={rootRef}
         tabIndex={0}
-        {...slots?.root}
-        {...(editorMode !== 'vim' && tabsterDOMAttribute)}
         onKeyUp={handleKeyUp}
+        {...slots.root}
+        {...(editorMode !== 'vim' && tabsterDOMAttribute)}
       />
     );
   },
 );
 
-export const TextEditor = forwardRef<TextEditorRef, TextEditorProps>(
-  ({ readonly, extensions = [], slots: _slots, ...props }, forwardedRef) => {
+export const TextEditor = forwardRef<EditorView, TextEditorProps>(
+  ({ readonly, placeholder, extensions = [], theme = textTheme, slots, ...props }, forwardedRef) => {
     const { themeMode } = useThemeContext();
-    const slots = defaultsDeep({}, _slots, defaultTextSlots);
+    const updatedSlots = defaultsDeep({}, slots, defaultTextSlots);
     return (
       <BaseTextEditor
         ref={forwardedRef}
         readonly={readonly}
-        extensions={[basicBundle({ readonly, themeMode, placeholder: slots?.editor?.placeholder }), ...extensions]}
-        slots={slots}
+        extensions={[basicBundle({ readonly, themeMode, placeholder }), ...extensions]}
+        theme={theme}
+        slots={updatedSlots}
         {...props}
       />
     );
   },
 );
 
-export const MarkdownEditor = forwardRef<TextEditorRef, TextEditorProps>(
-  ({ readonly, extensions = [], slots: _slots, ...props }, forwardedRef) => {
+// TODO(burdon): Remove (Just provide bundle, slots).
+export const MarkdownEditor = forwardRef<EditorView, TextEditorProps>(
+  ({ readonly, placeholder, extensions = [], theme = markdownTheme, slots, ...props }, forwardedRef) => {
     const { themeMode } = useThemeContext();
-    const slots = defaultsDeep({}, _slots, defaultMarkdownSlots);
+    const updatedSlots = defaultsDeep({}, slots, defaultMarkdownSlots);
     return (
       <BaseTextEditor
         ref={forwardedRef}
         readonly={readonly}
-        extensions={[markdownBundle({ readonly, themeMode, placeholder: slots?.editor?.placeholder }), ...extensions]}
-        slots={slots}
+        extensions={[markdownBundle({ readonly, themeMode, placeholder }), ...extensions]}
+        theme={theme}
+        slots={updatedSlots}
         {...props}
       />
     );
@@ -215,20 +225,14 @@ export const MarkdownEditor = forwardRef<TextEditorRef, TextEditorProps>(
 
 export const defaultSlots: TextEditorSlots = {
   root: {
-    className: mx('p-2', inputSurface),
+    className: mx('p-2 overflow-y-auto', inputSurface),
   },
 };
 
 export const defaultTextSlots: TextEditorSlots = {
   ...defaultSlots,
-  editor: {
-    theme: textTheme,
-  },
 };
 
 export const defaultMarkdownSlots: TextEditorSlots = {
   ...defaultSlots,
-  editor: {
-    theme: markdownTheme,
-  },
 };

package/src/components/TextEditor/comments.stories.tsx

@@ -0,0 +1,329 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import '@dxosTheme';
+
+import { type EditorView, keymap } from '@codemirror/view';
+import { faker } from '@faker-js/faker';
+import { Check } from '@phosphor-icons/react';
+import React, { type FC, useEffect, useMemo, useRef, useState } from 'react';
+
+import { TextObject } from '@dxos/echo-schema';
+import { PublicKey } from '@dxos/keys';
+import { Button, DensityProvider } from '@dxos/react-ui';
+import { fixedInsetFlexLayout, mx } from '@dxos/react-ui-theme';
+import { withTheme } from '@dxos/storybook-utils';
+
+import { MarkdownEditor, TextEditor } from './TextEditor';
+import { comments, type CommentsOptions, Cursor } from '../../extensions';
+import { type CommentRange, type Range, useTextModel } from '../../hooks';
+
+faker.seed(101);
+
+//
+// Editor
+//
+
+const Editor: FC<{
+  item: { text: TextObject };
+  commentSelected?: string;
+  commentRanges: CommentRange[];
+  onCreateComment: CommentsOptions['onCreate'];
+  onMoveComment: CommentsOptions['onMove'];
+  onSelectComment: CommentsOptions['onSelect'];
+}> = ({ item, commentSelected, commentRanges, onCreateComment, onMoveComment, onSelectComment }) => {
+  const model = useTextModel({ text: item.text });
+  const editorRef = useRef<EditorView>(null);
+  const [selected, setSelected] = useState<string>();
+  useEffect(() => {
+    if (!editorRef.current?.hasFocus && commentSelected !== selected) {
+      const thread = commentRanges.find((range) => range.id === commentSelected);
+      if (thread) {
+        const { cursor } = thread;
+        const range = Cursor.getRangeFromCursor(editorRef.current!.state.facet(Cursor.converter), cursor);
+        if (range) {
+          // TODO(burdon): Scroll selection to center of screen?
+          editorRef.current?.dispatch({ selection: { anchor: range.from }, scrollIntoView: true });
+        }
+      }
+
+      setSelected(commentSelected);
+    }
+  }, [selected, commentRanges, commentSelected]);
+
+  const extensions = useMemo(() => {
+    return [
+      comments({
+        onCreate: onCreateComment,
+        onMove: onMoveComment,
+        onSelect: onSelectComment,
+      }),
+    ];
+  }, []);
+
+  if (!model) {
+    return null;
+  }
+
+  // TODO(burdon): Highlight currently selected comment.
+  return (
+    <div className='flex grow overflow-y-scroll'>
+      <MarkdownEditor ref={editorRef} model={model} comments={commentRanges} extensions={extensions} />
+    </div>
+  );
+};
+
+//
+// Comments thread
+//
+
+type CommentThread = {
+  id: string;
+  range: CommentRange;
+  yPos?: number;
+  selection?: Range;
+  messages: TextObject[];
+};
+
+const Thread: FC<{
+  thread: CommentThread;
+  selected: boolean;
+  onSelect: () => void;
+  onResolve: () => void;
+}> = ({ thread, selected, onSelect, onResolve }) => {
+  const [item, setItem] = useState({ text: new TextObject() });
+  const model = useTextModel({ text: item.text });
+  const editorRef = useRef<EditorView>(null);
+
+  // TODO(burdon): Hack to focus (view is recreated when text object changes).
+  const focus = () => {
+    setTimeout(() => {
+      editorRef.current?.focus();
+    }, 100);
+  };
+
+  const containerRef = useRef<HTMLDivElement>(null);
+  useEffect(() => {
+    if (selected) {
+      containerRef.current?.scrollIntoView({ block: 'center', behavior: 'smooth' });
+      if (thread.messages.length === 0) {
+        focus();
+      }
+    }
+  }, [selected]);
+
+  const handleCreateMessage = () => {
+    const text = model?.text().trim();
+    if (text?.length) {
+      thread.messages.push(item.text);
+      setItem({ text: new TextObject() });
+      focus();
+    }
+  };
+
+  if (!model) {
+    return null;
+  }
+
+  return (
+    <div className={mx('flex flex-col m-1 rounded shadow divide-y bg-white', selected && 'ring')}>
+      <div className='flex p-2 text-xs font-mono gap-2 text-neutral-500 font-thin'>
+        <span>id:{thread.id.slice(0, 4)}</span>
+        <span>from:{thread.selection?.from}</span>
+        <span>to:{thread.selection?.to}</span>
+        <span>y:{thread.yPos}</span>
+      </div>
+
+      {thread.messages.map((message, i) => (
+        // TODO(burdon): Fix default editor padding so content doesn't jump on creating message.
+        <div key={i} className='p-2' onClick={() => onSelect()}>
+          {message.text}
+        </div>
+      ))}
+
+      <div ref={containerRef} onClick={() => onSelect()} className='flex py-1'>
+        <div className='grow'>
+          <TextEditor
+            ref={editorRef}
+            model={model}
+            placeholder={'Enter comment...'}
+            extensions={[
+              keymap.of([
+                {
+                  key: 'Enter',
+                  run: () => {
+                    handleCreateMessage();
+                    return true;
+                  },
+                },
+              ]),
+            ]}
+          />
+        </div>
+        <Button variant='ghost' classNames='px-1 mr-1' title='Resolve' onClick={onResolve}>
+          <Check />
+        </Button>
+      </div>
+    </div>
+  );
+};
+
+const Sidebar: FC<{
+  threads: CommentThread[];
+  selected?: string;
+  onSelect: (thread: string) => void;
+  onResolve: (thread: string) => void;
+}> = ({ threads, selected, onSelect, onResolve }) => {
+  // Sort by y-position.
+  const sortedThreads = useMemo(() => {
+    const sorted = [...threads];
+    return sorted.sort(({ yPos: a = Infinity }, { yPos: b = Infinity }) => {
+      return a < b ? -1 : a > b ? 1 : 0;
+    });
+  }, [threads]);
+
+  return (
+    <DensityProvider density='fine'>
+      <div className='flex flex-col grow overflow-y-scroll py-4 gap-4 pr-4'>
+        {sortedThreads.map((thread) => (
+          <Thread
+            key={thread.id}
+            thread={thread}
+            selected={thread.id === selected}
+            onSelect={() => onSelect(thread.id)}
+            onResolve={() => onResolve(thread.id)}
+          />
+        ))}
+      </div>
+    </DensityProvider>
+  );
+};
+
+//
+// Story container.
+//
+
+type StoryProps = {
+  text?: string;
+  autoCreate?: boolean;
+};
+
+const Story = ({ text, autoCreate }: StoryProps) => {
+  const [item] = useState({ text: new TextObject(text) });
+  const [threads, setThreads] = useState<CommentThread[]>([]);
+  const commentRanges = useMemo(() => threads.map((thread) => thread.range), [threads]);
+  const [selected, setSelected] = useState<string>();
+
+  // Filter by visibility.
+  const visibleThreads = useMemo(() => threads.filter((thread) => thread.yPos !== undefined), [threads]);
+
+  const handleCreateComment: CommentsOptions['onCreate'] = (cursor, location) => {
+    const id = PublicKey.random().toHex();
+    setThreads((threads) => [
+      ...threads,
+      {
+        id,
+        range: { id, cursor },
+        yPos: location ? Math.floor(location.top) : undefined,
+        messages: autoCreate
+          ? faker.helpers.multiple(() => new TextObject(faker.lorem.sentence()), { count: { min: 2, max: 5 } })
+          : [],
+      },
+    ]);
+    setSelected(id);
+    return id;
+  };
+
+  // TODO(burdon): Scroll sidebar on select.
+  const handleSelectComment: CommentsOptions['onSelect'] = ({ active, closest, ranges }) => {
+    setThreads((threads) =>
+      threads.map((thread) => {
+        const range = ranges.find((range) => range.id === thread.range.id);
+        if (range) {
+          thread.yPos = range.location ? Math.floor(range.location.top) : undefined;
+          thread.selection = { from: range.from, to: range.to };
+        }
+
+        return thread;
+      }),
+    );
+
+    setSelected(active ?? closest);
+  };
+
+  const handleMoveComment: CommentsOptions['onMove'] = (id, cursor) => {
+    setThreads((threads) =>
+      threads.map((thread) => {
+        if (thread.id === id) {
+          thread.range.cursor = cursor;
+        }
+        return thread;
+      }),
+    );
+  };
+
+  const handleSelectThread = (id: string) => {
+    setSelected(id);
+  };
+
+  const handleResolveThread = (id: string) => {
+    setThreads((threads) => [...threads.filter((thread) => thread.id !== id)]);
+    setSelected(undefined);
+  };
+
+  return (
+    <div className={mx(fixedInsetFlexLayout, 'bg-neutral-100')}>
+      <div className='flex justify-center h-full gap-8'>
+        <div className='flex flex-col h-full w-[600px]'>
+          <Editor
+            item={item}
+            commentSelected={selected}
+            commentRanges={commentRanges}
+            onCreateComment={handleCreateComment}
+            onMoveComment={handleMoveComment}
+            onSelectComment={handleSelectComment}
+          />
+        </div>
+
+        <div className='flex flex-col h-full w-[300px]'>
+          <Sidebar
+            threads={visibleThreads}
+            selected={selected}
+            onSelect={handleSelectThread}
+            onResolve={handleResolveThread}
+          />
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export default {
+  title: 'react-ui-editor/comments',
+  component: MarkdownEditor,
+  decorators: [withTheme],
+  render: (args: StoryProps) => <Story {...args} />,
+};
+
+const str = (...lines: string[]) => lines.join('\n');
+
+const document = str(
+  '# Comments',
+  '',
+  str(...faker.helpers.multiple(() => [faker.lorem.paragraph({ min: 5, max: 10 }), ''], { count: 20 }).flat()),
+  '',
+);
+
+export const Default = {
+  args: {
+    text: document,
+  },
+};
+
+export const Demo = {
+  args: {
+    text: document,
+    autoCreate: true,
+  },
+};

package/src/extensions/autocomplete.ts

@@ -13,6 +13,7 @@ import {
   type CompletionContext,
   type CompletionResult,
 } from '@codemirror/autocomplete';
+import { markdownLanguage } from '@codemirror/lang-markdown';
 import { keymap } from '@codemirror/view';
 
 export type AutocompleteResult = Completion;
@@ -28,32 +29,32 @@ export const autocomplete = ({ onSearch }: AutocompleteOptions) => {
   return [
     // https://codemirror.net/docs/ref/#view.keymap
     // https://discuss.codemirror.net/t/how-can-i-replace-the-default-autocompletion-keymap-v6/3322
+    // TODO(burdon): Set custom keymap.
     keymap.of(completionKeymap),
 
     // https://codemirror.net/examples/autocompletion
     // https://codemirror.net/docs/ref/#autocomplete.autocompletion
     autocompletion({
-      // TODO(burdon): Set custom keymap.
-      // defaultKeymap: false,
+      defaultKeymap: false,
 
       // Don't start unless key press.
       activateOnTyping: false,
+    }),
 
-      // TODO(burdon): Option to create new page?
-      // TODO(burdon): Optional decoration via addToOptions
-      override: [
-        (context: CompletionContext): CompletionResult | null => {
-          const match = context.matchBefore(/\w*/);
-          if (!match || (match.from === match.to && !context.explicit)) {
-            return null;
-          }
-
-          return {
-            from: match.from,
-            options: onSearch(match.text.toLowerCase()),
-          };
-        },
-      ],
+    // TODO(burdon): Option to create new page?
+    // TODO(burdon): Optional decoration via addToOptions
+    markdownLanguage.data.of({
+      autocomplete: (context: CompletionContext): CompletionResult | null => {
+        const match = context.matchBefore(/\w*/);
+        if (!match || (match.from === match.to && !context.explicit)) {
+          return null;
+        }
+
+        return {
+          from: match.from,
+          options: onSearch(match.text.toLowerCase()),
+        };
+      },
     }),
   ];
 };

package/src/extensions/automerge/automerge.ts

@@ -13,7 +13,7 @@ import { type Prop } from '@dxos/automerge/automerge';
 import { cursorConverter } from './cursor';
 import { effectType, type IDocHandle, isReconcileTx, type Value } from './defs';
 import { PatchSemaphore } from './semaphore';
-import { CursorConverter } from '../../util';
+import { Cursor } from '../cursor';
 
 const semaphoreFacet = Facet.define<PatchSemaphore, PatchSemaphore>({
   combine: (values) => values.at(-1)!, // Take last.
@@ -85,7 +85,7 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
 
   return {
     extension: [
-      CursorConverter.of(cursorConverter(handle, path)),
+      Cursor.converter.of(cursorConverter(handle, path)),
       semaphoreFacet.of(semaphore),
       stateField,
       viewPlugin,

package/src/extensions/automerge/cursor.ts

@@ -8,7 +8,7 @@ import type { Prop } from '@dxos/automerge/automerge';
 import { next as automerge } from '@dxos/automerge/automerge';
 
 import { type IDocHandle } from './defs';
-import { type CursorConverter } from '../../util';
+import { type CursorConverter } from '../cursor';
 
 export const cursorConverter = (handle: IDocHandle, path: Prop[]): CursorConverter => ({
   // TODO(burdon): Handle assoc to associate with a previous character.
@@ -26,6 +26,7 @@ export const cursorConverter = (handle: IDocHandle, path: Prop[]): CursorConvert
     // NOTE: Slice is needed because getCursor mutates the array.
     return automerge.getCursor(doc, path.slice(), pos);
   },
+
   fromCursor: (cursor) => {
     if (cursor === '') {
       return 0;

package/src/extensions/automerge/index.ts

@@ -4,3 +4,4 @@
 
 export { automerge } from './automerge';
 export { type IDocHandle } from './defs';
+export { cursorConverter } from './cursor';