@dxos/react-ui-editor 0.3.10 → 0.3.11-main.00a28cb

package/dist/types/src/{components/TextEditor/themes → themes}/default.d.ts

@@ -1,4 +1,4 @@
-import { type StyleSpec } from 'style-mod';
+import { type ThemeStyles } from '../styles';
 /**
  * Minimal styles.
  * https://codemirror.net/examples/styling
@@ -10,16 +10,8 @@ import { type StyleSpec } from 'style-mod';
  * NOTE: Use one of '&', '&light', and '&dark' prefix to scope instance.
  * NOTE: `light` and `dark` selectors are preprocessed by CodeMirror and can only be in the base theme.
  */
-export declare const defaultTheme: {
-    [selector: string]: StyleSpec;
-};
-export declare const textTheme: {
-    [selector: string]: StyleSpec;
-};
-export declare const markdownTheme: {
-    [selector: string]: StyleSpec;
-};
-export declare const codeTheme: {
-    [selector: string]: StyleSpec;
-};
+export declare const defaultTheme: ThemeStyles;
+export declare const textTheme: ThemeStyles;
+export declare const markdownTheme: ThemeStyles;
+export declare const codeTheme: ThemeStyles;
 //# sourceMappingURL=default.d.ts.map

package/dist/types/src/themes/default.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"default.d.ts","sourceRoot":"","sources":["../../../../src/themes/default.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,WAAW,EAAU,MAAM,WAAW,CAAC;AAKrD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,EAAE,WAiO1B,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,WAOvB,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,WAO3B,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,WAOvB,CAAC"}

package/dist/types/src/themes/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/themes/index.ts"],"names":[],"mappings":"AAIA,cAAc,WAAW,CAAC"}

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

@@ -0,0 +1,5 @@
+/**
+ * CodeMirror callbacks swallow errors so wrap handlers.
+ */
+export declare const callbackWrapper: <T extends Function>(fn: T) => T;
+//# sourceMappingURL=util.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../src/util.ts"],"names":[],"mappings":"AAMA;;GAEG;AAEH,eAAO,MAAM,eAAe,kCAOR,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-ui-editor",
-  "version": "0.3.10",
+  "version": "0.3.11-main.00a28cb",
   "description": "Document editing experience within a DXOS shell.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -15,7 +15,7 @@
   "dependencies": {
     "@codemirror/autocomplete": "^6.11.1",
     "@codemirror/commands": "^6.3.2",
-    "@codemirror/lang-markdown": "^6.2.3",
+    "@codemirror/lang-markdown": "^6.2.4",
     "@codemirror/language": "^6.9.3",
     "@codemirror/language-data": "^6.3.1",
     "@codemirror/lint": "^6.4.2",
@@ -32,48 +32,54 @@
     "lib0": "^0.2.65",
     "lodash.defaultsdeep": "^4.6.1",
     "lodash.get": "^4.4.2",
+    "lodash.pick": "^4.4.0",
     "lodash.sortby": "^4.7.0",
     "style-mod": "^4.1.0",
     "y-codemirror.next": "^0.3.2",
     "y-protocols": "^1.0.5",
     "yjs": "^13.6.10",
-    "@dxos/automerge": "0.3.10",
-    "@dxos/async": "0.3.10",
-    "@dxos/debug": "0.3.10",
-    "@dxos/display-name": "0.3.10",
-    "@dxos/invariant": "0.3.10",
-    "@dxos/echo-schema": "0.3.10",
-    "@dxos/protocols": "0.3.10",
-    "@dxos/react-async": "0.3.10",
-    "@dxos/log": "0.3.10",
-    "@dxos/react-ui": "0.3.10",
-    "@dxos/react-ui-theme": "0.3.10",
-    "@dxos/text-model": "0.3.10",
-    "@dxos/util": "0.3.10"
+    "@dxos/async": "0.3.11-main.00a28cb",
+    "@dxos/context": "0.3.11-main.00a28cb",
+    "@dxos/automerge": "0.3.11-main.00a28cb",
+    "@dxos/display-name": "0.3.11-main.00a28cb",
+    "@dxos/echo-schema": "0.3.11-main.00a28cb",
+    "@dxos/invariant": "0.3.11-main.00a28cb",
+    "@dxos/debug": "0.3.11-main.00a28cb",
+    "@dxos/log": "0.3.11-main.00a28cb",
+    "@dxos/protocols": "0.3.11-main.00a28cb",
+    "@dxos/react-async": "0.3.11-main.00a28cb",
+    "@dxos/react-ui": "0.3.11-main.00a28cb",
+    "@dxos/react-ui-theme": "0.3.11-main.00a28cb",
+    "@dxos/text-model": "0.3.11-main.00a28cb",
+    "@dxos/util": "0.3.11-main.00a28cb"
   },
   "devDependencies": {
     "@automerge/automerge-repo-network-broadcastchannel": "^1.0.19",
-    "@faker-js/faker": "^8.0.2",
+    "@faker-js/faker": "^8.3.1",
     "@phosphor-icons/react": "^2.0.5",
     "@preact/signals-react": "^1.3.6",
     "@types/lodash.defaultsdeep": "^4.6.6",
     "@types/lodash.get": "^4.4.7",
+    "@types/lodash.pick": "^4.4.7",
     "@types/lodash.sortby": "^4.7.7",
     "@types/react": "^18.0.21",
     "@types/react-dom": "^18.0.6",
+    "deepsignal": "1.4.0-shallow.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "@dxos/config": "0.3.10",
-    "@dxos/echo-typegen": "0.3.10",
-    "@dxos/react-ui": "0.3.10",
-    "@dxos/storybook-utils": "0.3.10",
-    "@dxos/react-client": "0.3.10"
+    "@dxos/config": "0.3.11-main.00a28cb",
+    "@dxos/echo-signals": "0.3.11-main.00a28cb",
+    "@dxos/echo-typegen": "0.3.11-main.00a28cb",
+    "@dxos/keyboard": "0.3.11-main.00a28cb",
+    "@dxos/react-client": "0.3.11-main.00a28cb",
+    "@dxos/react-ui": "0.3.11-main.00a28cb",
+    "@dxos/storybook-utils": "0.3.11-main.00a28cb"
   },
   "peerDependencies": {
     "@phosphor-icons/react": "^2.0.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "@dxos/react-client": "0.3.10"
+    "@dxos/react-client": "0.3.11-main.00a28cb"
   },
   "publishConfig": {
     "access": "public"

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

@@ -8,39 +8,41 @@ 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 React, { type FC, StrictMode, useState } from 'react';
 import { createRoot } from 'react-dom/client';
 
 import { TextObject } from '@dxos/echo-schema';
+import { keySymbols, parseShortcut } from '@dxos/keyboard';
 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 { MarkdownEditor, type TextEditorProps } from './TextEditor';
 import {
   autocomplete,
-  listener,
-  link,
-  tasklist,
-  tooltip,
-  type TooltipOptions,
-  type LinkOptions,
+  blast,
+  code,
   comments,
-  table,
+  defaultOptions,
+  hr,
   image,
+  link,
   mention,
-  blast,
-  demo,
-  defaultOptions,
-  highlight,
-  code,
-} from './extensions';
-import { useTextModel } from '../../hooks';
+  table,
+  tasklist,
+  typewriter,
+  type CommentsOptions,
+  type LinkOptions,
+  outliner,
+} from '../../extensions';
+import { type CommentRange, useTextModel } from '../../hooks';
 
 // Extensions:
 // TODO(burdon): Table of contents.
 // TODO(burdon): Front-matter
 
+faker.seed(101);
+
 const str = (...lines: string[]) => lines.join('\n');
 
 const num = () => faker.number.int({ min: 0, max: 9999 }).toLocaleString();
@@ -55,6 +57,7 @@ const text = {
     '  - [ ] state',
     '  - [ ] indent',
     '  - [x] style',
+    '',
   ),
 
   list: str(
@@ -63,6 +66,7 @@ const text = {
     '- new york',
     '- london',
     '- tokyo',
+    '',
   ),
 
   numbered: str(
@@ -87,8 +91,8 @@ const text = {
     '',
     '  return () => <div>Test</div>;',
     '};',
+    '```',
     '',
-    '```'
   ),
 
   links: str(
@@ -103,11 +107,11 @@ const text = {
   table: str(
     '# Table',
     '',
-    `| ${faker.lorem.word().padStart(8)} | ${faker.lorem.word().padStart(8)} | ${faker.lorem.word().padStart(8)} |`,
-    '|----------|----------|----------|',
-    `| ${num().padStart(8)} | ${num().padStart(8)} | ${num().padStart(8)} |`,
-    `| ${num().padStart(8)} | ${num().padStart(8)} | ${num().padStart(8)} |`,
-    `| ${num().padStart(8)} | ${num().padStart(8)} | ${num().padStart(8)} |`,
+    `| ${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)} |`,
     '', // TODO(burdon): Possible GFM parsing bug if no newline?
   ),
 
@@ -147,7 +151,6 @@ const document = str(
   text.table,
   '---',
   text.image,
-  '',
   text.footer,
 );
 
@@ -162,7 +165,7 @@ const links = [
 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 onHoverLinkTooltip: LinkOptions['onHover'] = (el, url) => {
   const web = new URL(url);
   createRoot(el).render(
     <StrictMode>
@@ -174,24 +177,44 @@ const onHover: TooltipOptions['onHover'] = (el, url) => {
   );
 };
 
-const onRender: LinkOptions['onRender'] = (el, url) => {
+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 onRenderLink: 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')} />
+        <ArrowSquareOut weight='bold' className={mx(getSize(4), 'inline-block leading-none mis-1 mb-[2px]')} />
       </a>
     </StrictMode>,
   );
 };
 
-// TODO(burdon): Pass in model.
-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 }) });
+type StoryProps = {
+  text?: string;
+  automerge?: boolean;
+} & Pick<TextEditorProps, 'comments' | 'readonly' | 'extensions' | 'slots'>;
+
+const Story = ({ text, automerge, ...props }: StoryProps) => {
+  const [item] = useState({ text: new TextObject(text, undefined, undefined, { automerge }) });
   const model = useTextModel({ text: item.text });
   if (!model) {
     return null;
@@ -199,10 +222,9 @@ const Story = ({
 
   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 className='flex h-full justify-center'>
+        <div className='flex flex-col h-full w-[800px]'>
+          <MarkdownEditor model={model} {...props} />
         </div>
       </div>
     </div>
@@ -221,11 +243,11 @@ const extensions = [
     onSearch: (text) => links.filter(({ label }) => label.toLowerCase().includes(text.toLowerCase())),
   }),
   code(),
+  hr(),
   image(),
-  link({ onRender }),
+  link({ onRender: onRenderLink, onHover: onHoverLinkTooltip }),
   table(),
   tasklist(),
-  tooltip({ onHover }),
 ];
 
 export const Default = {
@@ -236,12 +258,37 @@ export const Readonly = {
   render: () => <Story text={document} extensions={extensions} readonly />,
 };
 
-export const Tooltips = {
-  render: () => <Story text={str(text.links, text.footer)} extensions={[tooltip({ onHover })]} />,
+const large = faker.helpers.multiple(() => faker.lorem.paragraph({ min: 8, max: 16 }), { count: 20 }).join('\n\n');
+
+export const Large = {
+  render: () => <Story text={str('# Large Document', '', large)} extensions={[]} />,
+};
+
+export const Empty = {
+  render: () => <Story />,
+};
+
+export const NoExtensions = {
+  render: () => <Story text={document} />,
+};
+
+// TODO(burdon): Cursor bug if no newline after BR (cursor down just loops back to start of each paragraph).
+export const HorizontalRule = {
+  render: () => (
+    <Story
+      text={str('# Horizontal Rule', '', text.paragraphs, '---', '', text.paragraphs, '---', '', text.paragraphs)}
+      extensions={[hr()]}
+    />
+  ),
 };
 
 export const Links = {
-  render: () => <Story text={str(text.links, text.footer)} extensions={[link({ onRender })]} />,
+  render: () => (
+    <Story
+      text={str(text.links, text.footer)}
+      extensions={[link({ onHover: onHoverLinkTooltip, onRender: onRenderLink })]}
+    />
+  ),
 };
 
 export const Code = {
@@ -256,18 +303,15 @@ export const Image = {
   render: () => <Story text={str(text.image, text.footer)} readonly extensions={[image()]} />,
 };
 
-export const TaskList = {
+export const Tasklist = {
+  render: () => <Story text={str(text.tasks, '', text.list, text.footer)} extensions={[tasklist()]} />,
+};
+
+export const Outliner = {
   render: () => (
     <Story
-      text={str(text.tasks, '', text.list, text.footer)}
-      extensions={[
-        tasklist(),
-        listener({
-          onChange: (text) => {
-            console.log(text);
-          },
-        }),
-      ]}
+      text={str('# Outliner', '', 'Block', ': this is a block', ': with multiple lines', text.footer)}
+      extensions={[outliner()]}
     />
   ),
 };
@@ -277,7 +321,7 @@ export const Autocomplete = {
     <Story
       text={str('# Autocomplete', '', 'Press CTRL-SPACE', text.footer)}
       extensions={[
-        link({ onRender }),
+        link({ onRender: onRenderLink }),
         autocomplete({
           onSearch: (text) => links.filter(({ label }) => label.toLowerCase().includes(text.toLowerCase())),
         }),
@@ -301,50 +345,59 @@ export const Mention = {
   ),
 };
 
-const mark = () => `[^${PublicKey.random().toHex()}]`;
 export const Comments = {
-  render: () => (
-    <Story
-      text={str(text.paragraphs, mark(), '', mark(), text.footer)}
-      extensions={[
-        comments({
-          onCreate: () => PublicKey.random().toHex(),
-          onUpdate: (info) => {
-            // console.log('update', info);
-          },
-        }),
-        highlight(),
-      ]}
-    />
-  ),
+  render: () => {
+    const [commentRanges, setCommentRanges] = useState<CommentRange[]>([]);
+
+    return (
+      <Story
+        text={str('# Comments', '', text.paragraphs, text.footer)}
+        comments={commentRanges}
+        extensions={[
+          comments({
+            onHover: onCommentsHover,
+            onCreate: (range) => {
+              const id = PublicKey.random().toHex();
+              setCommentRanges((commentRanges) => [...commentRanges, { id, cursor: range }]);
+              return id;
+            },
+            onSelect: (state) => {
+              const debug = false;
+              if (debug) {
+                console.log(
+                  'update',
+                  JSON.stringify({
+                    active: state.active?.slice(0, 8),
+                    closest: state.closest?.slice(0, 8),
+                    ranges: state.ranges.length,
+                  }),
+                );
+              }
+            },
+          }),
+        ]}
+      />
+    );
+  },
 };
 
-export const Diagnostics = {
+const typewriterItems = localStorage.getItem('dxos.org/plugin/markdown/typewriter')?.split(',');
+
+export const Typewriter = {
   render: () => (
     <Story
-      text={document}
-      extensions={[
-        // Cursor moved.
-        EditorView.updateListener.of((update) => {
-          console.log('update', update.view.state.selection.main.head);
-        }),
-      ]}
+      text={str('# Typewriter', '', text.paragraphs, text.footer)}
+      extensions={[typewriter({ items: typewriterItems })]}
     />
   ),
 };
 
-export const Demo = {
-  render: () => <Story text={str(text.paragraphs, text.footer)} extensions={[demo()]} />,
-};
-
 export const Blast = {
   render: () => (
     <Story
-      text={str(text.paragraphs, text.code, text.paragraphs)}
+      text={str('# Blast', '', text.paragraphs, text.code, text.paragraphs)}
       extensions={[
-        demo({
-          items: localStorage.getItem('dxos.composer.extension.demo')?.split(','),
-        }),
+        typewriter({ items: typewriterItems }),
         blast(
           defaultsDeep(
             {
@@ -362,6 +415,16 @@ export const Blast = {
   ),
 };
 
-export const NoExtensions = {
-  render: () => <Story text={document} />,
+export const Diagnostics = {
+  render: () => (
+    <Story
+      text={document}
+      extensions={[
+        // Cursor moved.
+        EditorView.updateListener.of((update) => {
+          console.log('update', update.view.state.selection.main.head);
+        }),
+      ]}
+    />
+  ),
 };

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

@@ -4,15 +4,14 @@
 
 import '@dxosTheme';
 
-import defaultsDeep from 'lodash.defaultsdeep';
-import React, { useRef, useState } from 'react';
+import React, { useState } from 'react';
 
 import { TextObject } from '@dxos/echo-schema';
 import { fixedInsetFlexLayout, groupSurface, mx } from '@dxos/react-ui-theme';
 import { withTheme } from '@dxos/storybook-utils';
 
-import { defaultSlots, TextEditor, type TextEditorProps, type TextEditorRef, type TextEditorSlots } from './TextEditor';
-import { textTheme } from './themes';
+import { TextEditor, type TextEditorProps } from './TextEditor';
+import { listener } from '../../extensions';
 import { useTextModel } from '../../hooks';
 
 const initialText = [
@@ -29,9 +28,8 @@ 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 }) });
+}: { 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;
@@ -39,10 +37,9 @@ const Story = ({
 
   return (
     <div className={mx(fixedInsetFlexLayout, groupSurface)}>
-      <div className='flex justify-center overflow-y-scroll'>
+      <div className='flex justify-center'>
         <div className='flex flex-col w-[800px] py-16'>
-          <TextEditor ref={ref} model={model} {...props} />
-          <div className='flex shrink-0 h-[300px]'></div>
+          <TextEditor model={model} {...props} />
         </div>
       </div>
     </div>
@@ -57,37 +54,19 @@ export default {
 };
 
 export const Default = {
-  render: () => (
-    <Story
-      slots={defaultsDeep(
-        { editor: { theme: textTheme, placeholder: 'Enter text...' } } satisfies TextEditorSlots,
-        defaultSlots,
-      )}
-    />
-  ),
+  render: () => <Story placeholder='Enter text...' />,
 };
 
 export const Text = {
-  render: () => (
-    <Story
-      text={initialText}
-      slots={defaultsDeep(
-        { editor: { theme: textTheme, placeholder: 'Enter text...' } } satisfies TextEditorSlots,
-        defaultSlots,
-      )}
-    />
-  ),
+  render: () => <Story text={initialText} placeholder='Enter text...' />,
 };
 
 export const Automerge = {
+  render: () => <Story text={initialText} placeholder='Enter text...' automerge />,
+};
+
+export const Listener = {
   render: () => (
-    <Story
-      automerge
-      text={initialText}
-      slots={defaultsDeep(
-        { editor: { theme: textTheme, placeholder: 'Enter text...' } } satisfies TextEditorSlots,
-        defaultSlots,
-      )}
-    />
+    <Story placeholder='Enter text...' extensions={[listener({ onChange: (text) => console.log(text) })]} />
   ),
 };