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

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

@@ -8,6 +8,8 @@ import { tags, styleTags, Tag } from '@lezer/highlight';
 import { type MarkdownConfig } from '@lezer/markdown';
 import get from 'lodash.get';
 
+import { mx } from '@dxos/react-ui-theme';
+
 import {
   blockquote,
   bold,
@@ -22,6 +24,11 @@ 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
@@ -50,118 +57,125 @@ export const markdownTagsExtension: MarkdownConfig = {
  * Styling based on `lezer` parser tags.
  * https://codemirror.net/examples/styling
  * https://github.com/lezer-parser/highlight
- * https://lezer.codemirror.net/docs/ref/#highlight (list of tags)
+ * 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 = HighlightStyle.define(
-  [
-    {
-      tag: [
-        tags.keyword,
-        tags.name,
-        tags.deleted,
-        tags.character,
-        tags.propertyName,
-        tags.macroName,
-        tags.color,
-        tags.constant(tags.name),
-        tags.standard(tags.name),
-        tags.definition(tags.name),
-        tags.separator,
-        tags.typeName,
-        tags.className,
-        tags.number,
-        tags.changed,
-        tags.annotation,
-        tags.modifier,
-        tags.self,
-        tags.namespace,
-        tags.operator,
-        tags.operatorKeyword,
-        tags.escape,
-        tags.regexp,
-        tags.special(tags.string),
-        tags.meta,
-        tags.comment,
-        tags.atom,
-        tags.bool,
-        tags.special(tags.variableName),
-        tags.processingInstruction,
-        tags.string,
-        tags.inserted,
-        tags.invalid,
-      ],
-      color: 'inherit !important',
-    },
+export const markdownHighlightStyle = (readonly?: boolean) =>
+  HighlightStyle.define(
+    [
+      {
+        tag: [
+          tags.keyword,
+          tags.name,
+          tags.deleted,
+          tags.character,
+          tags.propertyName,
+          tags.macroName,
+          tags.color,
+          tags.constant(tags.name),
+          tags.standard(tags.name),
+          tags.definition(tags.name),
+          tags.separator,
+          tags.typeName,
+          tags.className,
+          tags.number,
+          tags.changed,
+          tags.annotation,
+          tags.modifier,
+          tags.self,
+          tags.namespace,
+          tags.operator,
+          tags.operatorKeyword,
+          tags.escape,
+          tags.regexp,
+          tags.special(tags.string),
+          tags.meta,
+          tags.comment,
+          tags.atom,
+          tags.bool,
+          tags.special(tags.variableName),
+          tags.processingInstruction,
+          tags.string,
+          tags.inserted,
+          tags.invalid,
+        ],
+        color: 'inherit !important',
+      },
 
-    // Markdown marks.
-    {
-      tag: [
-        tags.meta,
-        tags.processingInstruction,
-        markdownTags.CodeMark,
-        markdownTags.EmphasisMark,
-        markdownTags.HeaderMark,
-        markdownTags.LinkLabel,
-        markdownTags.LinkReference,
-        markdownTags.ListMark,
-        markdownTags.QuoteMark,
-      ],
-      class: mark,
-    },
+      // Markdown marks.
+      {
+        tag: [
+          tags.meta,
+          tags.processingInstruction,
+          markdownTags.LinkLabel,
+          markdownTags.LinkReference,
+          markdownTags.ListMark,
+        ],
+        class: mark,
+      },
 
-    // Headings.
-    { tag: tags.heading1, class: heading[1] },
-    { tag: tags.heading2, class: heading[2] },
-    { tag: tags.heading3, class: heading[3] },
-    { tag: tags.heading4, class: heading[4] },
-    { tag: tags.heading5, class: heading[5] },
-    { tag: tags.heading6, class: heading[6] },
+      // Markdown marks.
+      {
+        tag: [markdownTags.CodeMark, markdownTags.HeaderMark, markdownTags.QuoteMark, markdownTags.EmphasisMark],
+        class: readonly ? 'hidden' : mark,
+      },
 
-    // Emphasis.
-    { tag: tags.emphasis, class: italic },
-    { tag: tags.strong, class: bold },
-    { tag: tags.strikethrough, class: strikethrough },
+      // E.g., code block language (after ```).
+      {
+        tag: [tags.function(tags.variableName), tags.labelName],
+        class: readonly ? 'hidden' : codeMark,
+      },
 
-    // Naked URLs.
-    {
-      tag: [markdownTags.URL],
-      class: inlineUrl,
-    },
+      // Headings.
+      { tag: tags.heading1, class: heading(1, readonly) },
+      { tag: tags.heading2, class: heading(2, readonly) },
+      { tag: tags.heading3, class: heading(3, readonly) },
+      { tag: tags.heading4, class: heading(4, readonly) },
+      { tag: tags.heading5, class: heading(5, readonly) },
+      { tag: tags.heading6, class: heading(6, readonly) },
 
-    // E.g., code block language (after ```).
-    {
-      tag: [tags.function(tags.variableName), tags.labelName],
-      class: codeMark,
-    },
+      // Emphasis.
+      { tag: tags.emphasis, class: italic },
+      { tag: tags.strong, class: bold },
+      { tag: tags.strikethrough, class: strikethrough },
 
-    // NOTE: The `markdown` extension configures extensions for `lezer` to parse markdown tokens (incl. below).
-    // However, since `codeLanguages` is also defined, the `lezer` will not parse fenced code blocks,
-    // when a language is specified. In this case, the syntax highlighting extensions will colorize
-    // the code, but all other CSS properties will be inherited.
-    // IMPORTANT: Therefore, the fenced code block will use the base editor font.
-    {
-      tag: [markdownTags.CodeText, markdownTags.InlineCode],
-      class: code,
-    },
+      // Naked URLs.
+      {
+        tag: [markdownTags.URL],
+        class: inlineUrl,
+      },
 
-    {
-      tag: [markdownTags.QuoteMark],
-      class: blockquote,
-    },
+      // NOTE: The `markdown` extension configures extensions for `lezer` to parse markdown tokens (incl. below).
+      // However, since `codeLanguages` is also defined, the `lezer` will not parse fenced code blocks,
+      // when a language is specified. In this case, the syntax highlighting extensions will colorize
+      // the code, but all other CSS properties will be inherited.
+      // IMPORTANT: Therefore, the fenced code block will use the base editor font.
+      {
+        tag: [markdownTags.CodeText, markdownTags.InlineCode],
+        class: code,
+      },
+
+      {
+        tag: [markdownTags.QuoteMark],
+        class: blockquote,
+      },
 
+      {
+        tag: [markdownTags.HorizontalRule],
+        class: mx(horizontalRule, readonly && '-indent-[100rem]'),
+      },
+
+      // Main content, paragraphs, etc.
+      // {
+      //   tag: [tags.content],
+      //   fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+      // },
+    ],
     {
-      tag: [markdownTags.HorizontalRule],
-      class: horizontalRule,
+      scope: markdownLanguage,
+      all: { fontFamily: get(tokens, 'fontFamily.body', []).join(',') },
     },
-
-    // Main content, paragraphs, etc.
-    // {
-    //   tag: [tags.content],
-    //   fontFamily: get(tokens, 'fontFamily.body', []).join(','),
-    // },
-  ],
-  {
-    scope: markdownLanguage,
-    all: { fontFamily: get(tokens, 'fontFamily.body', []).join(',') },
-  },
-);
+  );

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

@@ -0,0 +1,31 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { autocompletion, type CompletionContext, type CompletionResult } from '@codemirror/autocomplete';
+import type { Extension } from '@codemirror/state';
+
+export type MentionOptions = {
+  onSearch: (text: string) => string[];
+};
+
+export const mention = ({ onSearch }: MentionOptions): Extension => {
+  return autocompletion({
+    closeOnBlur: false, // For debugging.
+    override: [
+      (context: CompletionContext): CompletionResult | null => {
+        const match = context.matchBefore(/@(\w+)?/);
+        if (!match || (match.from === match.to && !context.explicit)) {
+          return null;
+        }
+
+        console.log(match);
+
+        return {
+          from: match.from,
+          options: onSearch(match.text.slice(1).toLowerCase()).map((value) => ({ label: `@${value}` })),
+        };
+      },
+    ],
+  });
+};

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

@@ -0,0 +1,123 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { syntaxTree } from '@codemirror/language';
+import { type EditorState, type RangeSet, RangeSetBuilder, StateField, type Transaction } from '@codemirror/state';
+import { Decoration, EditorView, WidgetType } from '@codemirror/view';
+
+// TODO(burdon): Snippet to create basic table.
+//  https://codemirror.net/docs/ref/#autocomplete.snippet
+
+export type TableOptions = {};
+
+/**
+ * GFM tables.
+ * https://github.github.com/gfm/#tables-extension
+ */
+export const table = (options: TableOptions = {}) => {
+  return StateField.define<RangeSet<any>>({
+    create: (state) => update(state, options),
+    update: (_: RangeSet<any>, tr: Transaction) => update(tr.state, options),
+    provide: (field) => EditorView.decorations.from(field),
+  });
+};
+
+type Table = {
+  from: 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;
+          }
+        }
+      },
+    });
+
+    tables.forEach((table) =>
+      builder.add(table.from, table.to!, Decoration.replace({ widget: new TableWidget(table) })),
+    );
+  }
+
+  return builder.finish();
+};
+
+class TableWidget extends WidgetType {
+  constructor(readonly _table: Table) {
+    super();
+  }
+
+  override eq(other: WidgetType) {
+    return this._table.from === (other as any as TableWidget)?._table?.from;
+  }
+
+  toDOM(view: EditorView) {
+    const table = document.createElement('table');
+
+    {
+      const header = table.appendChild(document.createElement('thead'));
+      const row = 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;
+      });
+    }
+
+    {
+      const body = table.appendChild(document.createElement('tbody'));
+      this._table.rows?.forEach((row) => {
+        const tr = body.appendChild(document.createElement('tr'));
+        row.forEach((cell) => {
+          const td = document.createElement('td');
+          td.setAttribute('class', 'cm-table-cell');
+          tr.appendChild(td).textContent = cell;
+        });
+      });
+    }
+
+    return table;
+  }
+}

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

@@ -17,7 +17,7 @@ class CheckboxWidget extends WidgetType {
     private readonly _pos: number,
     private _checked: boolean,
     private readonly _indent: number,
-    private readonly _onCheck: (check: boolean) => void,
+    private readonly _onCheck?: (check: boolean) => void,
   ) {
     super();
   }
@@ -35,10 +35,15 @@ class CheckboxWidget extends WidgetType {
     const input = wrap.appendChild(document.createElement('input'));
     input.type = 'checkbox';
     input.checked = this._checked;
-    input.onchange = (event: Event) => {
-      this._onCheck((event.target as any).checked);
-      return true;
-    };
+    if (!this._onCheck) {
+      input.setAttribute('disabled', 'true');
+    }
+    if (this._onCheck) {
+      input.onchange = (event: Event) => {
+        this._onCheck?.((event.target as any).checked);
+        return true;
+      };
+    }
 
     return wrap;
   }
@@ -56,7 +61,9 @@ const styles = EditorView.baseTheme({
   },
 });
 
-export const tasklist = () => {
+export type TasklistOptions = {};
+
+export const tasklist = (options: TasklistOptions = {}) => {
   // TODO(burdon): Matcher isn't as precise as syntax tree.
   //  Allows for indents to be greater than AST would allow.
   const taskMatcher = new MatchDecorator({
@@ -65,20 +72,27 @@ export const tasklist = () => {
       const indent = Math.floor(match[1].length / 2);
       const checked = match[2] === 'x' || match[2] === 'X';
       return Decoration.replace({
-        widget: new CheckboxWidget(pos, checked, indent, (checked) => {
-          const idx = pos + match[0].indexOf('[') + 1;
-          view.dispatch({
-            changes: {
-              from: idx,
-              to: idx + 1,
-              insert: checked ? 'x' : ' ',
-            },
-            // TODO(burdon): Restore cursor position? More useful to move to end of line (can indent).
-            selection: {
-              anchor: idx + 3,
-            },
-          });
-        }),
+        widget: new CheckboxWidget(
+          pos,
+          checked,
+          indent,
+          view.state.readOnly
+            ? undefined
+            : (checked) => {
+                const idx = pos + match[0].indexOf('[') + 1;
+                view.dispatch({
+                  changes: {
+                    from: idx,
+                    to: idx + 1,
+                    insert: checked ? 'x' : ' ',
+                  },
+                  // TODO(burdon): Restore cursor position? More useful to move to end of line (can indent).
+                  selection: {
+                    anchor: idx + 3,
+                  },
+                });
+              },
+        ),
       });
     },
   });

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

@@ -10,6 +10,11 @@ import { tokens } from '../../../styles';
 /**
  * Minimal styles.
  * https://codemirror.net/examples/styling
+ *
+ * Examples:
+ * - https://github.com/codemirror/view/blob/main/src/theme.ts
+ * - https://github.com/codemirror/theme-one-dark/blob/main/src/one-dark.ts
+ *
  * NOTE: Use one of '&', '&light', and '&dark' prefix to scope instance.
  * NOTE: `light` and `dark` selectors are preprocessed by CodeMirror and can only be in the base theme.
  */
@@ -136,8 +141,55 @@ export const defaultTheme: {
   '& .cm-tooltip': {
     border: 'none',
   },
-  // '& .cm-tooltip-below': {},
-  // '& .cm-tooltip-autocomplete': {},
+  '& .cm-tooltip-below': {},
+
+  //
+  // autocomplete
+  //
+  '& .cm-tooltip-autocomplete': {
+    marginTop: '4px',
+    marginLeft: '-3px',
+  },
+  '& .cm-tooltip-autocomplete ul li': {},
+  '& .cm-tooltip-autocomplete ul li[aria-selected]': {},
+  '& .cm-completionIcon': {
+    display: 'none',
+  },
+  '& .cm-completionLabel': {
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+  },
+  '& .cm-completionMatchedText': {
+    textDecoration: 'none',
+  },
+
+  //
+  // widgets
+  //
+  '& .cm-widgetBuffer': {
+    display: 'none',
+    height: 0,
+  },
+
+  //
+  // table
+  //
+  '& .cm-table-head': {
+    padding: '2px 16px 2px 0px',
+    borderBottom: `1px solid ${get(tokens, 'extend.colors.neutral.500')}`,
+    fontWeight: 100,
+    textAlign: 'left',
+    color: get(tokens, 'extend.colors.neutral.500'),
+  },
+  '& .cm-table-cell': {
+    padding: '2px 16px 2px 0px',
+  },
+
+  //
+  // image
+  //
+  '& .cm-image': {
+    margin: '0.5rem 0',
+  },
 
   //
   // font size

package/src/hooks/automerge/PatchSemaphore.ts

@@ -2,20 +2,24 @@
 // Copyright 2023 DXOS.org
 //
 
+// TODO(burdon): Additional copyright?
+
 import { type EditorView } from '@codemirror/view';
 
 import { next as automerge } from '@dxos/automerge/automerge';
 
-import amToCodemirror from './amToCodemirror';
-import codeMirrorToAm from './codeMirrorToAm';
 import { type IDocHandle } from './handle';
 import { type Field, isReconcileTx, getPath, reconcileAnnotationType, updateHeads, getLastHeads } from './plugin';
+import { automergeToCodemirror, codemirrorToAutomerge } from './translation';
 
 type Doc<T> = automerge.Doc<T>;
 type Heads = automerge.Heads;
 
 type ChangeFn = (atHeads: Heads, change: (doc: Doc<unknown>) => void) => Heads | undefined;
 
+/**
+ * TODO(burdon): Comment.
+ */
 export class PatchSemaphore {
   _field!: Field;
   _inReconcile = false;
@@ -39,7 +43,7 @@ export class PatchSemaphore {
 
     const transactions = view.state.field(this._field).unreconciledTransactions.filter((tx) => !isReconcileTx(tx));
 
-    // First undo all the unreconciled transactions
+    // First undo all the unreconciled transactions.
     const toInvert = transactions.slice().reverse();
     for (const tx of toInvert) {
       const inverted = tx.changes.invert(tx.startState.doc);
@@ -50,19 +54,18 @@ export class PatchSemaphore {
       });
     }
 
-    // now apply the unreconciled transactions to the document
-    let newHeads = codeMirrorToAm(this._field, handle, transactions, view.state);
+    // Apply the unreconciled transactions to the document.
+    let newHeads = codemirrorToAutomerge(this._field, handle, transactions, view.state);
 
-    // NOTE: null and undefined each come from automerge and repo respectively
+    // NOTE: null and undefined each come from automerge and repo respectively.
     if (newHeads === null || newHeads === undefined) {
       // TODO: @alexjg this is the call that's resetting the editor state on click
       newHeads = automerge.getHeads(handle.docSync()!);
     }
 
-    // now get the diff between the updated state of the document and the heads
-    // and apply that to the codemirror doc
+    // Now get the diff between the updated state of the document and the heads and apply that to the codemirror doc.
     const diff = automerge.equals(oldHeads, newHeads) ? [] : automerge.diff(handle.docSync()!, oldHeads, newHeads);
-    amToCodemirror(view, selection, path, diff);
+    automergeToCodemirror(view, selection, path, diff);
 
     view.dispatch({
       effects: updateHeads(newHeads),

package/src/hooks/automerge/automerge.stories.tsx

@@ -82,9 +82,10 @@ const Story = () => {
 };
 
 export default {
-  title: 'Automerge',
+  title: 'react-ui-editor/Automerge',
+  component: Editor,
 };
 
-export const AutomergeRepo = {
+export const Default = {
   render: () => <Story />,
 };

package/src/hooks/automerge/index.ts

@@ -2,5 +2,5 @@
 // Copyright 2023 DXOS.org
 //
 
-export { automergePlugin, type AutomergePlugin } from './plugin';
 export { type IDocHandle } from './handle';
+export { automergePlugin, type AutomergePlugin } from './plugin';

package/src/hooks/automerge/plugin.ts

@@ -78,6 +78,7 @@ export const automergePlugin = (handle: IDocHandle, path: Prop[]): AutomergePlug
       return result;
     },
   });
+
   const semaphore = new PatchSemaphore(stateField);
 
   const viewPlugin = ViewPlugin.fromClass(