@dxos/react-ui-editor 0.3.11-main.1d8382a → 0.3.11-main.264ec26

package/src/components/TextEditor/TextEditor.tsx

@@ -2,7 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import { EditorState, type Extension } from '@codemirror/state';
+import { EditorState, type Extension, type StateEffect } from '@codemirror/state';
 import { EditorView } from '@codemirror/view';
 import { useFocusableGroup } from '@fluentui/react-tabster';
 import { vim } from '@replit/codemirror-vim';
@@ -14,19 +14,21 @@ import React, {
   useCallback,
   useEffect,
   useImperativeHandle,
-  useState,
   useRef,
+  useState,
 } from 'react';
 
-import { generateName } from '@dxos/display-name';
+import { log } from '@dxos/log';
 import { useThemeContext } from '@dxos/react-ui';
-import { getColorForValue, inputSurface, mx } from '@dxos/react-ui-theme';
+import { inputSurface, mx } from '@dxos/react-ui-theme';
 
-import { basicBundle, markdownBundle, setCommentRange } from '../../extensions';
-import { type CommentRange, type EditorModel } from '../../hooks';
+import { basicBundle, markdownBundle, useAwareness } from '../../extensions';
+import { type EditorModel } from '../../hooks';
 import { type ThemeStyles } from '../../styles';
 import { defaultTheme, markdownTheme, textTheme } from '../../themes';
+import { logChanges } from '../../util';
 
+// TODO(burdon): Change to enum?
 export const EditorModes = ['default', 'vim'] as const;
 export type EditorMode = (typeof EditorModes)[number];
 
@@ -43,123 +45,141 @@ export type TextEditorSlots = {
   root?: Omit<ComponentProps<'div'>, 'ref'>;
   editor?: {
     className?: string;
-    placeholder?: string;
-    spellCheck?: boolean;
-    tabIndex?: number;
-    theme?: ThemeStyles;
+  };
+  content?: {
+    className?: string;
   };
 };
 
+// TODO(burdon): Spellcheck?
 export type TextEditorProps = {
   model: EditorModel;
-  focus?: boolean;
   readonly?: boolean; // TODO(burdon): Move into model.
-  comments?: CommentRange[]; // TODO(burdon): Move into extension.
-  extensions?: Extension[];
-  editorMode?: EditorMode;
+  autofocus?: boolean;
+  multiline?: boolean;
+  scrollTo?: StateEffect<any>; // TODO(burdon): Restore scroll position: scrollTo EditorView.scrollSnapshot().
+  selection?: { anchor: number; head?: number };
+  editorMode?: EditorMode; // TODO(burdon): Factor out.
+  placeholder?: string;
+  theme?: ThemeStyles;
   slots?: TextEditorSlots;
+  extensions?: Extension[];
 };
 
 /**
  * Base text editor.
  */
 export const BaseTextEditor = forwardRef<EditorView, TextEditorProps>(
-  ({ model, focus, readonly, comments, extensions = [], editorMode, slots = defaultSlots }, forwardedRef) => {
+  (
+    { model, readonly, autofocus, scrollTo, selection, editorMode, theme, slots = defaultSlots, extensions = [] },
+    forwardedRef,
+  ) => {
     const tabsterDOMAttribute = useFocusableGroup({ tabBehavior: 'limited' });
     const { themeMode } = useThemeContext();
+
     const rootRef = useRef<HTMLDivElement>(null);
     const [view, setView] = useState<EditorView | null>(null);
-    // NOTE: This doesn't update useRef.
+
+    // The view ref can be used to focus the editor.
+    // NOTE: This does not cause the parent to re-render, so the ref is not available immediately.
     useImperativeHandle<EditorView | null, EditorView | null>(forwardedRef, () => view, [view]);
-    useEffect(() => {
-      if (focus && view) {
-        view.focus();
-      }
-    }, [focus, view]);
 
-    // TODO(burdon): Factor out as extension.
-    const { awareness, peer } = model;
+    // Set focus.
     useEffect(() => {
-      if (awareness && peer) {
-        awareness.setLocalStateField('user', {
-          name: peer.name ?? generateName(peer.id),
-          color: getColorForValue({ value: peer.id, type: 'color' }),
-          colorLight: getColorForValue({ value: peer.id, themeMode, type: 'highlight' }),
-        });
+      if (autofocus) {
+        view?.focus();
       }
-    }, [awareness, peer, themeMode]);
+    }, [view, autofocus]);
 
-    // TODO(burdon): Factor out as extension.
-    useEffect(() => {
-      if (view && comments?.length) {
-        view.dispatch({
-          effects: setCommentRange.of({ model, comments }),
-        });
-      }
-    }, [view, comments]);
+    // Monitor awareness.
+    useAwareness(model);
 
+    // Create editor state and view.
+    // The view is recreated if the model or extensions are changed.
     useEffect(() => {
       if (!model || !rootRef.current) {
         return;
       }
 
-      // TODO(burdon): Remember cursor position.
+      //
+      // EditorState
       // https://codemirror.net/docs/ref/#state.EditorStateConfig
+      //
       const state = EditorState.create({
         doc: model.text(),
+        selection,
         extensions: [
-          readonly && EditorState.readOnly.of(readonly),
-
-          // TODO(burdon): Factor out VIM mode? (manage via MarkdownPlugin).
-          editorMode === 'vim' && vim(),
+          // TODO(burdon): Doesn't catch errors in keymap functions.
+          EditorView.exceptionSink.of((err) => {
+            log.catch(err);
+          }),
 
           // Theme.
-          // TODO(burdon): Make theme configurable.
+          // TODO(burdon): Make configurable.
           EditorView.baseTheme(defaultTheme),
-          EditorView.theme(slots?.editor?.theme ?? {}),
+          EditorView.theme(theme ?? {}),
           EditorView.darkTheme.of(themeMode === 'dark'),
+          EditorView.editorAttributes.of({ class: slots.editor?.className ?? '' }),
+          EditorView.contentAttributes.of({ class: slots.content?.className ?? '' }),
+
+          // State.
+          EditorState.readOnly.of(!!readonly),
 
           // Storage and replication.
+          // NOTE: This must come before user extensions.
           model.extension,
 
+          // TODO(burdon): Factor out (requires special handling for Escape/focus).
+          editorMode === 'vim' && vim(),
+
           // Custom.
           ...extensions,
         ].filter(Boolean) as Extension[],
       });
 
-      // NOTE: This repaints the editor.
-      // 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();
+      //
+      // EditorView
+      // https://codemirror.net/docs/ref/#view.EditorViewConfig
+      //
       const newView = new EditorView({
-        parent: rootRef.current,
         state,
-        // NOTE: Uncomment to spy on all transactions.
+        parent: rootRef.current,
+        scrollTo,
+        // NOTE: Uncomment to debug/monitor all transactions.
         // https://codemirror.net/docs/ref/#view.EditorView.dispatch
-        // dispatch: (transaction, view) => {
-        //   view.update([transaction]);
-        // },
+        dispatchTransactions: (trs, view) => {
+          view.update(trs);
+          const debug = false;
+          if (debug) {
+            logChanges(trs);
+          }
+        },
       });
 
+      view?.destroy();
       setView(newView);
+
       return () => {
         newView?.destroy();
         setView(null);
       };
     }, [rootRef, model, readonly, editorMode, themeMode]);
 
+    // Handles tab/focus.
+    // Pressing Escape focuses the outer div (to support tab navigation); pressing Enter refocuses the editor.
     const handleKeyUp = useCallback(
       (event: KeyboardEvent) => {
         const { key, altKey, shiftKey, metaKey, ctrlKey } = event;
         switch (key) {
-          // TODO(burdon): ???
-          // case 'Enter': {
-          //   view?.contentDOM.focus();
-          //   break;
-          // }
+          case 'Enter': {
+            view?.focus();
+            break;
+          }
 
           case 'Escape': {
-            editorMode === 'vim' && (altKey || shiftKey || metaKey || ctrlKey) && rootRef.current?.focus();
+            if (editorMode === 'vim' && (altKey || shiftKey || metaKey || ctrlKey)) {
+              rootRef.current?.focus();
+            }
             break;
           }
         }
@@ -170,28 +190,28 @@ export const BaseTextEditor = forwardRef<EditorView, TextEditorProps>(
     return (
       <div
         key={model.id}
-        ref={rootRef}
+        role='none'
         tabIndex={0}
-        {...slots?.root}
-        {...(editorMode !== 'vim' && tabsterDOMAttribute)}
         onKeyUp={handleKeyUp}
+        {...slots.root}
+        {...(editorMode !== 'vim' && tabsterDOMAttribute)}
+        ref={rootRef}
       />
     );
   },
 );
 
+// TODO(burdon): Single-line/scroll.
 export const TextEditor = forwardRef<EditorView, TextEditorProps>(
-  ({ readonly, extensions = [], slots, ...props }, forwardedRef) => {
+  ({ readonly, placeholder, multiline, theme = textTheme, slots, extensions = [], ...props }, forwardedRef) => {
     const { themeMode } = useThemeContext();
     const updatedSlots = defaultsDeep({}, slots, defaultTextSlots);
     return (
       <BaseTextEditor
         ref={forwardedRef}
         readonly={readonly}
-        extensions={[
-          basicBundle({ readonly, themeMode, placeholder: updatedSlots?.editor?.placeholder }),
-          ...extensions,
-        ]}
+        extensions={[basicBundle({ themeMode, placeholder, multiline }), ...extensions]}
+        theme={theme}
         slots={updatedSlots}
         {...props}
       />
@@ -199,19 +219,16 @@ export const TextEditor = forwardRef<EditorView, TextEditorProps>(
   },
 );
 
-// TODO(burdon): Remove (Just provide bundle, slots).
 export const MarkdownEditor = forwardRef<EditorView, TextEditorProps>(
-  ({ readonly, extensions = [], slots, ...props }, forwardedRef) => {
+  ({ readonly, placeholder, theme = markdownTheme, slots, extensions = [], ...props }, forwardedRef) => {
     const { themeMode } = useThemeContext();
     const updatedSlots = defaultsDeep({}, slots, defaultMarkdownSlots);
     return (
       <BaseTextEditor
         ref={forwardedRef}
         readonly={readonly}
-        extensions={[
-          markdownBundle({ readonly, themeMode, placeholder: updatedSlots?.editor?.placeholder }),
-          ...extensions,
-        ]}
+        extensions={[markdownBundle({ themeMode, readonly, placeholder }), ...extensions]}
+        theme={theme}
         slots={updatedSlots}
         {...props}
       />
@@ -221,20 +238,18 @@ export const MarkdownEditor = forwardRef<EditorView, TextEditorProps>(
 
 export const defaultSlots: TextEditorSlots = {
   root: {
-    className: mx('p-2', inputSurface),
+    // TODO(burdon): Add focusRing by default/as property?
+    className: mx('flex flex-col grow overflow-y-auto', inputSurface),
+  },
+  editor: {
+    className: 'h-full p-2',
   },
 };
 
 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,357 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import '@dxosTheme';
+
+import { type EditorView, keymap } from '@codemirror/view';
+import { faker } from '@faker-js/faker';
+import { Check, Trash } from '@phosphor-icons/react';
+import React, { type FC, useEffect, useMemo, useRef, useState } from 'react';
+
+import { getTextContent, TextObject } from '@dxos/echo-schema';
+import { PublicKey } from '@dxos/keys';
+import { log } from '@dxos/log';
+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, setFocus, useComments } from '../../extensions';
+import { type Comment, type Range, useTextModel } from '../../hooks';
+
+faker.seed(101);
+
+//
+// Editor
+//
+
+const Editor: FC<{
+  item: { text: TextObject };
+  comments: Comment[];
+  selected?: string;
+  onCreateComment: CommentsOptions['onCreate'];
+  onDeleteComment: CommentsOptions['onDelete'];
+  onUpdateComment: CommentsOptions['onUpdate'];
+  onSelectComment: CommentsOptions['onSelect'];
+}> = ({
+  item,
+  selected: selectedValue,
+  comments: commentRanges,
+  onCreateComment,
+  onDeleteComment,
+  onUpdateComment,
+  onSelectComment,
+}) => {
+  const model = useTextModel({ text: item.text });
+  const view = useRef<EditorView>(null);
+  const [selected, setSelected] = useState<string>();
+  useEffect(() => {
+    if (!view.current?.hasFocus && selectedValue !== selected) {
+      setSelected(selectedValue);
+      if (selectedValue) {
+        setFocus(view.current!, selectedValue);
+      }
+    }
+  }, [selected, commentRanges, selectedValue]);
+
+  useComments(view.current, commentRanges);
+
+  const extensions = useMemo(() => {
+    return [
+      comments({
+        onCreate: onCreateComment,
+        onDelete: onDeleteComment,
+        onUpdate: onUpdateComment,
+        onSelect: onSelectComment,
+      }),
+    ];
+  }, []);
+
+  if (!model) {
+    return null;
+  }
+
+  // TODO(burdon): Highlight currently selected comment.
+  return (
+    <div className='flex grow overflow-y-scroll'>
+      <MarkdownEditor ref={view} model={model} extensions={extensions} />
+    </div>
+  );
+};
+
+//
+// Comments thread
+//
+
+type CommentThread = {
+  id: string;
+  cursor?: string;
+  range?: Range;
+  yPos?: number;
+  messages: TextObject[];
+};
+
+const Thread: FC<{
+  thread: CommentThread;
+  selected: boolean;
+  onSelect: () => void;
+  onResolve: () => void;
+}> = ({ thread, selected, onSelect, onResolve }) => {
+  const [focus, setFocus] = useState(false);
+  const [item, setItem] = useState({ text: new TextObject() });
+  const model = useTextModel({ text: item.text });
+  const editorRef = useRef<EditorView>(null);
+
+  const containerRef = useRef<HTMLDivElement>(null);
+  useEffect(() => {
+    if (selected) {
+      containerRef.current?.scrollIntoView({ block: 'center', behavior: 'smooth' });
+      if (thread.messages.length === 0) {
+        setFocus(true);
+      }
+    }
+  }, [selected]);
+
+  const handleCreateMessage = () => {
+    const text = model?.text().trim();
+    if (text?.length) {
+      thread.messages.push(item.text);
+      setItem({ text: new TextObject() });
+      setFocus(true);
+    }
+  };
+
+  if (!model) {
+    return null;
+  }
+
+  return (
+    <div
+      className={mx(
+        'flex flex-col m-1 rounded shadow divide-y bg-white',
+        selected && 'ring',
+        !thread.cursor && 'opacity-50',
+      )}
+    >
+      <div className='flex p-2 gap-2 items-center text-xs font-mono text-neutral-500 font-thin'>
+        <span>id:{thread.id.slice(0, 4)}</span>
+        <span>from:{thread.range?.from}</span>
+        <span>to:{thread.range?.to}</span>
+        <span>y:{thread.yPos}</span>
+        <span className='grow' />
+        {!thread.cursor && <Trash />}
+      </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()}>
+          {getTextContent(message)}
+        </div>
+      ))}
+
+      <div ref={containerRef} onClick={() => onSelect()} className='flex'>
+        <TextEditor
+          ref={editorRef}
+          autofocus={focus}
+          model={model}
+          placeholder={'Enter comment...'}
+          slots={{ root: { className: 'grow rounded-b' } }}
+          extensions={[
+            keymap.of([
+              {
+                key: 'Enter',
+                run: () => {
+                  handleCreateMessage();
+                  return true;
+                },
+              },
+            ]),
+          ]}
+        />
+        <Button variant='ghost' classNames='px-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'>
+        {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 [selected, setSelected] = useState<string>();
+
+  const comments = useMemo<Comment[]>(() => threads.map(({ id, cursor }) => ({ id, cursor })), [threads]);
+
+  // Filter by visibility.
+  const visibleThreads = useMemo(() => threads.filter((thread) => thread.yPos !== undefined), [threads]);
+
+  const handleCreateComment: CommentsOptions['onCreate'] = (cursor, location) => {
+    const id = PublicKey.random().toHex();
+    log.info('create', { id: id.slice(0, 4), cursor });
+    setThreads((threads) => [
+      ...threads,
+      {
+        id,
+        cursor,
+        yPos: location ? Math.floor(location.top) : undefined,
+        messages: autoCreate
+          ? faker.helpers.multiple(() => new TextObject(faker.lorem.sentence()), { count: { min: 1, max: 3 } })
+          : [],
+      },
+    ]);
+    setSelected(id);
+    return id;
+  };
+
+  const handleDeleteComment: CommentsOptions['onDelete'] = (id) => {
+    log.info('delete', { id: id.slice(0, 4) });
+    setThreads((threads) =>
+      threads.map((thread) => {
+        if (thread.id === id) {
+          thread.cursor = undefined;
+        }
+
+        return thread;
+      }),
+    );
+
+    setSelected((selected) => (selected === id ? undefined : selected));
+  };
+
+  const handleUpdateComment: CommentsOptions['onUpdate'] = (id, cursor) => {
+    log.info('update', { id: id.slice(0, 4), cursor });
+    setThreads((threads) =>
+      threads.map((thread) => {
+        if (thread.id === id) {
+          thread.cursor = cursor;
+        }
+
+        return thread;
+      }),
+    );
+  };
+
+  const handleSelectComment: CommentsOptions['onSelect'] = ({ comments, selection: { active, closest } }) => {
+    log.info('select', { active: active?.slice(0, 4), closest: closest?.slice(0, 4) });
+    setThreads((threads) =>
+      threads.map((thread) => {
+        const comment = comments.find(({ comment }) => comment.id === thread.id);
+        if (comment) {
+          thread.yPos = comment.location ? Math.floor(comment.location.top) : undefined;
+          thread.range = { from: comment.range.from, to: comment.range.to };
+        }
+
+        return thread;
+      }),
+    );
+
+    setSelected(active ?? closest);
+  };
+
+  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}
+            selected={selected}
+            comments={comments}
+            onCreateComment={handleCreateComment}
+            onDeleteComment={handleDeleteComment}
+            onUpdateComment={handleUpdateComment}
+            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 Testing = {
+  args: {
+    text: document,
+    autoCreate: true,
+  },
+};

package/src/extensions/autocomplete.ts

@@ -35,10 +35,13 @@ export const autocomplete = ({ onSearch }: AutocompleteOptions) => {
     // https://codemirror.net/examples/autocompletion
     // https://codemirror.net/docs/ref/#autocomplete.autocompletion
     autocompletion({
-      defaultKeymap: false,
+      activateOnTyping: true,
 
-      // Don't start unless key press.
-      activateOnTyping: false,
+      // closeOnBlur: false,
+      // defaultKeymap: false,
+
+      // TODO(burdon): Styles/fragments.
+      tooltipClass: () => 'shadow rounded',
     }),
 
     // TODO(burdon): Option to create new page?