@dxos/react-ui-editor 0.3.10-main.5c4230b → 0.3.10-main.5e11230

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

@@ -0,0 +1,350 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import '@dxosTheme';
+
+import { EditorView } from '@codemirror/view';
+import { faker } from '@faker-js/faker';
+import { ArrowSquareOut } from '@phosphor-icons/react';
+import defaultsDeep from 'lodash.defaultsdeep';
+import React, { StrictMode, useRef, useState } from 'react';
+import { createRoot } from 'react-dom/client';
+
+import { TextObject } from '@dxos/echo-schema';
+import { PublicKey } from '@dxos/keys';
+import { fixedInsetFlexLayout, getSize, groupSurface, mx } from '@dxos/react-ui-theme';
+import { withTheme } from '@dxos/storybook-utils';
+
+import { MarkdownEditor, type TextEditorProps, type TextEditorRef } from './TextEditor';
+import {
+  autocomplete,
+  listener,
+  link,
+  tasklist,
+  tooltip,
+  type TooltipOptions,
+  type LinkOptions,
+  comments,
+  table,
+  image,
+  mention,
+  blast,
+  demo,
+  defaultOptions,
+} from './extensions';
+import { useTextModel } from '../../hooks';
+
+const str = (...lines: string[]) => lines.join('\n');
+
+const num = () => faker.number.int({ min: 0, max: 9999 }).toLocaleString();
+
+// prettier-ignore
+const text = {
+  tasks: str(
+    '## Tasks',
+    '',
+    '- [x] decorator',
+    '- [ ] checkbox',
+    '  - [ ] state',
+    '  - [ ] indent',
+    '  - [x] style',
+  ),
+
+  list: str(
+    '## List',
+    '',
+    '- new york',
+    '- london',
+    '- tokyo',
+  ),
+
+  numbered: str(
+    '## Numbered',
+    '',
+    '1. one',
+    '2. two',
+    '3. three',
+    ''
+  ),
+
+  code: str(
+    '## Code',
+    '',
+    '```',
+    'const x = 100;',
+    '```',
+    '',
+    '```tsx',
+    'const Component = () => {',
+    '  const x = 100;',
+    '  return () => <div>Test</div>;',
+    '};',
+    '',
+    '```'
+  ),
+
+  links: str(
+    '## Links',
+    '',
+    'This is a naked link https://dxos.org within a sentence.',
+    '',
+    'Take a look at [DXOS](https://dxos.org) and how to [get started](https://docs.dxos.org/guide/getting-started.html).',
+    '',
+  ),
+
+  table: str(
+    '# Table',
+    '',
+    `| ${faker.lorem.word()} | ${faker.lorem.word()} | ${faker.lorem.word()} |`,
+    '|---|---|---|',
+    `| ${num()} | ${num()} | ${num()} |`,
+    `| ${num()} | ${num()} | ${num()} |`,
+    `| ${num()} | ${num()} | ${num()} |`,
+    '', // TODO(burdon): Possible GFM parsing bug if no newline?
+  ),
+
+  image: str('# Image', '', '![dxos](https://pbs.twimg.com/profile_banners/1268328127673044992/1684766689/1500x500)'),
+
+  headings: str(
+    ...[1, 2, 3, 4, 5, 6].map((level) => ['#'.repeat(level) + ` Heading ${level}`, faker.lorem.sentences(), '']).flat(),
+  ),
+
+  paragraphs: str(...faker.helpers.multiple(() => [faker.lorem.paragraph(), ''], { count: 3 }).flat()),
+};
+
+const document = str(
+  '# Markdown',
+  '',
+  '> This is a block quote.',
+  '',
+  'This is all about https://dxos.org and related technologies.',
+  '',
+  'This this is **bold**, ~~strikethrough~~, _italic_, and `f(INLINE)`.',
+  '',
+  '---',
+  text.links,
+  '---',
+  text.list,
+  '---',
+  text.tasks,
+  '---',
+  text.numbered,
+  '---',
+  text.code,
+  '---',
+  text.headings,
+  '---',
+  text.table,
+  '---',
+  text.image,
+  '',
+);
+
+const links = [
+  { label: 'DXOS', apply: '[DXOS](https://dxos.org)' },
+  { label: 'GitHub', apply: '[DXOS GitHub](https://github.com/dxos)' },
+  { label: 'Automerge', apply: '[Automerge](https://automerge.org/)' },
+  { label: 'IPFS', apply: '[Protocol Labs](https://docs.ipfs.tech)' },
+  { label: 'StackEdit', apply: '[StackEdit](https://stackedit.io/app)' },
+];
+
+const hover =
+  'rounded-sm text-base text-primary-600 hover:text-primary-500 dark:text-primary-300 hover:dark:text-primary-200';
+
+const onHover: TooltipOptions['onHover'] = (el, url) => {
+  const web = new URL(url);
+  createRoot(el).render(
+    <StrictMode>
+      <a href={url} target='_blank' rel='noreferrer' className={hover}>
+        {web.origin}
+        <ArrowSquareOut weight='bold' className={mx(getSize(4), 'inline-block leading-none mis-1')} />
+      </a>
+    </StrictMode>,
+  );
+};
+
+const onRender: LinkOptions['onRender'] = (el, url) => {
+  createRoot(el).render(
+    <StrictMode>
+      <a href={url} target='_blank' rel='noreferrer' className={hover}>
+        <ArrowSquareOut weight='bold' className={mx(getSize(4), 'inline-block leading-none mis-1 mb-1')} />
+      </a>
+    </StrictMode>,
+  );
+};
+
+const Story = ({
+  text,
+  automerge,
+  ...props
+}: { text?: string; automerge?: boolean } & Pick<TextEditorProps, 'readonly' | 'extensions' | 'slots'>) => {
+  const ref = useRef<TextEditorRef>(null);
+  const [item] = useState({ text: new TextObject(text, undefined, undefined, { useAutomergeBackend: automerge }) });
+  const model = useTextModel({ text: item.text });
+  if (!model) {
+    return null;
+  }
+
+  return (
+    <div className={mx(fixedInsetFlexLayout, groupSurface)}>
+      <div className='flex justify-center overflow-y-scroll'>
+        <div className='flex flex-col w-[800px] py-16'>
+          <MarkdownEditor ref={ref} model={model} {...props} />
+          <div className='flex shrink-0 h-[300px]'></div>
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export default {
+  title: 'react-ui-editor/MarkdownEditor',
+  component: MarkdownEditor,
+  decorators: [withTheme],
+  render: Story,
+};
+
+const extensions = [
+  link({ onRender }),
+  tooltip({ onHover }),
+  tasklist(),
+  table(),
+  image(),
+  autocomplete({
+    onSearch: (text) => links.filter(({ label }) => label.toLowerCase().includes(text.toLowerCase())),
+  }),
+];
+
+export const Default = {
+  render: () => <Story text={document} extensions={extensions} />,
+};
+
+export const Readonly = {
+  render: () => <Story text={document} extensions={extensions} readonly />,
+};
+
+export const Simple = {
+  render: () => <Story text={document} />,
+};
+
+export const Tooltips = {
+  render: () => <Story text={str(text.links, '')} extensions={[tooltip({ onHover })]} />,
+};
+
+export const Links = {
+  render: () => <Story text={str(text.links, '')} extensions={[link({ onRender })]} />,
+};
+
+export const Table = {
+  render: () => <Story text={str(text.table, '')} extensions={[table()]} />,
+};
+
+export const Image = {
+  render: () => <Story text={str(text.image, '', '')} readonly extensions={[image()]} />,
+};
+
+export const TaskList = {
+  render: () => (
+    <Story
+      text={str(text.tasks, '', text.list)}
+      extensions={[
+        tasklist(),
+        listener({
+          onChange: (text) => {
+            console.log(text);
+          },
+        }),
+      ]}
+    />
+  ),
+};
+
+export const Autocomplete = {
+  render: () => (
+    <Story
+      text={str('# Autocomplete', '', '', '', '', '', '')}
+      extensions={[
+        link({ onRender }),
+        autocomplete({
+          onSearch: (text) => links.filter(({ label }) => label.toLowerCase().includes(text.toLowerCase())),
+        }),
+      ]}
+    />
+  ),
+};
+
+const names = ['adam', 'alice', 'alison', 'bob', 'carol', 'charlie', 'sayuri', 'shoko'];
+
+export const Mention = {
+  render: () => (
+    <Story
+      text={str('# Mention', '', '', '', '', '', '')}
+      extensions={[
+        mention({
+          onSearch: (text) => names.filter((name) => name.toLowerCase().startsWith(text.toLowerCase())),
+        }),
+      ]}
+    />
+  ),
+};
+
+const mark = () => `[^${PublicKey.random().toHex()}]`;
+export const Comments = {
+  render: () => (
+    <Story
+      text={str(mark(), '', text.paragraphs, mark(), '', mark(), '')}
+      extensions={[
+        comments({
+          onCreate: () => PublicKey.random().toHex(),
+          onUpdate: (info) => {
+            console.log('update', info);
+          },
+        }),
+      ]}
+    />
+  ),
+};
+
+export const Diagnostics = {
+  render: () => (
+    <Story
+      text={document}
+      extensions={[
+        // Cursor moved.
+        EditorView.updateListener.of((update) => {
+          console.log('update', update.view.state.selection.main.head);
+        }),
+      ]}
+    />
+  ),
+};
+
+export const Demo = {
+  render: () => <Story text={text.paragraphs} extensions={[demo()]} />,
+};
+
+export const Blast = {
+  render: () => (
+    <Story
+      text={str(text.paragraphs, text.code, text.paragraphs)}
+      extensions={[
+        demo({
+          items: localStorage.getItem('dxos.composer.extension.demo')?.split(','),
+        }),
+        blast(
+          defaultsDeep(
+            {
+              effect: 2,
+              particleGravity: 0.2,
+              particleShrinkRate: 0.995,
+              color: () => [faker.number.int({ min: 100, max: 200 }), 0, 0],
+              // color: () => [faker.number.int(256), faker.number.int(256), faker.number.int(256)],
+            },
+            defaultOptions,
+          ),
+        ),
+      ]}
+    />
+  ),
+};

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

@@ -3,63 +3,46 @@
 //
 
 import '@dxosTheme';
-import { markdown } from '@codemirror/lang-markdown';
-import { ArrowCircleUp } from '@phosphor-icons/react';
-import React, { StrictMode, useState } from 'react';
-import { createRoot } from 'react-dom/client';
+
+import defaultsDeep from 'lodash.defaultsdeep';
+import React, { useRef, useState } from 'react';
 
 import { TextObject } from '@dxos/echo-schema';
-import { fixedInsetFlexLayout, getSize, groupSurface, inputSurface, mx } from '@dxos/react-ui-theme';
+import { fixedInsetFlexLayout, groupSurface, mx } from '@dxos/react-ui-theme';
 import { withTheme } from '@dxos/storybook-utils';
 
-import { TextEditor } from './TextEditor';
-import { createHyperlinkTooltip, hyperlinkDecoration } from './extensions';
+import { defaultSlots, TextEditor, type TextEditorProps, type TextEditorRef, type TextEditorSlots } from './TextEditor';
+import { textTheme } from './themes';
 import { useTextModel } from '../../hooks';
 
-const text = [
-  '',
-  '',
-  'This is all about [DXOS](https://dxos.org); read more [here](https://docs.dxos.org/guide/getting-started.html).',
+const initialText = [
+  '# TextEditor',
   '',
+  'This is the basic plain text editor within minimal formatting.',
+  'You can add custom styles and create custom extensions.',
+  'Or use the MarkdownEditor to edit documents.',
   '',
+  'https://dxos.org',
 ].join('\n');
 
-const hyperLinkTooltip = () =>
-  createHyperlinkTooltip((el, url) => {
-    const web = new URL(url);
-    createRoot(el).render(
-      <StrictMode>
-        <div className='flex gap-1 items-center'>
-          <ArrowCircleUp className={mx(getSize(6), 'text-blue-500')} />
-          <p className='pr-1'>{web.origin}</p>
-        </div>
-      </StrictMode>,
-    );
-  });
-
-const Story = ({ automerge }: { automerge?: boolean }) => {
-  const [item] = useState({ text: new TextObject(text, undefined, undefined, { useAutomergeBackend: !!automerge }) });
+const Story = ({
+  text,
+  automerge,
+  ...props
+}: { text?: string; automerge?: boolean } & Pick<TextEditorProps, 'extensions' | 'slots'>) => {
+  const ref = useRef<TextEditorRef>(null);
+  const [item] = useState({ text: new TextObject(text, undefined, undefined, { useAutomergeBackend: automerge }) });
   const model = useTextModel({ text: item.text });
   if (!model) {
-    return <></>;
+    return null;
   }
 
   return (
     <div className={mx(fixedInsetFlexLayout, groupSurface)}>
-      <div className='flex justify-center p-8'>
-        <div className='w-[800px]'>
-          <TextEditor
-            model={model}
-            extensions={[
-              markdown(),
-              hyperlinkDecoration({ link: false }),
-              hyperLinkTooltip(),
-              // EditorView.domEventHandlers({
-              //   mousedown: (e, view) => {},
-              // }),
-            ]}
-            slots={{ root: { className: mx(inputSurface, 'p-2') } }}
-          />
+      <div className='flex justify-center overflow-y-scroll'>
+        <div className='flex flex-col w-[800px] py-16'>
+          <TextEditor ref={ref} model={model} {...props} />
+          <div className='flex shrink-0 h-[300px]'></div>
         </div>
       </div>
     </div>
@@ -67,13 +50,33 @@ const Story = ({ automerge }: { automerge?: boolean }) => {
 };
 
 export default {
+  title: 'react-ui-editor/TextEditor',
   component: TextEditor,
   decorators: [withTheme],
   render: Story,
 };
 
-export const Default = {};
+export const Default = {
+  render: () => (
+    <Story
+      text={initialText}
+      slots={defaultsDeep(
+        { editor: { theme: textTheme, placeholder: 'Enter text...' } } satisfies TextEditorSlots,
+        defaultSlots,
+      )}
+    />
+  ),
+};
 
 export const Automerge = {
-  render: () => <Story automerge />,
+  render: () => (
+    <Story
+      text={initialText}
+      slots={defaultsDeep(
+        { editor: { theme: textTheme, placeholder: 'Enter text...' } } satisfies TextEditorSlots,
+        defaultSlots,
+      )}
+      automerge
+    />
+  ),
 };

package/src/components/TextEditor/TextEditor.tsx

@@ -7,23 +7,24 @@ import { EditorView } from '@codemirror/view';
 import { useFocusableGroup } from '@fluentui/react-tabster';
 import { vim } from '@replit/codemirror-vim';
 import defaultsDeep from 'lodash.defaultsdeep';
-import get from 'lodash.get';
 import React, {
+  type ComponentProps,
   type KeyboardEvent,
   forwardRef,
   useCallback,
   useEffect,
   useImperativeHandle,
   useState,
-  type ComponentProps,
 } from 'react';
 
-import { isDocAccessor } from '@dxos/echo-schema';
+import { generateName } from '@dxos/display-name';
 import { useThemeContext } from '@dxos/react-ui';
+import { getColorForValue, inputSurface, mx } from '@dxos/react-ui-theme';
 
-import { basicBundle, basicTheme, markdownBundle, markdownTheme } from './extensions';
-import { type EditorModel, useCollaboration } from '../../hooks';
-import type { ThemeStyles } from '../../styles';
+import { basicBundle, markdownBundle } from './extensions';
+import { defaultTheme, markdownTheme, textTheme } from './themes';
+import { type EditorModel } from '../../hooks';
+import { type ThemeStyles } from '../../styles';
 
 export const EditorModes = ['default', 'vim'] as const;
 export type EditorMode = (typeof EditorModes)[number];
@@ -37,7 +38,7 @@ export type CursorInfo = {
 };
 
 export type TextEditorRef = {
-  editor: HTMLDivElement | null;
+  root: HTMLDivElement | null;
   state?: EditorState;
   view?: EditorView;
 };
@@ -55,9 +56,10 @@ export type TextEditorSlots = {
 
 export type TextEditorProps = {
   model: EditorModel;
+  readonly?: boolean;
+  editorMode?: EditorMode;
   extensions?: Extension[];
   slots?: TextEditorSlots;
-  editorMode?: EditorMode;
 };
 
 /**
@@ -65,66 +67,68 @@ export type TextEditorProps = {
  * NOTE: Rather than adding properties, try to create extensions that can be reused.
  */
 export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
-  ({ model, extensions = [], slots, editorMode }, forwardedRef) => {
+  ({ model, readonly, editorMode, extensions = [], slots = defaultSlots }, forwardedRef) => {
     const { themeMode } = useThemeContext();
     const tabsterDOMAttribute = useFocusableGroup({ tabBehavior: 'limited' });
 
-    const [parent, setParent] = useState<HTMLDivElement | null>(null);
+    const [root, setRoot] = useState<HTMLDivElement | null>(null);
     const [state, setState] = useState<EditorState>();
     const [view, setView] = useState<EditorView>();
-    useImperativeHandle(
-      forwardedRef,
-      () => ({
-        editor: parent,
-        state,
-        view,
-      }),
-      [view, state, parent],
-    );
+    useImperativeHandle(forwardedRef, () => ({ root, state, view }), [view, state, root]);
 
-    // TODO(burdon): Pass in extension?
-    const collaboration = useCollaboration(model, themeMode);
+    // TODO(burdon): Factor out?
+    const { awareness, peer } = model;
+    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' }),
+        });
+      }
+    }, [awareness, peer, themeMode]);
 
     useEffect(() => {
-      if (!parent) {
+      if (!root) {
         return;
       }
 
-      const initialText = isDocAccessor(model.content)
-        ? get(model.content.handle.docSync(), model.content.path)
-        : model.content?.toString();
-
       const state = EditorState.create({
-        doc: initialText,
+        doc: model.text(),
         extensions: [
+          readonly && EditorState.readOnly.of(readonly),
+
           // TODO(burdon): Factor out VIM mode?
           editorMode === 'vim' && vim(),
 
-          // Replication.
-          collaboration,
-
           // Theme.
-          slots?.editor?.theme && EditorView.theme(slots?.editor?.theme),
+          // TODO(burdon): Make optional.
+          EditorView.baseTheme(defaultTheme),
+          EditorView.theme(slots?.editor?.theme ?? {}),
+          // TODO(burdon): themeMode doesn't change in storybooks.
+          EditorView.darkTheme.of(themeMode === 'dark'),
+
+          // Storage and replication.
+          model.extension,
 
           // Custom.
           ...extensions,
         ].filter(Boolean) as Extension[],
       });
 
-      setState(state);
-
       // 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 be hit except when changing between text objects.
       view?.destroy();
-      setView(new EditorView({ state, parent }));
+      setView(new EditorView({ state, parent: root }));
+      setState(state);
 
       return () => {
         view?.destroy();
         setView(undefined);
         setState(undefined);
       };
-    }, [parent, model.content, themeMode, editorMode]);
+    }, [root, model, themeMode, readonly, editorMode]);
 
     const handleKeyUp = useCallback(
       (event: KeyboardEvent) => {
@@ -136,7 +140,7 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
           }
 
           case 'Escape': {
-            editorMode === 'vim' && (altKey || shiftKey || metaKey || ctrlKey) && parent?.focus();
+            editorMode === 'vim' && (altKey || shiftKey || metaKey || ctrlKey) && root?.focus();
             break;
           }
         }
@@ -147,7 +151,7 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
     return (
       <div
         key={model.id}
-        ref={setParent}
+        ref={setRoot}
         tabIndex={0}
         {...slots?.root}
         {...(editorMode !== 'vim' && tabsterDOMAttribute)}
@@ -158,14 +162,15 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
 );
 
 export const TextEditor = forwardRef<TextEditorRef, TextEditorProps>(
-  ({ extensions: _extensions, slots, ...props }, forwardedRef) => {
+  ({ readonly, extensions = [], slots: _slots, ...props }, forwardedRef) => {
     const { themeMode } = useThemeContext();
-    const extensions = [...(_extensions ?? []), basicBundle({ themeMode, placeholder: slots?.editor?.placeholder })];
+    const slots = defaultsDeep({}, _slots, defaultTextSlots);
     return (
       <BaseTextEditor
         ref={forwardedRef}
-        extensions={extensions}
-        slots={defaultsDeep({}, slots, { editor: { theme: basicTheme } })}
+        readonly={readonly}
+        extensions={[basicBundle({ readonly, themeMode, placeholder: slots?.editor?.placeholder }), ...extensions]}
+        slots={slots}
         {...props}
       />
     );
@@ -173,16 +178,37 @@ export const TextEditor = forwardRef<TextEditorRef, TextEditorProps>(
 );
 
 export const MarkdownEditor = forwardRef<TextEditorRef, TextEditorProps>(
-  ({ extensions: _extensions, slots, ...props }, forwardedRef) => {
+  ({ readonly, extensions = [], slots: _slots, ...props }, forwardedRef) => {
     const { themeMode } = useThemeContext();
-    const extensions = [...(_extensions ?? []), markdownBundle({ themeMode })];
+    const slots = defaultsDeep({}, _slots, defaultMarkdownSlots);
     return (
       <BaseTextEditor
         ref={forwardedRef}
-        extensions={extensions}
-        slots={defaultsDeep({}, slots, { editor: { theme: markdownTheme } })}
+        readonly={readonly}
+        extensions={[markdownBundle({ readonly, themeMode, placeholder: slots?.editor?.placeholder }), ...extensions]}
+        slots={slots}
         {...props}
       />
     );
   },
 );
+
+export const defaultSlots: TextEditorSlots = {
+  root: {
+    className: mx('p-2', inputSurface),
+  },
+};
+
+export const defaultTextSlots: TextEditorSlots = {
+  ...defaultSlots,
+  editor: {
+    theme: textTheme,
+  },
+};
+
+export const defaultMarkdownSlots: TextEditorSlots = {
+  ...defaultSlots,
+  editor: {
+    theme: markdownTheme,
+  },
+};