@dxos/react-ui-editor 0.3.10-main.cbe7692 → 0.3.10-main.cc91b2d

package/src/components/TextEditor/extensions/comments.ts

@@ -18,25 +18,21 @@ import {
 import { debounce } from '@dxos/async';
 import { invariant } from '@dxos/invariant';
 
-// 1. TODO(burdon): Make atomic (for tasklist also).
-//    - https://discuss.codemirror.net/t/easily-track-remove-content-with-decorations/4606
-//    - https://discuss.codemirror.net/t/creating-atomic-replace-decorations/2961
-//    - https://codemirror.net/docs/ref/#state.EditorState%5EtransactionFilter (transaction filter: move, delete).
-// 2. TODO(burdon): Create/track threads in composer (change global state). Select/follow. Scroll with page.
-//    - Separate from chat/search.
-// 3. TODO(burdon): Support multiple threads in sidebar?
-// 4. TODO(burdon): Anchor AI thread when creating section.
-// 5. TODO(burdon): Button to resolve thread to close comments.
-
-// 6. TODO(burdon): Perf: Update existing rangeset.
-//  https://discuss.codemirror.net/t/rangeset-with-metadata-and-different-decorations/3874
-
-// TODO(burdon): Import note (performance):
-//  Easily track & remove content with decorations
-//  https://discuss.codemirror.net/t/easily-track-remove-content-with-decorations/4606
+// TODO(burdon): Reconcile with theme.
+const styles = EditorView.baseTheme({
+  '& .cm-bookmark': {
+    cursor: 'pointer',
+    margin: '4px',
+    padding: '4px',
+    backgroundColor: 'yellow',
+  },
+  '& .cm-bookmark-selected': {
+    backgroundColor: 'orange',
+  },
+});
 
 class BookmarkWidget extends WidgetType {
-  constructor(private readonly _pos: number, private readonly _id: string) {
+  constructor(private readonly _pos: number, private readonly _id: string, private readonly _handleClick: () => void) {
     super();
     invariant(this._id);
   }
@@ -48,34 +44,20 @@ class BookmarkWidget extends WidgetType {
   override toDOM() {
     const span = document.createElement('span');
     span.className = 'cm-bookmark';
-    // TODO(burdon): Call out to react?
-    // https://emojifinder.com/comment
-    span.textContent = '💬';
+    span.textContent = '§';
+    span.onclick = () => this._handleClick();
     return span;
   }
 }
 
-// TODO(burdon): Reconcile with theme.
-const styles = EditorView.baseTheme({
-  '& .cm-bookmark': {
-    cursor: 'pointer',
-    margin: '4px',
-    padding: '4px',
-    backgroundColor: 'yellow',
-  },
-  '& .cm-bookmark-selected': {
-    backgroundColor: 'orange',
-  },
-});
-
 type CommentsInfo = {
   active?: string;
-  items: { id: string; pos: number; location: Rect | null }[];
+  items?: { id: string; pos: number; location: Rect | null }[];
 };
 
 export type CommentsOptions = {
   key?: string;
-  onCreate?: () => string | void;
+  onCreate?: (from: number, to: number) => string | void;
   onUpdate?: (info: CommentsInfo) => void;
 };
 
@@ -91,7 +73,7 @@ export const comments = (options: CommentsOptions = {}): Extension => {
       const id = match[1];
       return Decoration.replace({
         id,
-        widget: new BookmarkWidget(pos, id),
+        widget: new BookmarkWidget(pos, id, () => handleUpdate({ active: id })),
       });
     },
   });
@@ -116,7 +98,7 @@ export const comments = (options: CommentsOptions = {}): Extension => {
     },
   );
 
-  const doUpdate = debounce((data: CommentsInfo) => {
+  const handleUpdate = debounce((data: CommentsInfo) => {
     options.onUpdate?.(data);
   }, 200);
 
@@ -126,13 +108,14 @@ export const comments = (options: CommentsOptions = {}): Extension => {
         key: options?.key ?? 'shift-meta-c',
         run: (view) => {
           // Insert footnote.
-          const id = options.onCreate?.();
+          const { from, to, head } = view.state.selection.main;
+          const id = options.onCreate?.(from, to);
           if (id) {
-            const pos = view.state.selection.main.head;
             const tag = `[^${id}]`;
+            // TODO(burdon): Add selection.
             view.dispatch({
-              changes: { from: pos, insert: tag },
-              selection: { anchor: pos + tag.length },
+              changes: { from: head, insert: tag },
+              selection: { anchor: head + tag.length },
             });
 
             return true;
@@ -152,14 +135,14 @@ export const comments = (options: CommentsOptions = {}): Extension => {
         return;
       }
 
-      const view = update.view;
-      const pos = view.state.selection.main.head;
+      const { view, state } = update;
+      const pos = state.selection.main.head;
 
       const decorations: { from: number; to: number; value: Decoration }[] = [];
       const rangeSet = view.plugin(bookmarks)?.bookmarks;
       let closest = Infinity;
-      // TODO(burdon): Always shows entire document?
-      const { from, to } = view.visibleRanges?.[0] ?? { from: 0, to: view.state.doc.length };
+      // TODO(burdon): Handle multiple visible ranges in large documents.
+      const { from, to } = /* view.visibleRanges?.[0] ?? */ { from: 0, to: state.doc.length };
       rangeSet?.between(from, to, (from, to, value) => {
         decorations.push({ from, to, value });
         const d = Math.min(Math.abs(pos - from), Math.abs(pos - to));
@@ -171,7 +154,7 @@ export const comments = (options: CommentsOptions = {}): Extension => {
       });
 
       if (decorations.length) {
-        doUpdate({
+        handleUpdate({
           active,
           items: decorations.map(
             ({

package/src/components/TextEditor/extensions/experimental.tsx

@@ -13,28 +13,21 @@ import {
   type ViewUpdate,
 } from '@codemirror/view';
 
-// TODO(burdon): Modes: parallel parsing and decoration (e.g., associated with language).
-// TODO(burdon): Add-on: runmode: run lexer over content (with rendering codemirror).
-//  https://codemirror.net/5/doc/manual.html#addon_runmode
-// TODO(burdon): Add-on: dialog.
-// TODO(burdon): Comments: https://codemirror.net/5/doc/manual.html#setBookmark
-// TODO(burdon): Split view: https://codemirror.net/examples/split
-// TODO(burdon): https://codemirror.net/5/demo/simplemode.html
-
-// https://codemirror.net/examples/autocompletion
-// https://codemirror.net/docs/ref/#autocomplete.autocompletion
-// https://codemirror.net/docs/ref/#autocomplete.Completion
-
-// TODO(burdon): Hint to customize?
-// https://codemirror.net/examples/autocompletion
-
-// Notes: Can't edit widget content (or cursor nav through them).
-// - https://discuss.codemirror.net/t/focusing-inputs-within-widgets/5178/7
-//   Widgets intentionally always get set to contenteditable=false,
-//   or they would become part of CodeMirror’s editable content element.
-//   You should be able to introduce new contenteditable=true child elements inside of them.
+// TODO(burdon): Reconcile with theme.
+export const styles = EditorView.baseTheme({
+  '.cm-hyperlink-label': {
+    cursor: 'pointer',
+    textDecoration: 'underline',
+  },
+  '.cm-hyperlink-bracket': {
+    opacity: 0.2,
+  },
+  '.cm-hyperlink-url': {
+    opacity: 0.5,
+    fontFamily: 'monospace',
+  },
+});
 
-// TODO(burdon): URL match?
 const markdownLinkRegexp = /\[([^\]]+)]\(([^)]+)\)(!?)/gi;
 
 /**
@@ -99,7 +92,7 @@ export function hyperLinkExtension() {
       }
     },
     {
-      decorations: (view) => view.decorations,
+      decorations: (value) => value.decorations,
       eventHandlers: {
         // TODO(burdon): CLick to expand link.
         // https://discuss.codemirror.net/t/decorator-iteration-on-click-event/4226/2
@@ -118,18 +111,4 @@ export function hyperLinkExtension() {
   );
 }
 
-export const styles = EditorView.baseTheme({
-  '.cm-hyperlink-label': {
-    cursor: 'pointer',
-    textDecoration: 'underline',
-  },
-  '.cm-hyperlink-bracket': {
-    opacity: 0.2,
-  },
-  '.cm-hyperlink-url': {
-    opacity: 0.5,
-    fontFamily: 'monospace',
-  },
-});
-
 export const hyperlinkWidget: Extension = [hyperLinkExtension(), styles];

package/src/components/TextEditor/extensions/highlight.ts

@@ -0,0 +1,128 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Extension, StateEffect, StateField } from '@codemirror/state';
+import { Decoration, EditorView } from '@codemirror/view';
+import sortBy from 'lodash.sortby';
+import { useEffect } from 'react';
+
+import { type DocumentRange } from '../../../hooks';
+
+// TODO(burdon): Detect click, or cursor proximity.
+
+// TODO(burdon): Reconcile with theme.
+const styles = EditorView.baseTheme({
+  '& .cm-highlight': {
+    backgroundColor: 'yellow', // TODO(burdon): Reconcile with tailwind theme.
+  },
+  '& .cm-highlight::before': {
+    content: ']',
+  },
+  '& .cm-highlight-active': {
+    backgroundColor: 'lime',
+  },
+});
+
+const marks = {
+  highlight: Decoration.mark({ class: 'cm-highlight' }),
+  HighlightActive: Decoration.mark({ class: 'cm-highlight-active' }),
+};
+
+type HighlightRange = DocumentRange & { active?: boolean };
+
+// TODO(burdon): Make configurable to support multiple layers.
+const setHighlights = StateEffect.define<HighlightRange[]>();
+
+/**
+ * Update field set.
+ */
+// TODO(burdon): Reconcile range from data model, vs. in-markdown characters.
+export const useHighlights = (view: EditorView | undefined, ranges: HighlightRange[] = []) => {
+  useEffect(() => {
+    view?.dispatch({
+      effects: setHighlights.of(ranges),
+    });
+  }, [view, ranges]);
+};
+
+/**
+ * State field that tracks highlight ranges.
+ */
+export const highlightStateField = StateField.define<HighlightRange[]>({
+  create: () => [],
+  update: (threads, tr) => {
+    for (const effect of tr.effects) {
+      if (effect.is(setHighlights)) {
+        return effect.value;
+      }
+    }
+
+    return threads;
+  },
+});
+
+/**
+ * Decorate ranges.
+ */
+// TODO(burdon): Pass in field to make reusable (e.g., comments, search).
+export const highlightDecorations = EditorView.decorations.compute([highlightStateField], (state) => {
+  const selectionRanges = state.field(highlightStateField);
+  const decorations =
+    sortBy(selectionRanges ?? [], (selection) => selection.from)?.flatMap((selection) => {
+      const range = { from: selection.from, to: selection.to + 1 };
+      if (selection.to > selection.from) {
+        if (selection.active) {
+          return marks.HighlightActive.range(range.from, range.to);
+        } else {
+          return marks.highlight.range(range.from, range.to);
+        }
+      } else {
+        return [];
+      }
+    }) ?? [];
+
+  return Decoration.set(decorations);
+});
+
+// TODO(burdon): Use current range to create comment.
+// TODO(burdon): Allow/prevent overlapping?
+
+/**
+ * Track cursor entering and existing ranges.
+ */
+const listener = (options: HighlightOptions) => {
+  return EditorView.updateListener.of((update) => {
+    const { view, state } = update;
+    const { /* from, to, */ head } = state.selection.main;
+    const ranges = state.field(highlightStateField);
+
+    // TODO(burdon): Modify range if editing.
+    // console.log('::::', update);
+
+    // Set active.
+    let mod = false;
+    const newRanges = ranges.map((range) => {
+      const active = head >= range.from && head <= range.to;
+      if (active !== range.active) {
+        mod = true;
+        return { ...range, active };
+      } else {
+        return range;
+      }
+    });
+
+    if (mod) {
+      view.dispatch({ effects: setHighlights.of(newRanges) });
+      options?.onChange?.(newRanges.find((range) => range.active)?.id);
+    }
+  });
+};
+
+export type HighlightOptions = {
+  onChange?: (active?: string) => {};
+};
+
+export const highlight = (options: HighlightOptions = {}): Extension => {
+  return [highlightStateField, highlightDecorations, listener(options), styles];
+};

package/src/components/TextEditor/extensions/image.ts

@@ -25,19 +25,19 @@ export const image = (options: ImageOptions = {}): Extension => {
 
 const update = (state: EditorState, options: ImageOptions) => {
   const builder = new RangeSetBuilder();
+  const cursor = state.selection.main.head;
 
-  // TODO(burdon): If not-readonly then show text.
-  // if (state.readOnly) {
   syntaxTree(state).iterate({
     enter: (node) => {
       if (node.name === 'Image') {
         const urlNode = node.node.getChild('URL');
         if (urlNode) {
+          const hide = state.readOnly || cursor < node.from || cursor > node.to;
           const url = state.sliceDoc(urlNode.from, urlNode.to);
           builder.add(
-            state.readOnly ? node.from : node.to,
+            hide ? node.from : node.to,
             node.to,
-            Decoration.widget({
+            Decoration.replace({
               widget: new ImageWidget(url),
             }),
           );
@@ -45,7 +45,6 @@ const update = (state: EditorState, options: ImageOptions) => {
       }
     },
   });
-  // }
 
   return builder.finish();
 };

package/src/components/TextEditor/extensions/index.ts

@@ -5,8 +5,10 @@
 export * from './autocomplete';
 export * from './basic';
 export * from './blast';
+export * from './code';
 export * from './demo';
 export * from './comments';
+export * from './highlight';
 export * from './image';
 export * from './link';
 export * from './listener';

package/src/components/TextEditor/extensions/link.ts

@@ -94,20 +94,20 @@ class LinkText extends WidgetType {
 const update = (state: EditorState, options: LinkOptions) => {
   const builder = new RangeSetBuilder();
   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;
         }
 
-        if (cursor < node.from || cursor > node.to) {
+        if (state.readOnly || cursor < node.from || cursor > node.to) {
           builder.add(
             node.from,
             node.to,

package/src/components/TextEditor/extensions/markdown/bundle.ts

@@ -3,11 +3,11 @@
 //
 
 import { closeBrackets, closeBracketsKeymap } from '@codemirror/autocomplete';
-import { defaultKeymap, history, historyKeymap, indentWithTab } from '@codemirror/commands';
+import { history, historyKeymap, indentWithTab, standardKeymap } from '@codemirror/commands';
 import { markdownLanguage, markdown } from '@codemirror/lang-markdown';
 import { bracketMatching, defaultHighlightStyle, indentOnInput, syntaxHighlighting } from '@codemirror/language';
 import { languages } from '@codemirror/language-data';
-import { highlightSelectionMatches, searchKeymap } from '@codemirror/search';
+import { searchKeymap } from '@codemirror/search';
 import { EditorState, type Extension } from '@codemirror/state';
 import { oneDarkHighlightStyle } from '@codemirror/theme-one-dark';
 import {
@@ -16,16 +16,13 @@ import {
   dropCursor,
   EditorView,
   highlightActiveLine,
-  highlightActiveLineGutter,
-  highlightSpecialChars,
   keymap,
   placeholder,
-  rectangularSelection,
 } from '@codemirror/view';
 
 import type { ThemeMode } from '@dxos/react-ui';
 
-import { markdownHighlightStyle, markdownTagsExtension } from './highlight';
+import { markdownHighlightStyle, markdownTagsExtensions } from './highlight';
 
 export type MarkdownBundleOptions = {
   readonly?: boolean;
@@ -33,45 +30,36 @@ export type MarkdownBundleOptions = {
   placeholder?: string;
 };
 
+/**
+ * Markdown bundle.
+ * Refs:
+ * https://github.com/codemirror/basic-setup
+ * https://github.com/codemirror/basic-setup/blob/main/src/codemirror.ts#L50
+ * https://codemirror.net/docs/community
+ * https://codemirror.net/docs/ref/#codemirror.basicSetup
+ */
+// TODO(burdon): Add Composer here: https://codemirror.net/docs/community
 export const markdownBundle = ({
   readonly,
   themeMode,
   placeholder: _placeholder,
 }: MarkdownBundleOptions): Extension[] => {
-  // All of https://github.com/codemirror/basic-setup minus line numbers and fold gutter.
-  // https://codemirror.net/docs/ref/#codemirror.basicSetup
   return [
-    bracketMatching(),
-    closeBrackets(),
-    _placeholder && placeholder(_placeholder),
-
     EditorState.allowMultipleSelections.of(true),
+    EditorState.tabSize.of(2),
     EditorView.lineWrapping,
 
+    customKeymap(),
+
+    bracketMatching(),
+    closeBrackets(),
     crosshairCursor(),
     dropCursor(),
     drawSelection(),
     highlightActiveLine(),
-    highlightActiveLineGutter(),
-    highlightSelectionMatches(),
-    highlightSpecialChars(),
     history(),
     indentOnInput(),
-    rectangularSelection(),
-
-    // https://codemirror.net/docs/ref/#view.keymap
-    keymap.of([
-      // https://codemirror.net/docs/ref/#commands.defaultKeymap
-      ...defaultKeymap,
-      // https://codemirror.net/docs/ref/#commands.historyKeymap
-      ...historyKeymap,
-      // https://codemirror.net/docs/ref/#autocomplete.closeBracketsKeymap
-      ...closeBracketsKeymap,
-      // https://codemirror.net/docs/ref/#search.searchKeymap
-      ...searchKeymap,
-      // https://codemirror.net/docs/ref/#commands.indentWithTab
-      indentWithTab,
-    ]),
+    _placeholder && placeholder(_placeholder),
 
     // Main extension.
     // https://github.com/codemirror/lang-markdown
@@ -89,8 +77,8 @@ export const markdownBundle = ({
 
       // Parser extensions.
       extensions: [
-        // GFM, // TODO(burdon): Provided by default?
-        markdownTagsExtension,
+        // GFM provided by default.
+        markdownTagsExtensions,
       ],
     }),
 
@@ -101,3 +89,18 @@ export const markdownBundle = ({
     syntaxHighlighting(markdownHighlightStyle(readonly)),
   ].filter(Boolean) as Extension[];
 };
+
+// https://codemirror.net/docs/ref/#view.keymap
+const customKeymap = () =>
+  keymap.of([
+    // https://codemirror.net/docs/ref/#commands.indentWithTab
+    indentWithTab,
+    // https://codemirror.net/docs/ref/#commands.standardKeymap
+    ...standardKeymap,
+    // https://codemirror.net/docs/ref/#commands.historyKeymap
+    ...historyKeymap,
+    // https://codemirror.net/docs/ref/#autocomplete.closeBracketsKeymap
+    ...closeBracketsKeymap,
+    // https://codemirror.net/docs/ref/#search.searchKeymap
+    ...searchKeymap,
+  ]);

package/src/components/TextEditor/extensions/markdown/highlight.ts

@@ -5,7 +5,7 @@
 import { markdownLanguage } from '@codemirror/lang-markdown';
 import { HighlightStyle } from '@codemirror/language';
 import { tags, styleTags, Tag } from '@lezer/highlight';
-import { type MarkdownConfig } from '@lezer/markdown';
+import { type MarkdownConfig, Table } from '@lezer/markdown';
 import get from 'lodash.get';
 
 import { mx } from '@dxos/react-ui-theme';
@@ -24,11 +24,6 @@ import {
   tokens,
 } from '../../../../styles';
 
-// TODO(burdon): Style table in monospace.
-//  https://discuss.codemirror.net/t/markdown-table-highlighting/658
-
-// TODO(burdon): Readonly: use remark rather than hiding markup chars (which cursor can still move into).
-
 /**
  * Custom tags defined and processed by the GFM lezer extension.
  * https://github.com/lezer-parser/markdown
@@ -47,24 +42,42 @@ export const markdownTags = {
   ListMark: Tag.define(),
   QuoteMark: Tag.define(),
   URL: Tag.define(),
-};
 
-export const markdownTagsExtension: MarkdownConfig = {
-  props: [styleTags(markdownTags)],
+  // Custom.
+  TableCell: Tag.define(),
 };
 
+// TODO(burdon): Customize table parser (make all content monospace).
+//  https://github.com/lezer-parser/markdown/blob/main/src/extension.ts
+Table.defineNodes?.forEach((node: any) => {
+  switch (node?.name) {
+    case 'TableCell': {
+      node.style = markdownTags.TableCell;
+      break;
+    }
+  }
+});
+
+export const markdownTagsExtensions: MarkdownConfig[] = [
+  Table,
+  {
+    props: [styleTags(markdownTags)],
+  },
+];
+
 /**
  * Styling based on `lezer` parser tags.
  * https://codemirror.net/examples/styling
  * https://github.com/lezer-parser/highlight
+ * https://github.com/lezer-parser/highlight/blob/main/src/highlight.ts#L427
  * https://lezer.codemirror.net/docs/ref/#highlight.tags (list of tags)
  *
  * Examples:
  * - https://github.com/codemirror/language/blob/main/src/highlight.ts#L194
  * - https://github.com/codemirror/theme-one-dark/blob/main/src/one-dark.ts#L115
  */
-export const markdownHighlightStyle = (readonly?: boolean) =>
-  HighlightStyle.define(
+export const markdownHighlightStyle = (readonly?: boolean) => {
+  return HighlightStyle.define(
     [
       {
         tag: [
@@ -129,6 +142,11 @@ export const markdownHighlightStyle = (readonly?: boolean) =>
         class: readonly ? 'hidden' : codeMark,
       },
 
+      {
+        tag: [tags.monospace],
+        class: 'font-mono',
+      },
+
       // Headings.
       { tag: tags.heading1, class: heading(1, readonly) },
       { tag: tags.heading2, class: heading(2, readonly) },
@@ -163,11 +181,18 @@ 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',
+      },
+
       // Main content, paragraphs, etc.
       // {
       //   tag: [tags.content],
@@ -179,3 +204,4 @@ export const markdownHighlightStyle = (readonly?: boolean) =>
       all: { fontFamily: get(tokens, 'fontFamily.body', []).join(',') },
     },
   );
+};