@dxos/react-ui-editor 0.3.11-main.6f25445 → 0.3.11-main.73ee990

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); // 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,
+  },
+};

package/src/components/Toolbar/Toolbar.stories.tsx

@@ -0,0 +1,86 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import '@dxosTheme';
+
+import { faker } from '@faker-js/faker';
+import React, { type FC, useMemo, useState } from 'react';
+
+import { TextObject } from '@dxos/echo-schema';
+import { PublicKey } from '@dxos/keys';
+import { fixedInsetFlexLayout, groupSurface, mx } from '@dxos/react-ui-theme';
+import { withTheme } from '@dxos/storybook-utils';
+
+import { Toolbar } from './Toolbar';
+import { code, comments, formatting, heading, image, table, tasklist, useComments } from '../../extensions';
+import { type Comment, useActionHandler, useTextEditor, useTextModel } from '../../hooks';
+import { MarkdownEditor } from '../TextEditor';
+
+faker.seed(101);
+
+const Story: FC<{ content: string }> = ({ content }) => {
+  const [item] = useState({ text: new TextObject(content) });
+  const [_comments, setComments] = useState<Comment[]>([]);
+  const [editorRef, editorView] = useTextEditor();
+  const model = useTextModel({ text: item.text });
+  const extensions = useMemo(
+    () => [
+      code(),
+      comments({
+        onCreate: (cursor) => {
+          const id = PublicKey.random().toHex();
+          setComments((comments) => [...comments, { id, cursor }]);
+          return id;
+        },
+      }),
+      formatting(),
+      heading(),
+      image(),
+      table(),
+      tasklist(),
+    ],
+    [],
+  );
+
+  useComments(editorView, _comments);
+  const handleAction = useActionHandler(editorView);
+
+  if (!model) {
+    return null;
+  }
+
+  return (
+    <div className={mx(fixedInsetFlexLayout, groupSurface)}>
+      <div className='flex h-full justify-center'>
+        <div className='flex flex-col h-full w-[800px]'>
+          <Toolbar onAction={handleAction} />
+          <MarkdownEditor ref={editorRef} model={model} extensions={extensions} />
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export default {
+  title: 'react-ui-editor/Toolbar',
+  component: Toolbar,
+  render: (args: any) => <Story {...args} />,
+  decorators: [withTheme],
+};
+
+const content = [
+  'Demo',
+  '',
+  'The editor supports **Markdown** styles.',
+  '',
+  faker.lorem.paragraph({ min: 5, max: 8 }),
+  '',
+  '',
+].join('\n');
+
+export const Default = {
+  args: {
+    content,
+  },
+};

package/src/components/Toolbar/Toolbar.tsx

@@ -0,0 +1,115 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import {
+  type Icon,
+  At,
+  Brain,
+  CaretRight,
+  ChatText,
+  Code,
+  Image,
+  Link,
+  ListBullets,
+  ListChecks,
+  ListNumbers,
+  TextStrikethrough,
+  Table,
+  TextB,
+  TextItalic,
+} from '@phosphor-icons/react';
+import React, { type FC } from 'react';
+
+import { Button, type ButtonProps, DensityProvider, Select } from '@dxos/react-ui';
+import { getSize } from '@dxos/react-ui-theme';
+
+export type Action =
+  | 'blockquote'
+  | 'bold'
+  | 'code'
+  | 'comment'
+  | 'heading'
+  | 'image'
+  | 'italic'
+  | 'link'
+  | 'list'
+  | 'list-ordered'
+  | 'list-tasks'
+  | 'mention'
+  | 'prompt'
+  | 'strikethrough'
+  | 'table';
+
+export type ToolbarProps = {
+  onAction?: (action: { type: Action; data?: any }) => void;
+};
+
+const IconButton: FC<{ Icon: Icon; title: string } & NonNullable<Pick<ButtonProps, 'onClick'>>> = ({
+  Icon,
+  title,
+  onClick,
+}) => (
+  <Button variant='ghost' classNames='p-2' onClick={onClick} title={title}>
+    <Icon className={getSize(5)} />
+  </Button>
+);
+
+// TODO(burdon): Update state based on current selection?
+export const Toolbar = ({ onAction }: ToolbarProps) => {
+  return (
+    <DensityProvider density='fine'>
+      <div role='toolbar' className='flex w-full p-2 items-center gap-4'>
+        <div>
+          <Select.Root
+            defaultValue='0'
+            onValueChange={(value) => onAction?.({ type: 'heading', data: parseInt(value) })}
+          >
+            <Select.TriggerButton classNames='w-[8rem]' />
+            <Select.Portal>
+              <Select.Content>
+                <Select.Viewport>
+                  <Select.Option value='0'>Paragraph</Select.Option>
+                  {[1, 2, 3, 4, 5, 6].map((level) => (
+                    <Select.Option key={level} value={String(level)}>
+                      Heading {level}
+                    </Select.Option>
+                  ))}
+                </Select.Viewport>
+              </Select.Content>
+            </Select.Portal>
+          </Select.Root>
+        </div>
+        <div>
+          <IconButton Icon={TextB} title='Bold' onClick={() => onAction?.({ type: 'bold' })} />
+          <IconButton Icon={TextItalic} title='Italic' onClick={() => onAction?.({ type: 'italic' })} />
+          <IconButton
+            Icon={TextStrikethrough}
+            title='Strike-through'
+            onClick={() => onAction?.({ type: 'strikethrough' })}
+          />
+        </div>
+        <div>
+          <IconButton Icon={ListBullets} title='Bullet list' onClick={() => onAction?.({ type: 'list' })} />
+          <IconButton Icon={ListNumbers} title='Numbered list' onClick={() => onAction?.({ type: 'list-ordered' })} />
+          <IconButton Icon={ListChecks} title='Task list' onClick={() => onAction?.({ type: 'list-tasks' })} />
+        </div>
+        <div>
+          <IconButton Icon={CaretRight} title='Block quite' onClick={() => onAction?.({ type: 'blockquote' })} />
+          <IconButton Icon={Code} title='Code block' onClick={() => onAction?.({ type: 'code' })} />
+          <IconButton Icon={Table} title='Table' onClick={() => onAction?.({ type: 'table' })} />
+        </div>
+        <div>
+          <IconButton Icon={Link} title='Link' onClick={() => onAction?.({ type: 'link' })} />
+          <IconButton Icon={At} title='Mention' onClick={() => onAction?.({ type: 'mention' })} />
+          <IconButton Icon={Image} title='Image' onClick={() => onAction?.({ type: 'image' })} />
+        </div>
+        <div className='grow' />
+        <div>
+          <IconButton Icon={Brain} title='AI prompt' onClick={() => onAction?.({ type: 'prompt' })} />
+          <IconButton Icon={ChatText} title='Create comment' onClick={() => onAction?.({ type: 'comment' })} />
+        </div>
+      </div>
+    </DensityProvider>
+  );
+};

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,35 @@ 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.
+      activateOnTyping: true,
+
+      // closeOnBlur: 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): Styles/fragments.
+      tooltipClass: () => 'shadow rounded',
+    }),
+
+    // 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()),
+        };
+      },
     }),
   ];
 };