@dxos/react-ui-editor 0.3.11-main.008b7c6 → 0.3.11-main.08776d7

package/src/extensions/hr.ts

@@ -11,16 +11,15 @@ import {
   type ViewUpdate,
   WidgetType,
 } from '@codemirror/view';
-import get from 'lodash.get';
 
-import { tokens } from '../styles';
+import { getToken } from '../styles';
 
 // TODO(burdon): Reconcile with theme.
 const styles = EditorView.baseTheme({
   '& .cm-hr': {
     // TODO(burdon): ???
     // Note that block-level decorations should not have vertical margins,
-    borderBottom: `1px solid ${get(tokens, 'extend.colors.neutral.200')}`,
+    borderBottom: `1px solid ${getToken('extend.colors.neutral.200')}`,
   },
 });
 
@@ -29,20 +28,24 @@ class HorizontalRuleWidget extends WidgetType {
     super();
   }
 
-  override eq(other: WidgetType) {
+  override eq(other: this) {
     return this._pos === (other as any as HorizontalRuleWidget)._pos;
   }
 
-  toDOM(view: EditorView) {
-    // TODO(burdon): Create <hr> element? Does this clash with markdown parser?
+  override toDOM(view: EditorView) {
     const el = document.createElement('div');
     el.className = 'cm-hr';
     return el;
   }
 }
 
+// TODO(burdon): Like Tasklist, allow cursor to move into range.
+
+// NOTE: Without a blank line before this markup will treat the previous line as a heading.
+// https://www.markdownguide.org/basic-syntax/#horizontal-rules
 const placeholderMatcher = new MatchDecorator({
-  regexp: /^---$/g,
+  // regexp: /(?<=\n\n)---/gs,
+  regexp: /^---$/gs,
   decoration: (match, view, pos) =>
     Decoration.replace({
       widget: new HorizontalRuleWidget(pos),
@@ -64,11 +67,6 @@ export const hr = () => [
     },
     {
       decorations: (instance) => instance.rules,
-      // TODO(burdon): Is this really atomic (cursor can move into ---).
-      provide: (plugin) =>
-        EditorView.atomicRanges.of((view) => {
-          return view.plugin(plugin)?.rules || Decoration.none;
-        }),
     },
   ),
 ];

package/src/extensions/image.ts

@@ -3,28 +3,45 @@
 //
 
 import { syntaxTree } from '@codemirror/language';
-import {
-  type EditorState,
-  type Extension,
-  type RangeSet,
-  RangeSetBuilder,
-  StateField,
-  type Transaction,
-} from '@codemirror/state';
-import { Decoration, EditorView, WidgetType } from '@codemirror/view';
+import { type EditorState, type Extension, StateField, type Transaction, type Range } from '@codemirror/state';
+import { Decoration, type DecorationSet, EditorView, WidgetType } from '@codemirror/view';
 
 export type ImageOptions = {};
 
 export const image = (options: ImageOptions = {}): Extension => {
-  return StateField.define<RangeSet<any>>({
-    create: (state) => update(state, options),
-    update: (_: RangeSet<any>, tr: Transaction) => update(tr.state, options),
+  return StateField.define<DecorationSet>({
+    create: (state) => {
+      return Decoration.set(buildDecorations(0, state.doc.length, state));
+    },
+    update: (value: DecorationSet, tr: Transaction) => {
+      if (!tr.docChanged && !tr.selection) {
+        return value;
+      }
+      // Find range of changes and cursor changes.
+      const cursor = tr.state.selection.main.head;
+      const oldCursor = tr.changes.mapPos(tr.startState.selection.main.head);
+      let from = Math.min(cursor, oldCursor);
+      let to = Math.max(cursor, oldCursor);
+      tr.changes.iterChangedRanges((fromA, toA, fromB, toB) => {
+        from = Math.min(from, fromB);
+        to = Math.max(to, toB);
+      });
+      // Expand to cover lines
+      from = tr.state.doc.lineAt(from).from;
+      to = tr.state.doc.lineAt(to).to;
+      return value.map(tr.changes).update({
+        filterFrom: from,
+        filterTo: to,
+        filter: () => false,
+        add: buildDecorations(from, to, tr.state),
+      });
+    },
     provide: (field) => EditorView.decorations.from(field),
   });
 };
 
-const update = (state: EditorState, options: ImageOptions) => {
-  const builder = new RangeSetBuilder();
+const buildDecorations = (from: number, to: number, state: EditorState) => {
+  const decorations: Range<Decoration>[] = [];
   const cursor = state.selection.main.head;
 
   syntaxTree(state).iterate({
@@ -34,20 +51,20 @@ const update = (state: EditorState, options: ImageOptions) => {
         if (urlNode) {
           const hide = state.readOnly || cursor < node.from || cursor > node.to;
           const url = state.sliceDoc(urlNode.from, urlNode.to);
-          builder.add(
-            hide ? node.from : node.to,
-            node.to,
+          decorations.push(
             Decoration.replace({
               block: true, // Prevent cursor from entering.
               widget: new ImageWidget(url),
-            }),
+            }).range(hide ? node.from : node.to, node.to),
           );
         }
       }
     },
+    from,
+    to,
   });
 
-  return builder.finish();
+  return decorations;
 };
 
 class ImageWidget extends WidgetType {
@@ -55,15 +72,16 @@ class ImageWidget extends WidgetType {
     super();
   }
 
-  // TODO(burdon): Does this need to be unique for each position?
-  override eq(other: WidgetType) {
+  override eq(other: this) {
     return this._url === (other as any as ImageWidget)._url;
   }
 
-  toDOM(view: EditorView) {
+  override toDOM(view: EditorView) {
     const img = document.createElement('img');
     img.setAttribute('src', this._url);
     img.setAttribute('class', 'cm-image');
+    // Images are hidden until successfully loaded to avoid flickering effects.
+    img.onload = () => img.classList.add('cm-loaded-image');
     return img;
   }
 }

package/src/extensions/index.ts

@@ -9,13 +9,15 @@ export * from './basic';
 export * from './blast';
 export * from './code';
 export * from './comments';
+export * from './cursor';
 export * from './hr';
 export * from './image';
 export * from './link';
 export * from './listener';
 export * from './markdown';
 export * from './mention';
-export * from './mermaid';
+export * from './outliner';
+export * from './sync';
 export * from './table';
 export * from './tasklist';
 export * from './typewriter';

package/src/extensions/link.ts

@@ -4,20 +4,20 @@
 //
 
 import { syntaxTree } from '@codemirror/language';
+import { type Extension, RangeSetBuilder } from '@codemirror/state';
 import {
-  type EditorState,
-  type Extension,
-  type RangeSet,
-  RangeSetBuilder,
-  StateField,
-  type Transaction,
-} from '@codemirror/state';
-import { Decoration, EditorView, WidgetType, hoverTooltip } from '@codemirror/view';
+  hoverTooltip,
+  Decoration,
+  type DecorationSet,
+  type EditorView,
+  ViewPlugin,
+  type ViewUpdate,
+  WidgetType,
+} from '@codemirror/view';
+import { type SyntaxNode } from '@lezer/common';
 
 import { tooltipContent } from '@dxos/react-ui-theme';
 
-const markdownLinkRegexp = /\[([^\]]+)]\(([^)]+)\)/;
-
 // Adapted from:
 // https://codemirror.net/try/?c=aW1wb3J0IHsgYmFzaWNTZXR1cCwgRWRpdG9yVmlldyB9IGZyb20gImNvZGVtaXJyb3IiCmltcG9ydCB7IG1hcmtkb3duIH0gZnJvbSAiQGNvZGVtaXJyb3IvbGFuZy1tYXJrZG93biIKaW1wb3J0IHsgc3ludGF4VHJlZSB9IGZyb20gIkBjb2RlbWlycm9yL2xhbmd1YWdlIjsKaW1wb3J0IHsgRWRpdG9yU3RhdGUsIFJhbmdlU2V0QnVpbGRlciwgU3RhdGVGaWVsZCB9IGZyb20gIkBjb2RlbWlycm9yL3N0YXRlIjsKaW1wb3J0IHsgRGVjb3JhdGlvbiwgV2lkZ2V0VHlwZSB9IGZyb20gIkBjb2RlbWlycm9yL3ZpZXciOwoKY2xhc3MgTGluayBleHRlbmRzIFdpZGdldFR5cGUgewogIGNvbnN0cnVjdG9yKHRleHQsIHVybCkgewogICAgc3VwZXIoKQogICAgdGhpcy50ZXh0ID0gdGV4dAogICAgdGhpcy51cmwgPSB1cmwKICB9CiAgZXEob3RoZXIpIHsgcmV0dXJuIHRoaXMudGV4dCA9PSBvdGhlci50ZXh0ICYmIHRoaXMudXJsID09IG90aGVyLnVybCB9CiAgdG9ET00oKSB7CiAgICBsZXQgbGluayA9IGRvY3VtZW50LmNyZWF0ZUVsZW1lbnQoImEiKQogICAgbGluay50ZXh0Q29udGVudCA9IHRoaXMudGV4dAogICAgbGluay5ocmVmID0gdGhpcy51cmwKICAgIHJldHVybiBsaW5rOwogIH0KfQoKbGV0IGRlY29yYXRpb25zRmllbGQgPSBTdGF0ZUZpZWxkLmRlZmluZSh7CiAgY3JlYXRlKCkgewogICAgcmV0dXJuIERlY29yYXRpb24ubm9uZTsKICB9LAogIHVwZGF0ZShfLCB0cikgewogICAgY29uc3QgYnVpbGRlciA9IG5ldyBSYW5nZVNldEJ1aWxkZXIoKTsKICAgIGxldCBjdXJzb3IgPSB0ci5zdGF0ZS5zZWxlY3Rpb24ubWFpbi5oZWFkOwogICAgc3ludGF4VHJlZSh0ci5zdGF0ZSkuaXRlcmF0ZSh7CiAgICAgIGVudGVyOiAobm9kZSkgPT4gewogICAgICAgIGlmICgoY3Vyc29yIDwgbm9kZS5mcm9tIHx8IGN1cnNvciA+IG5vZGUudG8pICYmIG5vZGUubmFtZSA9PSAiTGluayIpIHsKICAgICAgICAgIGxldCBtYXJrcyA9IG5vZGUubm9kZS5nZXRDaGlsZHJlbigiTGlua01hcmsiKTsKICAgICAgICAgIGxldCB0ZXh0ID0gbWFya3MubGVuZ3RoID49IDIgPyB0ci5zdGF0ZS5zbGljZURvYyhtYXJrc1swXS50bywgbWFya3NbMV0uZnJvbSkgOiAiIgoKICAgICAgICAgIGxldCB1cmxOb2RlID0gbm9kZS5ub2RlLmdldENoaWxkKCJVUkwiKTsKICAgICAgICAgIGxldCB1cmwgPSB1cmxOb2RlID8gdHIuc3RhdGUuc2xpY2VEb2ModXJsTm9kZS5mcm9tLCB1cmxOb2RlLnRvKSA6ICIiCiAgICAgICAgICBidWlsZGVyLmFkZChub2RlLmZyb20sIG5vZGUudG8sIERlY29yYXRpb24ucmVwbGFjZSh7CiAgICAgICAgICAgIHdpZGdldDogbmV3IExpbmsodGV4dCwgdXJsKSwKICAgICAgICAgIH0pLAogICAgICAgICAgICAgICAgICAgICApOwogICAgICAgICAgcmV0dXJuIGZhbHNlOwogICAgICAgIH0KICAgICAgICByZXR1cm4gdHJ1ZTsKICAgICAgfSwKICAgIH0pOwogICAgcmV0dXJuIGJ1aWxkZXIuZmluaXNoKCk7CiAgfSwKICBwcm92aWRlOiAoZikgPT4gRWRpdG9yVmlldy5kZWNvcmF0aW9ucy5mcm9tKGYpLAp9KTsKCmxldCB2aWV3ID0gbmV3IEVkaXRvclZpZXcoewogIGRvYzogIiMgSGVsbG8gV29ybGRcblxuW1Rlc3RdKGh0dHBzOi8vZXhhbXBsZS5jb20pXG5cblxuIiwKICBleHRlbnNpb25zOiBbZGVjb3JhdGlvbnNGaWVsZCwgbWFya2Rvd24oKV0sCiAgcGFyZW50OiBkb2N1bWVudC5ib2R5LAp9KTsKCnZpZXcuZm9jdXMoKTs=
 // https://discuss.codemirror.net/t/link-widget-is-clicked-only-if-editor-is-out-of-focus/7433
@@ -34,11 +34,24 @@ export type LinkOptions = {
  */
 export const link = (options: LinkOptions = {}): Extension => {
   const extensions: Extension[] = [
-    StateField.define<RangeSet<any>>({
-      create: (state) => update(state, options),
-      update: (_: RangeSet<any>, tr: Transaction) => update(tr.state, options),
-      provide: (field) => EditorView.decorations.from(field),
-    }),
+    ViewPlugin.fromClass(
+      class {
+        decorations: DecorationSet;
+
+        constructor(view: EditorView) {
+          this.decorations = buildDecorations(view, options);
+        }
+
+        update(update: ViewUpdate) {
+          if (update.docChanged || update.viewportChanged || update.selectionSet) {
+            this.decorations = buildDecorations(update.view, options);
+          }
+        }
+      },
+      {
+        decorations: (v) => v.decorations,
+      },
+    ),
   ];
 
   if (options.onHover) {
@@ -46,41 +59,25 @@ export const link = (options: LinkOptions = {}): Extension => {
       // https://codemirror.net/examples/tooltip
       // https://codemirror.net/docs/ref/#view.hoverTooltip
       // https://github.com/codemirror/view/blob/main/src/tooltip.ts
-      hoverTooltip((view, pos) => {
-        const { from, text } = view.state.doc.lineAt(pos);
-        const p = pos - from;
-
-        let idx = 0;
-        let match;
-        do {
-          match = text.substring(idx).match(markdownLinkRegexp);
-          if (!match) {
-            match = undefined;
-            break;
-          }
-
-          idx = text.indexOf(match[0]);
-          if (p >= idx && p < idx + match[0].length) {
-            break;
-          }
-
-          idx += match[0].length;
-        } while (true);
-
-        if (!match) {
+      hoverTooltip((view, pos, side) => {
+        const syntax = syntaxTree(view.state).resolveInner(pos, side);
+        let link = null;
+        for (let i = 0, node: SyntaxNode | null = syntax; !link && node && i < 5; node = node.parent, i++) {
+          link = node.name === 'Link' ? node : null;
+        }
+        const url = link && link.getChild('URL');
+        if (!url || !link) {
           return null;
         }
-
-        const [, , url] = match ?? [];
-
+        const urlText = view.state.sliceDoc(url.from, url.to);
         return {
-          pos: idx + from,
-          end: idx + from + match[0].length,
+          pos: link.from,
+          end: link.to,
           above: true,
           create: () => {
             const el = document.createElement('div');
             el.className = tooltipContent({}, 'pli-2 plb-1');
-            options.onHover!(el, url);
+            options.onHover!(el, urlText);
             return { dom: el, offset: { x: 0, y: 4 } };
           },
         };
@@ -92,19 +89,15 @@ export const link = (options: LinkOptions = {}): Extension => {
 };
 
 class LinkButton extends WidgetType {
-  constructor(
-    private readonly _pos: number,
-    private readonly _url: string,
-    private readonly _onAttach: LinkOptions['onRender'],
-  ) {
+  constructor(private readonly _url: string, private readonly _onAttach: LinkOptions['onRender']) {
     super();
   }
 
-  override eq(other: LinkButton) {
-    return this._pos === other._pos && this._url === other._url;
+  override eq(other: this) {
+    return this._url === other._url;
   }
 
-  toDOM(view: EditorView) {
+  override toDOM(view: EditorView) {
     const el = document.createElement('span');
     this._onAttach!(el, this._url);
     return el;
@@ -116,11 +109,11 @@ class LinkText extends WidgetType {
     super();
   }
 
-  override eq(other: LinkText) {
+  override eq(other: this) {
     return this._url === other._url;
   }
 
-  toDOM(view: EditorView) {
+  override toDOM(view: EditorView) {
     const link = document.createElement('a');
     link.setAttribute('class', 'cm-link');
     link.textContent = this._text;
@@ -147,46 +140,51 @@ class LinkText extends WidgetType {
  * possibly overlapping ranges in such a way that they can efficiently be mapped though document changes.
  * https://codemirror.net/docs/ref/#state
  */
-const update = (state: EditorState, options: LinkOptions) => {
-  const builder = new RangeSetBuilder();
+const buildDecorations = (view: EditorView, options: LinkOptions): DecorationSet => {
+  const builder = new RangeSetBuilder<Decoration>();
+  const { state } = view;
   const cursor = state.selection.main.head;
 
-  syntaxTree(state).iterate({
-    enter: (node) => {
-      // Check if cursor is inside text.
-      if (node.name === 'Link') {
-        const marks = node.node.getChildren('LinkMark');
-        const text = marks.length >= 2 ? state.sliceDoc(marks[0].to, marks[1].from) : '';
-        const urlNode = node.node.getChild('URL');
-        const url = urlNode ? state.sliceDoc(urlNode.from, urlNode.to) : '';
-        if (!url) {
-          return false;
-        }
+  for (const { from, to } of view.visibleRanges) {
+    syntaxTree(state).iterate({
+      enter: (node) => {
+        // Check if cursor is inside text.
+        if (node.name === 'Link') {
+          const marks = node.node.getChildren('LinkMark');
+          const text = marks.length >= 2 ? state.sliceDoc(marks[0].to, marks[1].from) : '';
+          const urlNode = node.node.getChild('URL');
+          const url = urlNode ? state.sliceDoc(urlNode.from, urlNode.to) : '';
+          if (!url) {
+            return false;
+          }
 
-        if (state.readOnly || cursor < node.from || cursor > node.to) {
-          builder.add(
-            node.from,
-            node.to,
-            Decoration.replace({
-              widget: new LinkText(text, options.link ? url : undefined),
-            }),
-          );
-        }
+          if (!view.hasFocus || state.readOnly || cursor < node.from || cursor > node.to) {
+            builder.add(
+              node.from,
+              node.to,
+              Decoration.replace({
+                widget: new LinkText(text, options.link ? url : undefined),
+              }),
+            );
+          }
 
-        if (options.onRender) {
-          builder.add(
-            node.to,
-            node.to,
-            Decoration.replace({
-              widget: new LinkButton(node.from, url, options.onRender),
-            }),
-          );
-        }
+          if (options.onRender) {
+            builder.add(
+              node.to,
+              node.to,
+              Decoration.replace({
+                widget: new LinkButton(url, options.onRender),
+              }),
+            );
+          }
 
-        return false;
-      }
-    },
-  });
+          return false;
+        }
+      },
+      from,
+      to,
+    });
+  }
 
   return builder.finish();
 };

package/src/extensions/markdown/highlight.ts

@@ -6,19 +6,18 @@ import { markdownLanguage } from '@codemirror/lang-markdown';
 import { HighlightStyle } from '@codemirror/language';
 import { tags, styleTags, Tag } from '@lezer/highlight';
 import { type MarkdownConfig, Table } from '@lezer/markdown';
-import get from 'lodash.get';
 
 import {
   blockquote,
   bold,
   code,
   codeMark,
+  getToken,
   heading,
   inlineUrl,
   italic,
   mark,
   strikethrough,
-  tokens,
 } from '../../styles';
 
 /**
@@ -32,7 +31,6 @@ export const markdownTags = {
   CodeText: Tag.define(),
   EmphasisMark: Tag.define(),
   HeaderMark: Tag.define(),
-  // HorizontalRule: Tag.define(),
   InlineCode: Tag.define(),
   LinkLabel: Tag.define(),
   LinkReference: Tag.define(),
@@ -178,13 +176,6 @@ export const markdownHighlightStyle = (readonly?: boolean) => {
         class: blockquote,
       },
 
-      // TODO(burdon): Replace with extension.
-      // {
-      //   tag: [markdownTags.HorizontalRule],
-      //   class: mx(horizontalRule, readonly && '-indent-[100rem]'),
-      // },
-
-      // TODO(burdon): Only if being edited.
       {
         tag: [markdownTags.TableCell],
         class: 'font-mono',
@@ -193,12 +184,12 @@ export const markdownHighlightStyle = (readonly?: boolean) => {
       // Main content, paragraphs, etc.
       // {
       //   tag: [tags.content],
-      //   fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+      //   fontFamily: getToken('fontFamily.body', []).join(','),
       // },
     ],
     {
       scope: markdownLanguage,
-      all: { fontFamily: get(tokens, 'fontFamily.body', []).join(',') },
+      all: { fontFamily: getToken('fontFamily.body', []).join(',') },
     },
   );
 };

package/src/extensions/outliner.ts

@@ -0,0 +1,12 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type Extension } from '@codemirror/state';
+
+export type OutlinerOptions = {};
+
+// TODO(burdon): Experimental component: multiple hierarchical draggable editor sections.
+export const outliner = (options: OutlinerOptions = {}): Extension => {
+  return [];
+};

package/src/extensions/sync.ts

@@ -0,0 +1,15 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Facet } from '@codemirror/state';
+import type { EditorView } from '@codemirror/view';
+
+export interface Syncer {
+  // TODO(burdon): Rename?
+  reconcile(view: EditorView): void;
+}
+
+export const syncFacet = Facet.define<Syncer, Syncer>({
+  combine: (values) => values.at(-1)!, // Take last.
+});

package/src/extensions/table.ts

@@ -81,7 +81,6 @@ const update = (state: EditorState, options: TableOptions) => {
         table.from,
         table.to,
         Decoration.replace({
-          block: true,
           widget: new TableWidget(table),
         }),
       );
@@ -98,11 +97,14 @@ class TableWidget extends WidgetType {
     super();
   }
 
-  override eq(other: WidgetType) {
-    return this._table.from === (other as any as TableWidget)?._table?.from;
+  override eq(other: this) {
+    return (
+      this._table.header?.join() === other._table.header?.join() &&
+      this._table.rows?.join() === other._table.rows?.join()
+    );
   }
 
-  toDOM(view: EditorView) {
+  override toDOM(view: EditorView) {
     const table = document.createElement('table');
 
     {
@@ -129,4 +131,8 @@ class TableWidget extends WidgetType {
 
     return table;
   }
+
+  override ignoreEvent(e: Event) {
+    return !/^mouse/.test(e.type);
+  }
 }