@dxos/react-ui-editor 0.4.8-main.eb5ae94 → 0.4.8-main.fff1521

package/dist/types/src/translations.d.ts

@@ -13,6 +13,7 @@ declare const _default: {
             'blockquote label': string;
             'codeblock label': string;
             'comment label': string;
+            'image label': string;
             'heading label': string;
             'table label': string;
         };

package/dist/types/src/translations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../src/translations.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,cAAc,oBAAoB,CAAC;;;;;;;;;;;;;;;;;;;;AAEhD,wBAoBE"}
+{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../src/translations.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,cAAc,oBAAoB,CAAC;;;;;;;;;;;;;;;;;;;;;AAEhD,wBAqBE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-ui-editor",
-  "version": "0.4.8-main.eb5ae94",
+  "version": "0.4.8-main.fff1521",
   "description": "Document editing experience within a DXOS shell.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -36,21 +36,22 @@
     "lodash.get": "^4.4.2",
     "lodash.pick": "^4.4.0",
     "lodash.sortby": "^4.7.0",
+    "react-dropzone": "^14.2.3",
     "style-mod": "^4.1.0",
-    "@dxos/async": "0.4.8-main.eb5ae94",
-    "@dxos/automerge": "0.4.8-main.eb5ae94",
-    "@dxos/context": "0.4.8-main.eb5ae94",
-    "@dxos/display-name": "0.4.8-main.eb5ae94",
-    "@dxos/debug": "0.4.8-main.eb5ae94",
-    "@dxos/invariant": "0.4.8-main.eb5ae94",
-    "@dxos/echo-schema": "0.4.8-main.eb5ae94",
-    "@dxos/log": "0.4.8-main.eb5ae94",
-    "@dxos/protocols": "0.4.8-main.eb5ae94",
-    "@dxos/react-async": "0.4.8-main.eb5ae94",
-    "@dxos/react-ui-theme": "0.4.8-main.eb5ae94",
-    "@dxos/react-ui": "0.4.8-main.eb5ae94",
-    "@dxos/text-model": "0.4.8-main.eb5ae94",
-    "@dxos/util": "0.4.8-main.eb5ae94"
+    "@dxos/async": "0.4.8-main.fff1521",
+    "@dxos/automerge": "0.4.8-main.fff1521",
+    "@dxos/debug": "0.4.8-main.fff1521",
+    "@dxos/display-name": "0.4.8-main.fff1521",
+    "@dxos/invariant": "0.4.8-main.fff1521",
+    "@dxos/context": "0.4.8-main.fff1521",
+    "@dxos/echo-schema": "0.4.8-main.fff1521",
+    "@dxos/log": "0.4.8-main.fff1521",
+    "@dxos/protocols": "0.4.8-main.fff1521",
+    "@dxos/react-ui": "0.4.8-main.fff1521",
+    "@dxos/react-async": "0.4.8-main.fff1521",
+    "@dxos/text-model": "0.4.8-main.fff1521",
+    "@dxos/util": "0.4.8-main.fff1521",
+    "@dxos/react-ui-theme": "0.4.8-main.fff1521"
   },
   "devDependencies": {
     "@automerge/automerge-repo-network-broadcastchannel": "^1.1.1",
@@ -68,7 +69,6 @@
     "@types/react-test-renderer": "^17.0.2",
     "@vitest/browser": "^1.3.1",
     "@vitest/ui": "^1.3.1",
-    "deepsignal": "^1.5.0",
     "happy-dom": "^13.3.1",
     "jsdom": "^20.0.1",
     "react": "^18.2.0",
@@ -78,22 +78,20 @@
     "vite-plugin-top-level-await": "^1.4.1",
     "vite-plugin-wasm": "^3.3.0",
     "vitest": "^1.3.1",
-    "@dxos/config": "0.4.8-main.eb5ae94",
-    "@dxos/echo-typegen": "0.4.8-main.eb5ae94",
-    "@dxos/keyboard": "0.4.8-main.eb5ae94",
-    "@dxos/echo-signals": "0.4.8-main.eb5ae94",
-    "@dxos/random": "0.4.8-main.eb5ae94",
-    "@dxos/react-client": "0.4.8-main.eb5ae94",
-    "@dxos/storybook-utils": "0.4.8-main.eb5ae94",
-    "@dxos/react-ui": "0.4.8-main.eb5ae94"
+    "@dxos/echo-signals": "0.4.8-main.fff1521",
+    "@dxos/config": "0.4.8-main.fff1521",
+    "@dxos/echo-typegen": "0.4.8-main.fff1521",
+    "@dxos/random": "0.4.8-main.fff1521",
+    "@dxos/keyboard": "0.4.8-main.fff1521",
+    "@dxos/react-ui": "0.4.8-main.fff1521",
+    "@dxos/react-client": "0.4.8-main.fff1521",
+    "@dxos/storybook-utils": "0.4.8-main.fff1521"
   },
   "peerDependencies": {
     "@phosphor-icons/react": "^2.0.5",
-    "@vitest/browser": "^1.3.1",
-    "@vitest/ui": "^1.3.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "@dxos/react-client": "0.4.8-main.eb5ae94"
+    "@dxos/react-client": "0.4.8-main.fff1521"
   },
   "publishConfig": {
     "access": "public"

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

@@ -4,45 +4,283 @@
 
 import '@dxosTheme';
 
-import React, { useState } from 'react';
+import { ArrowSquareOut, X } from '@phosphor-icons/react';
+import { type EditorView } from 'codemirror';
+import defaultsDeep from 'lodash.defaultsdeep';
+import React, { type FC, type KeyboardEvent, StrictMode, useMemo, useRef, useState } from 'react';
+import { createRoot } from 'react-dom/client';
 
 import { TextObject } from '@dxos/echo-schema';
-import { mx, textBlockWidth } from '@dxos/react-ui-theme';
+import { keySymbols, parseShortcut } from '@dxos/keyboard';
+import { PublicKey } from '@dxos/keys';
+import { faker } from '@dxos/random';
+import { Button, DensityProvider, Input, ThemeProvider, useThemeContext } from '@dxos/react-ui';
+import { baseSurface, defaultTx, getSize, mx, textBlockWidth } from '@dxos/react-ui-theme';
 import { withTheme } from '@dxos/storybook-utils';
 
 import { TextEditor, type TextEditorProps } from './TextEditor';
-import { useTextModel } from '../../hooks';
+import {
+  EditorModes,
+  annotations,
+  autocomplete,
+  blast,
+  command,
+  comments,
+  createBasicExtensions,
+  createDataExtensions,
+  createMarkdownExtensions,
+  createThemeExtensions,
+  decorateMarkdown,
+  defaultOptions,
+  dnd,
+  formattingKeymap,
+  image,
+  linkTooltip,
+  listener,
+  mention,
+  state,
+  table,
+  typewriter,
+  useComments,
+  type CommandAction,
+  type CommandOptions,
+  type Comment,
+  type CommentsOptions,
+  type SelectionState,
+} from '../../extensions';
+import { useDocAccessor } from '../../hooks';
 import translations from '../../translations';
 
-const initialText = [
-  '# TextEditor',
+faker.seed(101);
+
+const str = (...lines: string[]) => lines.join('\n');
+
+const num = () => faker.number.int({ min: 0, max: 9999 }).toLocaleString();
+
+const img = '![dxos](https://pbs.twimg.com/profile_banners/1268328127673044992/1684766689/1500x500)';
+
+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',
+    '',
+    '```',
+    '$ ls -las',
+    '```',
+    '',
+    '```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().padStart(12)} | ${faker.lorem.word().padStart(12)} | ${faker.lorem.word().padStart(12)} |`,
+    `|-${''.padStart(12, '-')}-|-${''.padStart(12, '-')}-|-${''.padStart(12, '-')}-|`,
+    `| ${num().padStart(12)} | ${num().padStart(12)} | ${num().padStart(12)} |`,
+    `| ${num().padStart(12)} | ${num().padStart(12)} | ${num().padStart(12)} |`,
+    `| ${num().padStart(12)} | ${num().padStart(12)} | ${num().padStart(12)} |`,
+    '',
+  ),
+
+  image: str('# Image', '', img),
+
+  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()),
+
+  footer: str('', '', '', '', ''),
+};
+
+const document = str(
+  '# Markdown',
+  '',
+  '> This is a block quote.',
+  '',
+  '> This is a long wrapping block quote. Neque reiciendis ullam quae error labore sit, at, et, nulla, aut at nostrum omnis quas nostrum, at consectetur vitae eos asperiores non omnis ullam in beatae at vitae deserunt asperiores sapiente.',
   '',
-  '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.',
+  '> This is',
+  '> a multi-line',
+  '> block quote.',
   '',
-  'https://dxos.org',
-].join('\n');
+  '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,
+  text.footer,
+);
+
+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 names = ['adam', 'alice', 'alison', 'bob', 'carol', 'charlie', 'sayuri', 'shoko'];
+
+const hover =
+  'rounded-sm text-base text-primary-600 hover:text-primary-500 dark:text-primary-300 hover:dark:text-primary-200';
+
+const renderLinkTooltip = (el: Element, url: string) => {
+  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 Key: FC<{ char: string }> = ({ char }) => (
+  <span className='flex justify-center items-center w-[24px] h-[24px] rounded text-xs bg-neutral-200 text-black'>
+    {char}
+  </span>
+);
+
+const onCommentsHover: CommentsOptions['onHover'] = (el, shortcut) => {
+  createRoot(el).render(
+    <StrictMode>
+      <div className='flex items-center gap-2 px-2 py-2 bg-neutral-700 text-white text-xs rounded'>
+        <div>Create comment</div>
+        <div className='flex gap-1'>
+          {keySymbols(parseShortcut(shortcut)).map((char) => (
+            <Key key={char} char={char} />
+          ))}
+        </div>
+      </div>
+    </StrictMode>,
+  );
+};
+
+const renderLinkButton = (el: Element, url: string) => {
+  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-[2px]')} />
+      </a>
+    </StrictMode>,
+  );
+};
+
+//
+// Story
+//
+
+type StoryProps = {
+  id?: string;
+  text?: string;
+  comments?: Comment[];
+  readonly?: boolean;
+  placeholder?: string;
+} & Pick<TextEditorProps, 'extensions'>;
 
 const Story = ({
+  id = 'editor-' + PublicKey.random().toHex().slice(0, 8),
   text,
-  automerge,
+  comments,
+  extensions: _extensions = [],
+  readonly,
+  placeholder = 'New document.',
   ...props
-}: { text?: string; automerge?: boolean } & Pick<TextEditorProps, 'extensions' | 'placeholder' | 'slots'>) => {
-  const [item] = useState({ text: new TextObject(text, undefined, undefined, { automerge }) });
-  const model = useTextModel({ text: item.text });
-  if (!model) {
-    return null;
-  }
+}: StoryProps) => {
+  const { accessor } = useDocAccessor(new TextObject(text));
+
+  const viewRef = useRef<EditorView>(null);
+  useComments(viewRef.current, id, comments);
+
+  const { themeMode } = useThemeContext();
+  const extensions = useMemo(
+    () => [
+      createBasicExtensions({ readonly, placeholder }),
+      createMarkdownExtensions({ themeMode }),
+      createThemeExtensions({
+        themeMode,
+        slots: {
+          editor: { className: 'min-bs-dvh px-8 bg-white dark:bg-black' },
+        },
+      }),
+      createDataExtensions({ id, text: accessor }),
+      _extensions,
+    ],
+    [_extensions],
+  );
 
   return (
     <TextEditor
-      model={model}
-      slots={{
-        root: { className: mx(textBlockWidth, 'min-bs-dvh') },
-        editor: { className: 'min-bs-dvh p-2 bg-white dark:bg-black' },
-      }}
       {...props}
+      id={id}
+      ref={viewRef}
+      doc={text}
+      extensions={extensions}
+      className={mx(textBlockWidth, 'min-bs-dvh')}
     />
   );
 };
@@ -55,6 +293,265 @@ export default {
   parameters: { translations, layout: 'fullscreen' },
 };
 
+const defaults = [
+  autocomplete({
+    onSearch: (text) => links.filter(({ label }) => label.toLowerCase().includes(text.toLowerCase())),
+  }),
+  decorateMarkdown({ renderLinkButton }),
+  formattingKeymap(),
+  image(),
+  table(),
+  linkTooltip(renderLinkTooltip),
+];
+
 export const Default = {
-  render: () => <Story text={initialText} placeholder='Enter text...' />,
+  render: () => <Story text={document} extensions={defaults} />,
+};
+
+export const Readonly = {
+  render: () => <Story text={document} extensions={defaults} readonly />,
+};
+
+export const NoExtensions = {
+  render: () => <Story text={document} />,
+};
+
+const large = faker.helpers.multiple(() => faker.lorem.paragraph({ min: 8, max: 16 }), { count: 20 }).join('\n\n');
+
+const largeWithImages = faker.helpers
+  .multiple(() => [faker.lorem.paragraph({ min: 12, max: 16 }), img], { count: 20 })
+  .flatMap((x) => x)
+  .join('\n\n');
+
+export const Empty = {
+  render: () => <Story />,
+};
+
+const global = new Map<string, SelectionState>();
+
+export const Scrolling = {
+  render: () => (
+    <Story
+      text={str('# Large Document', '', large)}
+      extensions={state({
+        setState: (id, state) => global.set(id, state),
+        getState: (id) => global.get(id),
+      })}
+    />
+  ),
+};
+
+export const ScrollingWithImages = {
+  render: () => <Story text={str('# Large Document', '', largeWithImages)} extensions={[image()]} />,
+};
+
+export const Links = {
+  render: () => <Story text={str(text.links, text.footer)} extensions={[linkTooltip(renderLinkTooltip)]} />,
+};
+
+export const Image = {
+  render: () => <Story text={str(text.image, text.footer)} extensions={[image()]} />,
+};
+
+export const Code = {
+  render: () => <Story text={str(text.code, text.footer)} extensions={[decorateMarkdown()]} />,
+};
+
+export const Lists = {
+  render: () => (
+    <Story text={str(text.tasks, '', text.list, '', text.numbered, text.footer)} extensions={[decorateMarkdown()]} />
+  ),
+};
+
+export const Table = {
+  render: () => <Story text={str(text.table, text.footer)} extensions={[table()]} />,
+};
+
+export const Autocomplete = {
+  render: () => (
+    <Story
+      text={str('# Autocomplete', '', 'Press Ctrl-Space...', text.footer)}
+      extensions={[
+        decorateMarkdown({ renderLinkButton }),
+        autocomplete({
+          onSearch: (text) => links.filter(({ label }) => label.toLowerCase().includes(text.toLowerCase())),
+        }),
+      ]}
+    />
+  ),
+};
+
+export const Mention = {
+  render: () => (
+    <Story
+      text={str('# Mention', '', 'Type @...', text.footer)}
+      extensions={[
+        mention({
+          onSearch: (text) => names.filter((name) => name.toLowerCase().startsWith(text.toLowerCase())),
+        }),
+      ]}
+    />
+  ),
+};
+
+const CommandDialog: FC<{ onClose: (action?: CommandAction) => void }> = ({ onClose }) => {
+  const [text, setText] = useState('');
+  const handleInsert = () => {
+    onClose(text.length ? { insert: text + '\n' } : undefined);
+  };
+
+  const handleKeyDown = (event: KeyboardEvent<HTMLInputElement>) => {
+    switch (event.key) {
+      case 'Enter': {
+        handleInsert();
+        break;
+      }
+      case 'Escape': {
+        onClose();
+        break;
+      }
+    }
+  };
+
+  return (
+    <DensityProvider density='fine'>
+      <div className={mx('flex items-center p-2 gap-2 border rounded-md', baseSurface)}>
+        <Input.Root>
+          <Input.TextInput
+            autoFocus={true}
+            placeholder='Enter command.'
+            value={text}
+            onChange={({ target: { value } }) => setText(value)}
+            onKeyDown={handleKeyDown}
+          />
+        </Input.Root>
+        <Button variant='ghost' classNames='pli-0' onClick={() => onClose()}>
+          <X className={getSize(5)} />
+        </Button>
+      </div>
+    </DensityProvider>
+  );
+};
+
+const renderCommandDialog: CommandOptions['onRender'] = (el, onClose) => {
+  createRoot(el).render(
+    <StrictMode>
+      <ThemeProvider tx={defaultTx}>
+        <CommandDialog onClose={onClose} />
+      </ThemeProvider>
+    </StrictMode>,
+  );
+};
+
+export const Command = {
+  render: () => (
+    <Story
+      text={str('# Command', '')}
+      extensions={[command({ onRender: renderCommandDialog, onHint: () => 'Press / for commands.' })]}
+    />
+  ),
+};
+
+export const Comments = {
+  render: () => {
+    const [_comments, setComments] = useState<Comment[]>([]);
+    return (
+      <Story
+        text={str('# Comments', '', text.paragraphs, text.footer)}
+        comments={_comments}
+        extensions={[
+          comments({
+            onHover: onCommentsHover,
+            onCreate: ({ cursor }) => {
+              const id = PublicKey.random().toHex();
+              setComments((commentRanges) => [...commentRanges, { id, cursor }]);
+              return id;
+            },
+            onSelect: (state) => {
+              const debug = false;
+              if (debug) {
+                console.log(
+                  'update',
+                  JSON.stringify({
+                    comments: state.comments.length,
+                    active: state.selection.current?.slice(0, 8),
+                    closest: state.selection.closest?.slice(0, 8),
+                  }),
+                );
+              }
+            },
+          }),
+        ]}
+      />
+    );
+  },
+};
+
+export const Vim = {
+  render: () => (
+    <Story
+      text={str('# Vim Mode', '', 'The distant future. The year 2000.', '', text.paragraphs)}
+      extensions={[defaults, EditorModes.vim]}
+    />
+  ),
+};
+
+export const Annotations = {
+  render: () => <Story text={str('# Annotations', '', large)} extensions={[annotations({ match: /volup/gi })]} />,
+};
+
+export const DND = {
+  render: () => <Story text={str('# DND', '')} extensions={[dnd()]} />,
+};
+
+const typewriterItems = localStorage.getItem('dxos.org/plugin/markdown/typewriter')?.split(',');
+
+export const Listener = {
+  render: () => (
+    <Story
+      text={str('# Listener', '', text.footer)}
+      extensions={[
+        listener({
+          onFocus: (focusing) => {
+            console.log({ focusing });
+          },
+          onChange: (text) => {
+            console.log({ text });
+          },
+        }),
+      ]}
+    />
+  ),
+};
+
+export const Typewriter = {
+  render: () => (
+    <Story
+      text={str('# Typewriter', '', text.paragraphs, text.footer)}
+      extensions={[typewriter({ items: typewriterItems })]}
+    />
+  ),
+};
+
+export const Blast = {
+  render: () => (
+    <Story
+      text={str('# Blast', '', text.paragraphs, text.code, text.paragraphs)}
+      extensions={[
+        typewriter({ items: typewriterItems }),
+        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,
+          ),
+        ),
+      ]}
+    />
+  ),
 };