@dxos/react-ui-editor 0.3.10-main.c5193cc → 0.3.10-main.c9b5e9b

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/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

@@ -101,14 +101,13 @@ const update = (state: EditorState, options: LinkOptions) => {
       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

@@ -7,7 +7,7 @@ import { history, historyKeymap, indentWithTab, standardKeymap } from '@codemirr
 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,33 +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(),
-
-    customkeymap(),
+    _placeholder && placeholder(_placeholder),
 
     // Main extension.
     // https://github.com/codemirror/lang-markdown
@@ -78,7 +78,7 @@ export const markdownBundle = ({
       // Parser extensions.
       extensions: [
         // GFM provided by default.
-        markdownTagsExtension,
+        markdownTagsExtensions,
       ],
     }),
 
@@ -91,7 +91,7 @@ export const markdownBundle = ({
 };
 
 // https://codemirror.net/docs/ref/#view.keymap
-const customkeymap = () =>
+const customKeymap = () =>
   keymap.of([
     // https://codemirror.net/docs/ref/#commands.indentWithTab
     indentWithTab,

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,57 @@ 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.
+  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) }));
+    builder.add(table.from, table.to, Decoration.mark({ class: 'cm-table' }));
+  });
 
   return builder.finish();
 };
@@ -98,11 +94,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 = {}) => {
@@ -109,7 +109,7 @@ export const tasklist = (options: TasklistOptions = {}) => {
       }
     },
     {
-      decorations: (instance) => instance.tasks,
+      decorations: (value) => value.tasks,
       provide: (plugin) =>
         EditorView.atomicRanges.of((view) => {
           return view.plugin(plugin)?.tasks || Decoration.none;

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

@@ -55,10 +55,10 @@ export const defaultTheme: {
   //
   // Cursor
   //
-  '&light .cm-cursor': {
+  '&light .cm-cursor, &light .cm-dropCursor': {
     borderLeft: '2px solid black',
   },
-  '&dark .cm-cursor': {
+  '&dark .cm-cursor, &dark .cm-dropCursor': {
     borderLeft: '2px solid white',
   },
   '& .cm-placeholder': {
@@ -173,6 +173,10 @@ export const defaultTheme: {
   //
   // table
   //
+  '& .cm-table *': {
+    fontFamily: `${get(tokens, 'fontFamily.mono', []).join(',')} !important`,
+    textDecoration: 'none !important',
+  },
   '& .cm-table-head': {
     padding: '2px 16px 2px 0px',
     borderBottom: `1px solid ${get(tokens, 'extend.colors.neutral.500')}`,
@@ -203,6 +207,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: {

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

@@ -9,6 +9,7 @@ import { basicSetup } from 'codemirror';
 import get from 'lodash.get';
 import React, { useEffect, useRef, useState } from 'react';
 
+// TODO(burdon): Why separate imports?
 import { type Prop } from '@dxos/automerge/automerge';
 import { type DocHandle, Repo } from '@dxos/automerge/automerge-repo';
 

package/src/hooks/useTextModel.ts

@@ -26,12 +26,19 @@ import { SpaceAwarenessProvider } from './yjs';
 // TODO(burdon): Move.
 type Awareness = awarenessProtocol.Awareness;
 
+export type DocumentRange = {
+  id: string;
+  from: number;
+  to: number;
+};
+
 // TODO(wittjosiah): Factor out to common package? @dxos/react-client?
 export type EditorModel = {
   id: string;
   // TODO(burdon): Remove.
   content: string | YText | YXmlFragment | DocAccessor;
   text: () => string;
+  ranges: DocumentRange[];
   extension?: Extension;
   awareness?: Awareness;
   peer?: {
@@ -80,6 +87,7 @@ const createYjsModel = ({ identity, space, text }: UseTextModelOptions): EditorM
     id: text.doc.guid,
     content: text.content,
     text: () => text.content!.toString(),
+    ranges: [],
     extension: yCollab(text.content as YText, provider?.awareness),
     awareness: provider?.awareness,
     peer: identity
@@ -99,6 +107,7 @@ const createAutomergeModel = ({ identity, text }: UseTextModelOptions): EditorMo
     id: obj.id,
     content: doc,
     text: () => get(doc.handle.docSync(), doc.path),
+    ranges: [],
     extension: automergePlugin(doc.handle, doc.path),
     peer: identity
       ? {

package/src/hooks/yjs/yjs.stories.tsx

@@ -16,6 +16,7 @@ import { MarkdownEditor } from '../../components';
 import { Replicator, useYjsModel } from '../../testing';
 
 export default {
+  title: 'react-ui-editor/YJS',
   component: MarkdownEditor,
   decorators: [withTheme],
 };
@@ -50,7 +51,6 @@ const Story = () => {
 };
 
 export const Default = {
-  title: 'react-ui-editor/YJS',
   // TODO(wittjosiah): Decorator for doing this without clients being initialized?
   render: () => <ClientRepeater count={2} Component={Story} />,
 };

package/src/styles/markdown.ts

@@ -6,12 +6,13 @@ import { mx } from '@dxos/react-ui-theme';
 
 export type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
 
+// TODO(burdon): Better way to align vertically than negative margin? Font-specific?
 // https://tailwindcss.com/docs/font-weight
 export const headings: Record<HeadingLevel, string[]> = {
-  1: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-4xl', '-ml-1.5'],
-  2: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-3xl', '-ml-1.5'],
-  3: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-2xl', '-ml-1.5'],
-  4: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-xl', '-ml-[5px]'],
+  1: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-4xl', '-ml-[10px]'],
+  2: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-3xl', '-ml-[8px]'],
+  3: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-2xl', '-ml-[7px]'],
+  4: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-xl', '-ml-[6px]'],
   5: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-lg', '-ml-[5px]'],
   6: ['mbs-4 mbe-2 font-medium text-inherit no-underline', '-ml-[4px]'],
 };

package/src/testing/replicator.ts

@@ -169,6 +169,7 @@ export class Replicator {
       id: doc.guid,
       text: () => content.toString(),
       content,
+      ranges: [],
       awareness: provider.awareness,
       peer: { id },
     };