@dxos/react-ui-editor 0.4.8-main.0602afb → 0.4.8-main.0d78178

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-ui-editor",
-  "version": "0.4.8-main.0602afb",
+  "version": "0.4.8-main.0d78178",
   "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.0602afb",
-    "@dxos/context": "0.4.8-main.0602afb",
-    "@dxos/automerge": "0.4.8-main.0602afb",
-    "@dxos/display-name": "0.4.8-main.0602afb",
-    "@dxos/debug": "0.4.8-main.0602afb",
-    "@dxos/invariant": "0.4.8-main.0602afb",
-    "@dxos/echo-schema": "0.4.8-main.0602afb",
-    "@dxos/log": "0.4.8-main.0602afb",
-    "@dxos/protocols": "0.4.8-main.0602afb",
-    "@dxos/react-ui": "0.4.8-main.0602afb",
-    "@dxos/react-ui-theme": "0.4.8-main.0602afb",
-    "@dxos/react-async": "0.4.8-main.0602afb",
-    "@dxos/text-model": "0.4.8-main.0602afb",
-    "@dxos/util": "0.4.8-main.0602afb"
+    "@dxos/async": "0.4.8-main.0d78178",
+    "@dxos/context": "0.4.8-main.0d78178",
+    "@dxos/display-name": "0.4.8-main.0d78178",
+    "@dxos/automerge": "0.4.8-main.0d78178",
+    "@dxos/echo-schema": "0.4.8-main.0d78178",
+    "@dxos/invariant": "0.4.8-main.0d78178",
+    "@dxos/debug": "0.4.8-main.0d78178",
+    "@dxos/log": "0.4.8-main.0d78178",
+    "@dxos/protocols": "0.4.8-main.0d78178",
+    "@dxos/react-async": "0.4.8-main.0d78178",
+    "@dxos/text-model": "0.4.8-main.0d78178",
+    "@dxos/util": "0.4.8-main.0d78178",
+    "@dxos/react-ui-theme": "0.4.8-main.0d78178",
+    "@dxos/react-ui": "0.4.8-main.0d78178"
   },
   "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.0602afb",
-    "@dxos/echo-typegen": "0.4.8-main.0602afb",
-    "@dxos/echo-signals": "0.4.8-main.0602afb",
-    "@dxos/random": "0.4.8-main.0602afb",
-    "@dxos/keyboard": "0.4.8-main.0602afb",
-    "@dxos/react-client": "0.4.8-main.0602afb",
-    "@dxos/react-ui": "0.4.8-main.0602afb",
-    "@dxos/storybook-utils": "0.4.8-main.0602afb"
+    "@dxos/config": "0.4.8-main.0d78178",
+    "@dxos/echo-signals": "0.4.8-main.0d78178",
+    "@dxos/keyboard": "0.4.8-main.0d78178",
+    "@dxos/echo-typegen": "0.4.8-main.0d78178",
+    "@dxos/random": "0.4.8-main.0d78178",
+    "@dxos/react-client": "0.4.8-main.0d78178",
+    "@dxos/react-ui": "0.4.8-main.0d78178",
+    "@dxos/storybook-utils": "0.4.8-main.0d78178"
   },
   "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.0602afb"
+    "@dxos/react-client": "0.4.8-main.0d78178"
   },
   "publishConfig": {
     "access": "public"

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

@@ -20,6 +20,7 @@ import { withTheme } from '@dxos/storybook-utils';
 
 import { TextEditor, type TextEditorProps } from './TextEditor';
 import {
+  EditorModes,
   annotations,
   autocomplete,
   blast,
@@ -37,14 +38,15 @@ import {
   linkTooltip,
   listener,
   mention,
-  useComments,
+  state,
   table,
   typewriter,
-  EditorModes,
+  useComments,
   type CommandAction,
   type CommandOptions,
   type Comment,
   type CommentsOptions,
+  type SelectionState,
 } from '../../extensions';
 import { useDocAccessor } from '../../hooks';
 import translations from '../../translations';
@@ -241,7 +243,7 @@ type StoryProps = {
 } & Pick<TextEditorProps, 'extensions'>;
 
 const Story = ({
-  id = 'test',
+  id = 'editor-' + PublicKey.random().toHex().slice(0, 8),
   text,
   comments,
   extensions: _extensions = [],
@@ -325,8 +327,18 @@ export const Empty = {
   render: () => <Story />,
 };
 
+const global = new Map<string, SelectionState>();
+
 export const Scrolling = {
-  render: () => <Story text={str('# Large Document', '', large)} />,
+  render: () => (
+    <Story
+      text={str('# Large Document', '', large)}
+      extensions={state({
+        setState: (id, state) => global.set(id, state),
+        getState: (id) => global.get(id),
+      })}
+    />
+  ),
 };
 
 export const ScrollingWithImages = {

package/src/components/TextEditor/TextEditor.tsx

@@ -18,7 +18,7 @@ import React, {
 import { log } from '@dxos/log';
 import { isNotFalsy } from '@dxos/util';
 
-import { documentId, editorMode } from '../../extensions';
+import { documentId, editorMode, focusEvent } from '../../extensions';
 import { logChanges } from '../../util';
 
 export type CursorInfo = {
@@ -34,7 +34,7 @@ export type TextEditorProps = Pick<EditorStateConfig, 'doc' | 'selection' | 'ext
   id?: string;
   className?: string;
   autoFocus?: boolean;
-  scrollTo?: StateEffect<any>; // TODO(burdon): Restore scroll position: scrollTo EditorView.scrollSnapshot().
+  scrollTo?: StateEffect<unknown>;
   moveToEndOfLine?: boolean;
   debug?: boolean;
   dataTestId?: string;
@@ -56,14 +56,14 @@ export const TextEditor = forwardRef<EditorView | null, TextEditorProps>(
       extensions,
       className,
       autoFocus,
-      scrollTo = EditorView.scrollIntoView(0),
+      scrollTo = EditorView.scrollIntoView(0, { yMargin: 0 }),
       moveToEndOfLine,
       debug,
       dataTestId,
     },
     forwardedRef,
   ) => {
-    // TODO(burdon): Increments by 2!
+    // NOTE: Increments by 2 in strict mode.
     const [instanceId] = useState(() => `text-editor-${++instanceCount}`);
 
     // TODO(burdon): Make tabster optional.
@@ -104,7 +104,7 @@ export const TextEditor = forwardRef<EditorView | null, TextEditorProps>(
           // Focus.
           EditorView.updateListener.of((update) => {
             update.transactions.forEach((transaction) => {
-              if (transaction.isUserEvent('focus.container')) {
+              if (transaction.isUserEvent(focusEvent)) {
                 rootRef.current?.focus();
               }
             });
@@ -122,6 +122,7 @@ export const TextEditor = forwardRef<EditorView | null, TextEditorProps>(
         state,
         parent: rootRef.current!,
         scrollTo,
+
         // NOTE: Uncomment to debug/monitor all transactions.
         // https://codemirror.net/docs/ref/#view.EditorView.dispatch
         dispatchTransactions: (trs, view) => {
@@ -132,12 +133,10 @@ export const TextEditor = forwardRef<EditorView | null, TextEditorProps>(
         },
       });
 
-      setView(view);
-
-      // Position cursor at end of line.
-      if (moveToEndOfLine) {
+      // Position cursor at end of first line.
+      if (moveToEndOfLine && !(scrollTo || selection)) {
         const { to } = view.state.doc.lineAt(0);
-        view?.dispatch({ selection: { anchor: to } });
+        view.dispatch({ selection: { anchor: to } });
       }
 
       // Remove tabster attribute (rely on custom keymap).
@@ -145,6 +144,8 @@ export const TextEditor = forwardRef<EditorView | null, TextEditorProps>(
         rootRef.current?.removeAttribute('data-tabster');
       }
 
+      setView(view);
+
       return () => {
         view?.destroy();
         setView(null);

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

@@ -73,10 +73,11 @@ const Story: FC<{ content: string }> = ({ content }) => {
     <div role='none' className='fixed inset-0 flex flex-col'>
       <Toolbar.Root onAction={handleAction} state={formattingState} classNames={textBlockWidth}>
         <Toolbar.Markdown />
+        <Toolbar.Custom onUpload={async (file) => ({ url: file.name })} />
         <Toolbar.Separator />
-        <Toolbar.Extended />
+        <Toolbar.Actions />
       </Toolbar.Root>
-      <div role='textbox' ref={parentRef} className={textBlockWidth} />;
+      <div ref={parentRef} className={textBlockWidth} />
     </div>
   );
 };

package/src/components/Toolbar/Toolbar.tsx

@@ -7,6 +7,7 @@ import {
   ChatText,
   Code,
   CodeBlock,
+  Image,
   Link,
   ListBullets,
   ListChecks,
@@ -25,7 +26,8 @@ import {
   Quotes,
 } from '@phosphor-icons/react';
 import { createContext } from '@radix-ui/react-context';
-import React, { type PropsWithChildren, useRef, useState } from 'react';
+import React, { type PropsWithChildren, useEffect, useRef, useState } from 'react';
+import { useDropzone } from 'react-dropzone';
 
 import {
   DensityProvider,
@@ -34,7 +36,8 @@ import {
   type ThemedClassName,
   Toolbar as NaturalToolbar,
   Tooltip,
-  type ToolbarToggleGroupItemProps,
+  type ToolbarToggleGroupItemProps as NaturalToolbarToggleGroupItemProps,
+  type ToolbarButtonProps as NaturalToolbarButtonProps,
   useTranslation,
 } from '@dxos/react-ui';
 import { getSize } from '@dxos/react-ui-theme';
@@ -111,9 +114,9 @@ type ButtonProps = {
   disabled?: (state: Formatting) => boolean;
 };
 
-type ToolbarButtonProps = ToolbarToggleGroupItemProps & { Icon: Icon };
+type ToolbarToggleButtonProps = NaturalToolbarToggleGroupItemProps & { Icon: Icon };
 
-const ToolbarButton = ({ Icon, children, ...props }: ToolbarButtonProps) => {
+const ToolbarToggleButton = ({ Icon, children, ...props }: ToolbarToggleButtonProps) => {
   return (
     <Tooltip.Root>
       <Tooltip.Trigger asChild>
@@ -132,6 +135,27 @@ const ToolbarButton = ({ Icon, children, ...props }: ToolbarButtonProps) => {
   );
 };
 
+type ToolbarButtonProps = NaturalToolbarButtonProps & { Icon: Icon };
+
+const ToolbarButton = ({ Icon, children, ...props }: ToolbarButtonProps) => {
+  return (
+    <Tooltip.Root>
+      <Tooltip.Trigger asChild>
+        <NaturalToolbar.Button variant='ghost' {...props} classNames={buttonStyles}>
+          <Icon className={iconStyles} />
+          <span className='sr-only'>{children}</span>
+        </NaturalToolbar.Button>
+      </Tooltip.Trigger>
+      <Tooltip.Portal>
+        <Tooltip.Content {...tooltipProps}>
+          {children}
+          <Tooltip.Arrow />
+        </Tooltip.Content>
+      </Tooltip.Portal>
+    </Tooltip.Root>
+  );
+};
+
 const ToolbarSeparator = () => <div role='separator' className='grow' />;
 
 const MarkdownHeading = () => {
@@ -227,7 +251,7 @@ const MarkdownStyles = () => {
       value={markdownStyles.filter(({ getState }) => state && getState(state)).map(({ type }) => type)}
     >
       {markdownStyles.map(({ type, getState, Icon }) => (
-        <ToolbarButton
+        <ToolbarToggleButton
           key={type}
           value={type}
           Icon={Icon}
@@ -235,7 +259,7 @@ const MarkdownStyles = () => {
           onClick={state ? () => onAction?.({ type, data: !getState(state) }) : undefined}
         >
           {t(`${type} label`)}
-        </ToolbarButton>
+        </ToolbarToggleButton>
       ))}
     </NaturalToolbar.ToggleGroup>
   );
@@ -253,14 +277,14 @@ const MarkdownLists = () => {
   return (
     <NaturalToolbar.ToggleGroup type='single' value={state?.listStyle ? `list-${state.listStyle}` : ''}>
       {markdownLists.map(({ type, getState, Icon }) => (
-        <ToolbarButton
+        <ToolbarToggleButton
           key={type}
           value={type}
           Icon={Icon}
           onClick={state ? () => onAction?.({ type, data: !getState(state) }) : undefined}
         >
           {t(`${type} label`)}
-        </ToolbarButton>
+        </ToolbarToggleButton>
       ))}
     </NaturalToolbar.ToggleGroup>
   );
@@ -292,7 +316,7 @@ const MarkdownBlocks = () => {
   return (
     <NaturalToolbar.ToggleGroup type='single' value={value?.type ?? ''}>
       {markdownBlocks.map(({ type, disabled, getState, Icon }) => (
-        <ToolbarButton
+        <ToolbarToggleButton
           key={type}
           value={type}
           Icon={Icon}
@@ -300,7 +324,7 @@ const MarkdownBlocks = () => {
           onClick={state ? () => onAction?.({ type, data: !getState(state) }) : undefined}
         >
           {t(`${type} label`)}
-        </ToolbarButton>
+        </ToolbarToggleButton>
       ))}
     </NaturalToolbar.ToggleGroup>
   );
@@ -315,38 +339,68 @@ const MarkdownStandard = () => (
   </>
 );
 
-const MarkdownExtended = () => {
+// TODO(burdon): Make extensible.
+export type MarkdownCustomOptions = {
+  onUpload?: (file: File) => Promise<{ url?: string }>;
+};
+
+const MarkdownCustom = ({ onUpload }: MarkdownCustomOptions = {}) => {
   const { onAction } = useToolbarContext('MarkdownStyles');
   const { t } = useTranslation(translationKey);
+  // https://react-dropzone.js.org/#src
+  const { acceptedFiles, getInputProps, open } = useDropzone({
+    multiple: false,
+    noDrag: true,
+    accept: {
+      'image/*': ['.jpg', '.jpeg', '.png', '.gif'],
+    },
+  });
+  useEffect(() => {
+    if (onUpload && acceptedFiles.length) {
+      setTimeout(async () => {
+        // NOTE: Clone file since react-dropzone patches in a non-standard `path` property, which confuses IPFS.
+        const f = acceptedFiles[0];
+        const file = new File([f], f.name, {
+          type: f.type,
+          lastModified: f.lastModified,
+        });
+
+        const { url } = await onUpload(file);
+        if (url) {
+          onAction?.({ type: 'image', data: url });
+        }
+      });
+    }
+  }, [acceptedFiles]);
+
   return (
-    <Tooltip.Root>
-      <Tooltip.Trigger asChild>
-        <NaturalToolbar.Button
-          variant='ghost'
-          data-testid='editor.toolbar.comment'
-          onClick={() => onAction?.({ type: 'comment' })}
-          classNames={buttonStyles}
-        >
-          <ChatText className={iconStyles} />
-          <span className='sr-only'>{t('comment label')}</span>
-        </NaturalToolbar.Button>
-      </Tooltip.Trigger>
-      <Tooltip.Portal>
-        <Tooltip.Content {...tooltipProps}>
-          {t('comment label')}
-          <Tooltip.Arrow />
-        </Tooltip.Content>
-      </Tooltip.Portal>
-    </Tooltip.Root>
+    <>
+      <input {...getInputProps()} />
+      <ToolbarButton value='image' Icon={Image} onClick={() => open()}>
+        {t('image label')}
+      </ToolbarButton>
+    </>
+  );
+};
+
+// TODO(burdon): Make extensible.
+const MarkdownActions = () => {
+  const { onAction } = useToolbarContext('MarkdownStyles');
+  const { t } = useTranslation(translationKey);
+  return (
+    <ToolbarButton value='comment' Icon={ChatText} onClick={() => onAction?.({ type: 'comment' })}>
+      {t('comment label')}
+    </ToolbarButton>
   );
 };
 
 export const Toolbar = {
   Root: ToolbarRoot,
-  Button: ToolbarButton,
+  Button: ToolbarToggleButton,
   Separator: ToolbarSeparator,
   Markdown: MarkdownStandard,
-  Extended: MarkdownExtended,
+  Custom: MarkdownCustom,
+  Actions: MarkdownActions,
 };
 
 export { useToolbarContext };

package/src/extensions/factories.ts

@@ -116,9 +116,6 @@ const defaultSlots = {
   editor: {
     className: 'w-full bs-full',
   },
-  content: {
-    className: '!p-2',
-  },
 };
 
 export const createThemeExtensions = ({ theme, themeMode, slots: _slots }: ThemeExtensionsOptions = {}): Extension => {

package/src/extensions/index.ts

@@ -18,5 +18,6 @@ export * from './listener';
 export * from './markdown';
 export * from './mention';
 export * from './modes';
+export * from './state';
 export * from './types';
 export * from './typewriter';

package/src/extensions/markdown/decorate.ts

@@ -48,7 +48,7 @@ class CheckboxWidget extends WidgetType {
 
   override toDOM(view: EditorView) {
     const input = document.createElement('input');
-    input.className = 'cm-task-checkbox';
+    input.className = 'cm-task-checkbox ch-checkbox ch-focus-ring -mbs-0.5';
     input.type = 'checkbox';
     input.checked = this._checked;
     if (view.state.readOnly) {

package/src/extensions/markdown/formatting.test.ts

@@ -9,20 +9,20 @@ import { expect } from 'chai';
 import { describe, test } from '@dxos/test';
 
 import {
-  setHeading,
+  addBlockquote,
+  addCodeblock,
+  addLink,
+  addList,
   addStyle,
+  getFormatting,
   removeStyle,
-  addLink,
   removeLink,
-  addList,
   removeList,
-  addBlockquote,
   removeBlockquote,
-  addCodeblock,
   removeCodeblock,
+  setHeading,
   Inline,
   List,
-  getFormatting,
   type Formatting,
 } from './formatting';
 
@@ -204,22 +204,22 @@ describe('removeStyle', () => {
 });
 
 describe('addLink', () => {
-  testCommand('adds a link', '{}', addLink, '[]({})');
+  testCommand('adds a link', '{}', addLink(), '[]({})');
 
-  testCommand('adds a link around text', 'hello {world}', addLink, 'hello [world]({})');
+  testCommand('adds a link around text', 'hello {world}', addLink(), 'hello [world]({})');
 
-  testCommand('clears existing links', '[hello {world}](foo)', addLink, 'hello [world]({})');
+  testCommand('clears existing links', '[hello {world}](foo)', addLink(), 'hello [world]({})');
 
-  testCommand('does nothing across blocks', '{one\n\ntwo}', addLink, null);
+  testCommand('does nothing across blocks', '{one\n\ntwo}', addLink(), null);
 
-  testCommand('does nothing in code blocks', '```\n{one}\n```', addLink, null);
+  testCommand('does nothing in code blocks', '```\n{one}\n```', addLink(), null);
 
-  testCommand('patches up overlapping styles before', '*foo {bar* baz}', addLink, '*foo* [*bar* baz]({})');
+  testCommand('patches up overlapping styles before', '*foo {bar* baz}', addLink(), '*foo* [*bar* baz]({})');
 
   testCommand(
     'patches up overlapping styles after',
     'one {two ~~three} four~~',
-    addLink,
+    addLink(),
     'one [two ~~three~~]({}) ~~four~~',
   );
 });