@dxos/react-ui-editor 0.3.10-main.560f82b → 0.3.10-main.5e11230

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,29 +44,15 @@ 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 = {
@@ -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);
 
@@ -158,8 +140,8 @@ export const comments = (options: CommentsOptions = {}): Extension => {
       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: view.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 +153,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;
 
 /**
@@ -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/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/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,29 +3,18 @@
 //
 
 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 {
-  crosshairCursor,
-  drawSelection,
-  dropCursor,
-  EditorView,
-  highlightActiveLine,
-  highlightActiveLineGutter,
-  highlightSpecialChars,
-  keymap,
-  placeholder,
-  rectangularSelection,
-} from '@codemirror/view';
+import { crosshairCursor, drawSelection, dropCursor, EditorView, keymap, placeholder } 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 +22,34 @@ export type MarkdownBundleOptions = {
   placeholder?: string;
 };
 
+/**
+ * Markdown bundle.
+ * Refs:
+ * https://github.com/codemirror/basic-setup
+ * 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 +67,8 @@ export const markdownBundle = ({
 
       // Parser extensions.
       extensions: [
-        // GFM, // TODO(burdon): Provided by default?
-        markdownTagsExtension,
+        // GFM provided by default.
+        markdownTagsExtensions,
       ],
     }),
 
@@ -101,3 +79,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(',') },
     },
   );
+};

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

@@ -25,61 +25,60 @@ export const table = (options: TableOptions = {}) => {
 
 type Table = {
   from: number;
-  to?: number;
+  to: number;
   header?: string[];
   rows?: string[][];
 };
 
 const update = (state: EditorState, options: TableOptions) => {
   const builder = new RangeSetBuilder();
-  if (state.readOnly) {
-    const tables: Table[] = [];
-    const getTable = () => tables[tables.length - 1];
-    const getRow = () => {
-      const table = getTable();
-      return table.rows?.[table.rows.length - 1];
-    };
-
-    // Parse table.
-    // TODO(burdon): Use remark?: https://www.npmjs.com/package/remark-gfm
-    syntaxTree(state).iterate({
-      enter: (node) => {
-        // console.log(node.name);
-        // Check if cursor is inside text.
-        switch (node.name) {
-          case 'Table': {
-            tables.push({ from: node.from });
-            break;
-          }
-          case 'TableHeader': {
-            getTable().header = [];
-            break;
-          }
-          case 'TableRow': {
-            (getTable().rows ??= []).push([]);
-            break;
-          }
-          case 'TableCell': {
-            const row = getRow();
-            if (row) {
-              row.push(state.sliceDoc(node.from, node.to));
-            } else {
-              getTable().header?.push(state.sliceDoc(node.from, node.to));
-            }
-            break;
-          }
-          case 'TableDelimiter': {
-            getTable().to = node.to;
-            break;
+  const cursor = state.selection.main.head;
+
+  const tables: Table[] = [];
+  const getTable = () => tables[tables.length - 1];
+  const getRow = () => {
+    const table = getTable();
+    return table.rows?.[table.rows.length - 1];
+  };
+
+  // Parse table.
+  // TODO(burdon): Use remark?: https://www.npmjs.com/package/remark-gfm
+  // TODO(burdon): Style in monospace:
+  //  https://discuss.codemirror.net/t/markdown-table-highlighting/658
+  //  https://github.com/lezer-parser/markdown/blob/main/src/extension.ts
+  syntaxTree(state).iterate({
+    enter: (node) => {
+      // Check if cursor is inside text.
+      switch (node.name) {
+        case 'Table': {
+          tables.push({ from: node.from, to: node.to });
+          break;
+        }
+        case 'TableHeader': {
+          getTable().header = [];
+          break;
+        }
+        case 'TableRow': {
+          (getTable().rows ??= []).push([]);
+          break;
+        }
+        case 'TableCell': {
+          const row = getRow();
+          if (row) {
+            row.push(state.sliceDoc(node.from, node.to));
+          } else {
+            getTable().header?.push(state.sliceDoc(node.from, node.to));
           }
+          break;
         }
-      },
-    });
+      }
+    },
+  });
 
-    tables.forEach((table) =>
-      builder.add(table.from, table.to!, Decoration.replace({ widget: new TableWidget(table) })),
-    );
-  }
+  tables.forEach((table) => {
+    const hide = state.readOnly || cursor < table.from || cursor > table.to;
+    hide && builder.add(table.from, table.to!, Decoration.replace({ widget: new TableWidget(table) }));
+  });
 
   return builder.finish();
 };
@@ -98,11 +97,11 @@ class TableWidget extends WidgetType {
 
     {
       const header = table.appendChild(document.createElement('thead'));
-      const row = header.appendChild(document.createElement('tr'));
+      const tr = header.appendChild(document.createElement('tr'));
       this._table.header?.forEach((cell) => {
         const th = document.createElement('th');
         th.setAttribute('class', 'cm-table-head');
-        row.appendChild(th).textContent = cell;
+        tr.appendChild(th).textContent = cell;
       });
     }
 

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

@@ -12,6 +12,14 @@ import {
   type ViewUpdate,
 } from '@codemirror/view';
 
+// TODO(burdon): Reconcile with theme.
+const styles = EditorView.baseTheme({
+  '& .cm-task-item': {
+    paddingLeft: '4px',
+    paddingRight: '8px',
+  },
+});
+
 class CheckboxWidget extends WidgetType {
   constructor(
     private readonly _pos: number,
@@ -53,14 +61,6 @@ class CheckboxWidget extends WidgetType {
   }
 }
 
-// TODO(burdon): Reconcile with theme.
-const styles = EditorView.baseTheme({
-  '& .cm-task-item': {
-    paddingLeft: '4px',
-    paddingRight: '8px',
-  },
-});
-
 export type TasklistOptions = {};
 
 export const tasklist = (options: TasklistOptions = {}) => {

package/src/components/TextEditor/themes/default.ts

@@ -203,6 +203,43 @@ export const defaultTheme: {
     acc[`& .text-${fontSize} + .cm-widgetBuffer + .cm-ySelectionCaret`] = { height };
     return acc;
   }, {}),
+
+  /**
+   * Panels
+   * https://github.com/codemirror/search/blob/main/src/search.ts#L745
+   *
+   * Find/replace panel.
+   * <div class="cm-announced">...</div>
+   * <div class="cm-scroller">...</div>
+   * <div class="cm-panels cm-panels-bottom">
+   *   <div class="cm-search cm-panel">
+   *     <input class="cm-textfield" />
+   *     <button class="cm-button">...</button>
+   *     <label><input type="checkbox" />...</label>
+   *   </div>
+   * </div
+   */
+  '& .cm-panels': {
+    border: `1px solid ${get(tokens, 'extend.colors.neutral.200')}`,
+    borderBottom: 'none',
+  },
+  '& .cm-panel': {
+    background: get(tokens, 'extend.colors.neutral.50'),
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+  },
+  '& .cm-button': {
+    margin: '4px',
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+    background: get(tokens, 'extend.colors.neutral.100'),
+    border: 'none',
+  },
+
+  '& .cm-searchMatch': {
+    backgroundColor: get(tokens, 'extend.colors.yellow.100'),
+  },
+  '& .cm-searchMatch.cm-searchMatch-selected': {
+    backgroundColor: get(tokens, 'extend.colors.primary.100'),
+  },
 };
 
 export const textTheme: {