@dxos/react-ui-editor 0.3.11-main.c95bc86 → 0.3.11-main.cb5abf5

package/src/hooks/useTextModel.ts

@@ -3,18 +3,17 @@
 //
 
 import get from 'lodash.get';
-import { useEffect, useState } from 'react';
+import { type Dispatch, type SetStateAction, useEffect, useState } from 'react';
 
 import { generateName } from '@dxos/display-name';
 import { type AutomergeTextCompat, getRawDoc } from '@dxos/echo-schema';
 import { invariant } from '@dxos/invariant';
 import { isAutomergeObject, type Space, type TextObject } from '@dxos/react-client/echo';
 import { type Identity } from '@dxos/react-client/halo';
-import { isNotNullOrUndefined } from '@dxos/util';
 
 import { SpaceAwarenessProvider } from './awareness-provider';
 import { type EditorModel, modelState } from './defs';
-import { automerge, awareness, AwarenessProvider } from '../extensions';
+import { automerge, awareness } from '../extensions';
 import { cursorColor } from '../styles';
 
 // TODO(burdon): Remove space/identity dependency. Define interface for the framework re content and presence.
@@ -31,6 +30,22 @@ export const useTextModel = (props: UseTextModelProps): EditorModel | undefined
   return model;
 };
 
+/**
+ * For use primarily in stories & tests so the dependence on TextObject can be avoided.
+ * @param id
+ * @param defaultContent
+ */
+export const useInMemoryTextModel = ({
+  id,
+  defaultContent,
+}: {
+  id: string;
+  defaultContent?: string;
+}): EditorModel & { setContent: Dispatch<SetStateAction<string>> } => {
+  const [content, setContent] = useState(defaultContent ?? '');
+  return { id, content, setContent, text: () => content };
+};
+
 const createModel = ({ space, identity, text }: UseTextModelProps) => {
   invariant(isAutomergeObject(text));
   const obj = text as any as AutomergeTextCompat;
@@ -49,16 +64,20 @@ const createModel = ({ space, identity, text }: UseTextModelProps) => {
       peerId: identity?.identityKey.toHex() ?? 'Anonymous',
     });
 
+  const extensions = [
+    //
+    modelState.init(() => model),
+    automerge({ handle: doc.handle, path: doc.path }),
+  ];
+  if (awarenessProvider) {
+    extensions.push(awareness(awarenessProvider));
+  }
+
   const model: EditorModel = {
     id: obj.id,
     content: doc,
     text: () => get(doc.handle.docSync(), doc.path),
-    extension: [
-      modelState.init(() => model),
-      automerge({ handle: doc.handle, path: doc.path }),
-      awarenessProvider && AwarenessProvider.of(awarenessProvider),
-      awareness(),
-    ].filter(isNotNullOrUndefined),
+    extension: extensions,
     peer: identity
       ? {
           id: identity.identityKey.toHex(),

package/src/index.ts

@@ -5,7 +5,7 @@
 export { TextKind } from '@dxos/protocols/proto/dxos/echo/model/text';
 export { Doc, YText, YXmlFragment } from '@dxos/text-model';
 export { type Extension } from '@codemirror/state';
-export { type EditorView } from '@codemirror/view';
+export { type EditorView, keymap } from '@codemirror/view';
 
 export * from './components';
 export * from './extensions';

package/src/themes/default.ts

@@ -49,9 +49,11 @@ export const defaultTheme: ThemeStyles = {
   '&.cm-focused': {
     outline: 'none',
   },
+
   '.cm-scroller': {
-    overflow: 'visible',
+    // overflow: 'visible',
     fontFamily: get(tokens, 'fontFamily.mono', []).join(','),
+    lineHeight: 1.4,
   },
 
   '.cm-content': {
@@ -77,8 +79,11 @@ export const defaultTheme: ThemeStyles = {
   '&dark .cm-cursor, &dark .cm-dropCursor': {
     borderLeft: '2px solid white',
   },
-  '.cm-placeholder': {
-    fontWeight: 100,
+  '&light .cm-placeholder': {
+    color: get(tokens, 'extend.semanticColors.description.light', 'rgba(0,0,0,.2)'),
+  },
+  '&dark .cm-placeholder': {
+    color: get(tokens, 'extend.semanticColors.description.dark', 'rgba(255,255,255,.2)'),
   },
 
   //
@@ -88,7 +93,7 @@ export const defaultTheme: ThemeStyles = {
     paddingInline: 0,
   },
   '.cm-activeLine': {
-    background: 'inherit',
+    background: 'transparent',
   },
 
   //

package/dist/types/src/components/TextEditor/comments.stories.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"comments.stories.d.ts","sourceRoot":"","sources":["../../../../../src/components/TextEditor/comments.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,YAAY,CAAC;AAEpB,OAAO,EAAE,KAAK,UAAU,EAAU,MAAM,kBAAkB,CAAC;AAG3D,OAAO,KAAwD,MAAM,OAAO,CAAC;AA6M7E,KAAK,UAAU,GAAG;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;;;;;mBAoHe,UAAU;;AAJ3B,wBAKE;AAWF,eAAO,MAAM,OAAO;;;;CAInB,CAAC;AAEF,eAAO,MAAM,OAAO;;;;;CAKnB,CAAC"}

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

@@ -1,357 +0,0 @@
-//
-// 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); // TODO(burdon): Not required.
-    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: { current, closest } }) => {
-    log.info('select', { active: current?.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(current ?? 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,
-  },
-};