@dxos/react-ui-editor 0.8.4-main.84f28bd → 0.8.4-main.ae835ea

package/src/stories/TextEditor.stories.tsx

@@ -2,32 +2,17 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
 import { javascript } from '@codemirror/lang-javascript';
 import { openSearchPanel } from '@codemirror/search';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React from 'react';
 
 import { log } from '@dxos/log';
-import { withLayout, withTheme, type Meta } from '@dxos/storybook-utils';
+import { withTheme } from '@dxos/react-ui/testing';
 
-import {
-  EditorStory,
-  allExtensions,
-  content,
-  defaultExtensions,
-  global,
-  largeWithImages,
-  links,
-  longText,
-  names,
-  renderLinkButton,
-  text,
-} from './components';
 import { editorMonospace } from '../defaults';
 import {
   InputModeExtensions,
-  autocomplete,
   decorateMarkdown,
   folding,
   image,
@@ -39,12 +24,27 @@ import {
 } from '../extensions';
 import { str } from '../testing';
 
-const meta: Meta<typeof EditorStory> = {
+import {
+  EditorStory,
+  allExtensions,
+  content,
+  defaultExtensions,
+  global,
+  largeWithImages,
+  longText,
+  names,
+  text,
+} from './components';
+
+const meta = {
   title: 'ui/react-ui-editor/TextEditor',
   component: EditorStory,
-  decorators: [withTheme, withLayout({ fullscreen: true })],
-  parameters: { layout: 'fullscreen', controls: { disable: true } },
-};
+  decorators: [withTheme],
+  parameters: {
+    layout: 'fullscreen',
+    controls: { disable: true },
+  },
+} satisfies Meta<typeof EditorStory>;
 
 export default meta;
 
@@ -52,7 +52,9 @@ export default meta;
 // Default
 //
 
-export const Default = {
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
   render: () => <EditorStory text={text} extensions={defaultExtensions} />,
 };
 
@@ -60,7 +62,7 @@ export const Default = {
 // Everything
 //
 
-export const Everything = {
+export const Everything: Story = {
   render: () => <EditorStory text={text} extensions={allExtensions} selection={{ anchor: 99, head: 110 }} />,
 };
 
@@ -68,7 +70,7 @@ export const Everything = {
 // Empty
 //
 
-export const Empty = {
+export const Empty: Story = {
   render: () => <EditorStory extensions={defaultExtensions} />,
 };
 
@@ -76,7 +78,7 @@ export const Empty = {
 // Readonly
 //
 
-export const Readonly = {
+export const Readonly: Story = {
   render: () => <EditorStory text={text} extensions={defaultExtensions} readOnly />,
 };
 
@@ -84,7 +86,7 @@ export const Readonly = {
 // No Extensions
 //
 
-export const NoExtensions = {
+export const NoExtensions: Story = {
   render: () => <EditorStory text={text} />,
 };
 
@@ -92,7 +94,7 @@ export const NoExtensions = {
 // Vim
 //
 
-export const Vim = {
+export const Vim: Story = {
   render: () => (
     <EditorStory
       text={str('# Vim Mode', '', 'The distant future. The year 2000.', '', content.paragraphs)}
@@ -105,16 +107,16 @@ export const Vim = {
 // Listener
 //
 
-export const Listener = {
+export const Listener: Story = {
   render: () => (
     <EditorStory
       text={str('# Listener', '', content.footer)}
       extensions={[
         listener({
-          onFocus: (focusing) => {
+          onFocus: ({ focusing }) => {
             log.info('listener', { focusing });
           },
-          onChange: (text) => {
+          onChange: ({ text }) => {
             log.info('listener', { text });
           },
         }),
@@ -127,7 +129,7 @@ export const Listener = {
 // Folding
 //
 
-export const Folding = {
+export const Folding: Story = {
   render: () => <EditorStory text={text} extensions={[folding()]} />,
 };
 
@@ -135,7 +137,7 @@ export const Folding = {
 // Scrolling
 //
 
-export const Scrolling = {
+export const Scrolling: Story = {
   render: () => (
     <EditorStory
       text={str('# Large Document', '', longText)}
@@ -147,13 +149,13 @@ export const Scrolling = {
   ),
 };
 
-export const ScrollingWithImages = {
+export const ScrollingWithImages: Story = {
   render: () => (
     <EditorStory text={str('# Large Document', '', largeWithImages)} extensions={[decorateMarkdown(), image()]} />
   ),
 };
 
-export const ScrollTo = {
+export const ScrollTo: Story = {
   render: () => {
     // NOTE: Selection won't appear if text is reformatted.
     const word = 'Scroll to here...';
@@ -174,7 +176,7 @@ export const ScrollTo = {
 // Typescript
 //
 
-export const Typescript = {
+export const Typescript: Story = {
   render: () => (
     <EditorStory
       text={content.typescript}
@@ -184,38 +186,17 @@ export const Typescript = {
   ),
 };
 
-//
-// Autocomplete
-//
-
-export const Autocomplete = {
-  render: () => (
-    <EditorStory
-      text={str('# Autocomplete', '', 'Press Ctrl-Space...', content.footer)}
-      extensions={[
-        decorateMarkdown({ renderLinkButton }),
-        autocomplete({
-          onSearch: (text) => {
-            return links.filter(({ label }) => label.toLowerCase().includes(text.toLowerCase()));
-          },
-        }),
-      ]}
-    />
-  ),
-};
-
 //
 // Typeahead
 //
 
-const completions = ['type', 'AND', 'OR', 'NOT', 'dxos.org'];
+const completions = ['hello world!', 'dxos.org'];
 
-export const Typeahead = {
+export const Typeahead: Story = {
   render: () => (
     <EditorStory
       text={str('# Typeahead', '')}
       extensions={[
-        decorateMarkdown({ renderLinkButton }),
         typeahead({
           onComplete: staticCompletion(completions, { minLength: 2 }),
         }),
@@ -228,7 +209,7 @@ export const Typeahead = {
 // Mention
 //
 
-export const Mention = {
+export const Mention: Story = {
   render: () => (
     <EditorStory
       text={str('# Mention', '', 'Type @...', content.footer)}
@@ -245,7 +226,7 @@ export const Mention = {
 // Search
 //
 
-export const Search = {
+export const Search: Story = {
   render: () => (
     <EditorStory
       text={str('# Search', text)}

package/src/stories/components/EditorStory.tsx

@@ -3,39 +3,39 @@
 //
 
 import { type EditorView } from '@codemirror/view';
-import React, { type ReactNode, forwardRef, useEffect, useState, useImperativeHandle, useMemo } from 'react';
+import React, { type ReactNode, forwardRef, useEffect, useImperativeHandle, useMemo, useState } from 'react';
 
-import { Expando } from '@dxos/echo-schema';
+import { createDocAccessor, createObject } from '@dxos/client/echo';
+import { Expando } from '@dxos/echo/internal';
+import { live } from '@dxos/echo/internal';
 import { invariant } from '@dxos/invariant';
 import { PublicKey } from '@dxos/keys';
-import { live } from '@dxos/live-object';
-import { createDocAccessor, createObject } from '@dxos/react-client/echo';
 import { useForwardedRef, useThemeContext } from '@dxos/react-ui';
 import { useAttentionAttributes } from '@dxos/react-ui-attention';
 import { JsonFilter } from '@dxos/react-ui-syntax-highlighter';
 import { mx } from '@dxos/react-ui-theme';
 import { isNonNullable } from '@dxos/util';
 
-import { editorSlots, editorGutter } from '../../defaults';
+import { editorGutter, editorSlots } from '../../defaults';
 import {
   type DebugNode,
   type ThemeExtensionsOptions,
-  createDataExtensions,
   createBasicExtensions,
+  createDataExtensions,
   createMarkdownExtensions,
   createThemeExtensions,
   debugTree,
+  decorateMarkdown,
 } from '../../extensions';
-import { useTextEditor, type UseTextEditorProps } from '../../hooks';
+import { type UseTextEditorProps, useTextEditor } from '../../hooks';
 
 // Type definitions.
 export type DebugMode = 'raw' | 'tree' | 'raw+tree';
 
 const defaultId = 'editor-' + PublicKey.random().toHex().slice(0, 8);
 
-export type StoryProps = Pick<UseTextEditorProps, 'scrollTo' | 'selection' | 'extensions'> &
+export type StoryProps = Pick<UseTextEditorProps, 'id' | 'scrollTo' | 'selection' | 'extensions'> &
   Pick<ThemeExtensionsOptions, 'slots'> & {
-    id?: string;
     debug?: DebugMode;
     debugCustom?: (view: EditorView) => ReactNode;
     text?: string;
@@ -46,18 +46,18 @@ export type StoryProps = Pick<UseTextEditorProps, 'scrollTo' | 'selection' | 'ex
     onReady?: (view: EditorView) => void;
   };
 
-export const EditorStory = forwardRef<EditorView | undefined, StoryProps>(
+export const EditorStory = forwardRef<EditorView | null, StoryProps>(
   ({ debug, debugCustom, text, extensions: _extensions, ...props }, forwardedRef) => {
-    const attentionAttrs = useAttentionAttributes('testing');
+    const attentionAttrs = useAttentionAttributes('test-panel');
     const [tree, setTree] = useState<DebugNode>();
     const [object] = useState(createObject(live(Expando, { content: text ?? '' })));
     const viewRef = useForwardedRef(forwardedRef);
-    const view = viewRef.current;
     const extensions = useMemo(
       () => (debug ? [_extensions, debugTree(setTree)].filter(isNonNullable) : _extensions),
       [debug, _extensions],
     );
 
+    const view = viewRef.current;
     return (
       <div className={mx('w-full h-full grid overflow-hidden', debug && 'grid-cols-2 lg:grid-cols-[1fr_600px]')}>
         <EditorComponent ref={viewRef} object={object} text={text} extensions={extensions} {...props} />
@@ -84,7 +84,7 @@ export const EditorStory = forwardRef<EditorView | undefined, StoryProps>(
 /**
  * Default story component.
  */
-export const EditorComponent = forwardRef<EditorView | undefined, StoryProps>(
+export const EditorComponent = forwardRef<EditorView | null, StoryProps>(
   (
     {
       id = defaultId,
@@ -112,9 +112,10 @@ export const EditorComponent = forwardRef<EditorView | undefined, StoryProps>(
         initialValue: text,
         extensions: [
           createDataExtensions({ id, text: createDocAccessor(object, ['content']) }),
-          createBasicExtensions({ readOnly, placeholder, lineNumbers, scrollPastEnd: true }),
-          createMarkdownExtensions({ themeMode }),
+          createBasicExtensions({ readOnly, placeholder, lineNumbers, scrollPastEnd: true, search: true }),
+          createMarkdownExtensions(),
           createThemeExtensions({ themeMode, syntaxHighlighting: true, slots }),
+          decorateMarkdown(),
           editorGutter,
           extensions || [],
         ],
@@ -122,7 +123,7 @@ export const EditorComponent = forwardRef<EditorView | undefined, StoryProps>(
       [id, object, extensions, themeMode],
     );
 
-    useImperativeHandle(forwardedRef, () => view, [view]);
+    useImperativeHandle<EditorView | null, EditorView | null>(forwardedRef, () => view, [view]);
 
     useEffect(() => {
       if (view) {

package/src/styles/theme.ts

@@ -64,7 +64,7 @@ export const defaultTheme: ThemeStyles = {
     fontFamily: fontBody,
     // NOTE: Base font size (otherwise defined by HTML tag, which might be different for storybook).
     fontSize: '16px',
-    lineHeight: 1.5,
+    lineHeight: '24px',
     color: 'unset',
   },
 
@@ -74,22 +74,21 @@ export const defaultTheme: ThemeStyles = {
    */
   '.cm-gutters': {
     borderRight: 'none',
-    background: 'transparent',
   },
   '.cm-gutter': {},
   '.cm-gutter.cm-lineNumbers': {
     paddingRight: '4px',
-    borderRight: '1px solid var(--dx-separator)',
+    borderRight: '1px solid var(--dx-subduedSeparator)',
+    color: 'var(--dx-subduedText)',
   },
   '.cm-gutter.cm-lineNumbers .cm-gutterElement': {
     minWidth: '40px',
-    alignContent: 'center',
   },
   /**
-   * Height is set to match the corresponding line.
+   * Height is set to match the corresponding line (which may have wrapped).
    */
   '.cm-gutterElement': {
-    alignItems: 'center',
+    lineHeight: '24px',
     fontSize: '12px',
   },
 
@@ -97,6 +96,7 @@ export const defaultTheme: ThemeStyles = {
    * Line.
    */
   '.cm-line': {
+    lineHeight: '24px',
     paddingInline: 0,
   },
   '.cm-activeLine': {
@@ -110,6 +110,7 @@ export const defaultTheme: ThemeStyles = {
     borderLeft: '2px solid var(--dx-cmCursor)',
   },
   '.cm-placeholder': {
+    fontFamily: fontBody,
     color: 'var(--dx-placeholder)',
   },
 
@@ -165,10 +166,10 @@ export const defaultTheme: ThemeStyles = {
    * https://github.com/codemirror/autocomplete/blob/main/src/completion.ts
    */
   '.cm-tooltip.cm-tooltip-autocomplete': {
-    marginTop: '4px',
-    marginLeft: '-3px',
-    borderColor: 'var(--dx-separator)',
-    borderTop: 'none',
+    marginTop: '6px',
+    marginLeft: '-10px',
+    border: '2px solid var(--dx-separator)',
+    borderRadius: '4px',
   },
   '.cm-tooltip.cm-tooltip-autocomplete > ul': {
     maxHeight: '20em',
@@ -177,12 +178,12 @@ export const defaultTheme: ThemeStyles = {
     padding: '4px',
   },
   '.cm-tooltip.cm-tooltip-autocomplete > ul > li[aria-selected]': {
-    background: 'var(--dx-hoverSurface)',
+    background: 'var(--dx-activeSurface)',
+    color: 'var(--dx-activeSurfaceText)',
   },
   '.cm-tooltip.cm-tooltip-autocomplete > ul > completion-section': {
     paddingLeft: '4px !important',
-    borderBottom: 'none !important',
-    color: 'var(--dx-accentText)',
+    color: 'var(--dx-hoverSurfaceText)',
   },
 
   '.cm-completionInfo': {
@@ -196,10 +197,12 @@ export const defaultTheme: ThemeStyles = {
   },
   '.cm-completionLabel': {
     fontFamily: fontBody,
+    color: 'var(--dx-description)',
+    padding: '0 4px',
   },
   '.cm-completionMatchedText': {
     textDecoration: 'none !important',
-    opacity: 0.5,
+    color: 'var(--dx-baseText)',
   },
 
   /**
@@ -233,7 +236,7 @@ export const defaultTheme: ThemeStyles = {
     outline: '1px solid transparent',
   },
   '.cm-panel input, .cm-panel button': {
-    backgroundColor: 'var(--dx-input)',
+    backgroundColor: 'var(--dx-inputSurface)',
   },
   '.cm-panel input:focus, .cm-panel button:focus': {
     outline: '1px solid var(--dx-neutralFocusIndicator)',

package/src/testing/PreviewPopover.tsx

@@ -0,0 +1,80 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { createContext } from '@radix-ui/react-context';
+import React, { type PropsWithChildren, type RefObject, useCallback, useEffect, useRef, useState } from 'react';
+
+import { addEventListener } from '@dxos/async';
+import { type DxAnchorActivate, Popover } from '@dxos/react-ui';
+
+import { type PreviewLinkRef, type PreviewLinkTarget } from '../extensions';
+
+type PreviewLookup = (link: PreviewLinkRef) => Promise<PreviewLinkTarget | null | undefined>;
+
+type PreviewPopoverValue = Partial<{
+  link: PreviewLinkRef;
+  target: PreviewLinkTarget;
+  pending: boolean;
+}>;
+
+const [PreviewPopoverContextProvider, usePreviewPopover] = createContext<PreviewPopoverValue>('PreviewPopover', {});
+
+type PopoverLookupProviderProps = PropsWithChildren<{
+  onLookup?: PreviewLookup;
+}>;
+
+// TOOD(burdon): Reconcile with PreviewPlugin?
+const PreviewPopoverProvider = ({ children, onLookup }: PopoverLookupProviderProps) => {
+  const trigger = useRef<HTMLElement | null>(null);
+  const [value, setValue] = useState<PreviewPopoverValue>({});
+  const [open, setOpen] = useState(false);
+
+  const handleDxAnchorActivate = useCallback(
+    (event: DxAnchorActivate) => {
+      const { refId, label, trigger: dxTrigger } = event;
+      setValue((value) => ({
+        ...value,
+        link: { label, ref: refId },
+        pending: true,
+      }));
+      trigger.current = dxTrigger;
+      queueMicrotask(() => setOpen(true));
+      void onLookup?.({ label, ref: refId }).then((target) =>
+        setValue((value) => ({
+          ...value,
+          target: target ?? undefined,
+          pending: false,
+        })),
+      );
+    },
+    [onLookup],
+  );
+
+  const [rootRef, setRootRef] = useState<HTMLDivElement | null>(null);
+  useEffect(() => {
+    if (!rootRef || !handleDxAnchorActivate) {
+      return;
+    }
+
+    return addEventListener(rootRef, 'dx-anchor-activate' as any, handleDxAnchorActivate, {
+      capture: true,
+      passive: false,
+    });
+  }, [rootRef, handleDxAnchorActivate]);
+
+  return (
+    <PreviewPopoverContextProvider pending={value.pending} link={value.link} target={value.target}>
+      <Popover.Root open={open} onOpenChange={setOpen}>
+        <Popover.VirtualTrigger virtualRef={trigger as unknown as RefObject<HTMLButtonElement>} />
+        <div role='none' className='contents' ref={setRootRef}>
+          {children}
+        </div>
+      </Popover.Root>
+    </PreviewPopoverContextProvider>
+  );
+};
+
+export { PreviewPopoverProvider, usePreviewPopover };
+
+export type { PopoverLookupProviderProps, PreviewPopoverValue };

package/src/testing/index.ts

@@ -3,3 +3,4 @@
 //
 
 export * from './util';
+export * from './PreviewPopover';

package/src/testing/util.ts

@@ -2,4 +2,6 @@
 // Copyright 2025 DXOS.org
 //
 
+/** deprecated Replace with @dxos/util trim */
+// TODO(burdon): Remove
 export const str = (...lines: string[]) => lines.join('\n');

package/src/translations.ts

@@ -24,8 +24,8 @@ export const translations = [
         'selection overlaps existing comment label': 'Selection overlaps existing comment',
         'select text to comment label': 'Select text to comment',
         'image label': 'Insert image',
-        'heading label': 'Heading level',
         'table label': 'Create table',
+        'heading label': 'Heading level',
         'heading level label_zero': 'Paragraph',
         'heading level label_one': 'Heading level {{count}}',
         'heading level label_other': 'Heading level {{count}}',

package/src/types/types.ts

@@ -3,7 +3,7 @@
 //
 
 import { type EditorView } from '@codemirror/view';
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 
 // Runtime data structure.
 export type Range = {

package/src/util/cursor.ts

@@ -4,9 +4,10 @@
 
 import { type EditorState } from '@codemirror/state';
 
-import { singleValueFacet } from './facet';
 import { type Range } from '../types';
 
+import { singleValueFacet } from './facet';
+
 /**
  * Determines if two ranges overlap.
  * A range is considered to overlap if there is any intersection

package/src/util/debug.ts

@@ -7,12 +7,12 @@ import { type EditorView } from '@codemirror/view';
 
 import { log } from '@dxos/log';
 
-export const wrapWithCatch = (fn: (...args: any[]) => any) => {
+export const wrapWithCatch = (fn: (...args: any[]) => any, label?: string) => {
   return (...args: any[]) => {
     try {
       return fn(...args);
     } catch (err) {
-      log.catch(err);
+      log.catch(err, { label });
     }
   };
 };

package/src/util/decorations.ts

@@ -0,0 +1,21 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Range } from '@codemirror/state';
+import { type Decoration, type DecorationSet } from '@codemirror/view';
+
+export const decorationSetToArray = (deco: DecorationSet): readonly Range<Decoration>[] => {
+  const ranges: Range<Decoration>[] = [];
+  const iter = deco.iter();
+  while (iter.value) {
+    ranges.push({
+      from: iter.from,
+      to: iter.to,
+      value: iter.value,
+    });
+    iter.next();
+  }
+
+  return ranges;
+};

package/src/util/dom.ts

@@ -2,30 +2,28 @@
 // Copyright 2024 DXOS.org
 //
 
-// Copied from @codemirror/view
-
-export interface Rect {
+export type Rect = {
   readonly left: number;
   readonly right: number;
   readonly top: number;
   readonly bottom: number;
-}
+};
 
-export const flattenRect = (rect: Rect, left: boolean) => {
+export const flattenRect = (rect: Rect, left: boolean): Rect => {
   const x = left ? rect.left : rect.right;
   return { left: x, right: x, top: rect.top, bottom: rect.bottom };
 };
 
 let scratchRange: Range | null;
 
-export const textRange = (node: Text, from: number, to = from) => {
+export const textRange = (node: Text, from: number, to = from): Range => {
   const range = scratchRange || (scratchRange = document.createRange());
   range.setEnd(node, to);
   range.setStart(node, from);
   return range;
 };
 
-export const clientRectsFor = (dom: Node) => {
+export const clientRectsFor = (dom: Node): DOMRectList => {
   if (dom.nodeType === 3) {
     return textRange(dom as Text, 0, dom.nodeValue!.length).getClientRects();
   } else if (dom.nodeType === 1) {
@@ -34,23 +32,3 @@ export const clientRectsFor = (dom: Node) => {
     return [] as any as DOMRectList;
   }
 };
-
-export type ElementOptions = {
-  className?: string;
-  text?: string;
-};
-
-export const createElement = (tag: string, options?: ElementOptions, children?: HTMLElement[]): HTMLElement => {
-  const el = document.createElement(tag);
-  if (options?.className) {
-    el.className = options.className;
-  }
-  if (options?.text) {
-    el.textContent = options.text;
-  }
-  if (children) {
-    el.append(...(Array.isArray(children) ? children : [children]));
-  }
-
-  return el;
-};

package/src/util/index.ts

@@ -3,6 +3,7 @@
 //
 
 export * from './cursor';
+export * from './decorations';
 export * from './debug';
 export * from './dom';
 export * from './facet';