@dxos/react-ui-editor 0.3.10-main.92d1f2c → 0.3.10-main.9bbf73f

package/src/components/TextEditor/MarkdownEditor.stories.tsx

@@ -32,9 +32,15 @@ import {
   blast,
   demo,
   defaultOptions,
+  highlight,
+  code,
 } from './extensions';
 import { useTextModel } from '../../hooks';
 
+// Extensions:
+// TODO(burdon): Table of contents.
+// TODO(burdon): Front-matter
+
 const str = (...lines: string[]) => lines.join('\n');
 
 const num = () => faker.number.int({ min: 0, max: 9999 }).toLocaleString();
@@ -78,6 +84,7 @@ const text = {
     '```tsx',
     'const Component = () => {',
     '  const x = 100;',
+    '',
     '  return () => <div>Test</div>;',
     '};',
     '',
@@ -96,11 +103,11 @@ const text = {
   table: str(
     '# Table',
     '',
-    `| ${faker.lorem.word()} | ${faker.lorem.word()} | ${faker.lorem.word()} |`,
-    '|---|---|---|',
-    `| ${num()} | ${num()} | ${num()} |`,
-    `| ${num()} | ${num()} | ${num()} |`,
-    `| ${num()} | ${num()} | ${num()} |`,
+    `| ${faker.lorem.word().padStart(8)} | ${faker.lorem.word().padStart(8)} | ${faker.lorem.word().padStart(8)} |`,
+    '|----------|----------|----------|',
+    `| ${num().padStart(8)} | ${num().padStart(8)} | ${num().padStart(8)} |`,
+    `| ${num().padStart(8)} | ${num().padStart(8)} | ${num().padStart(8)} |`,
+    `| ${num().padStart(8)} | ${num().padStart(8)} | ${num().padStart(8)} |`,
     '', // TODO(burdon): Possible GFM parsing bug if no newline?
   ),
 
@@ -111,6 +118,8 @@ const text = {
   ),
 
   paragraphs: str(...faker.helpers.multiple(() => [faker.lorem.paragraph(), ''], { count: 3 }).flat()),
+
+  footer: str('', '', '', '', '')
 };
 
 const document = str(
@@ -139,6 +148,7 @@ const document = str(
   '---',
   text.image,
   '',
+  text.footer,
 );
 
 const links = [
@@ -174,6 +184,7 @@ const onRender: LinkOptions['onRender'] = (el, url) => {
   );
 };
 
+// TODO(burdon): Pass in model.
 const Story = ({
   text,
   automerge,
@@ -206,14 +217,15 @@ export default {
 };
 
 const extensions = [
-  link({ onRender }),
-  tooltip({ onHover }),
-  tasklist(),
-  table(),
-  image(),
   autocomplete({
     onSearch: (text) => links.filter(({ label }) => label.toLowerCase().includes(text.toLowerCase())),
   }),
+  code(),
+  image(),
+  link({ onRender }),
+  table(),
+  tasklist(),
+  tooltip({ onHover }),
 ];
 
 export const Default = {
@@ -224,30 +236,30 @@ export const Readonly = {
   render: () => <Story text={document} extensions={extensions} readonly />,
 };
 
-export const Simple = {
-  render: () => <Story text={document} />,
-};
-
 export const Tooltips = {
-  render: () => <Story text={str(text.links, '')} extensions={[tooltip({ onHover })]} />,
+  render: () => <Story text={str(text.links, text.footer)} extensions={[tooltip({ onHover })]} />,
 };
 
 export const Links = {
-  render: () => <Story text={str(text.links, '')} extensions={[link({ onRender })]} />,
+  render: () => <Story text={str(text.links, text.footer)} extensions={[link({ onRender })]} />,
+};
+
+export const Code = {
+  render: () => <Story text={str(text.code, text.footer)} extensions={[code()]} readonly />,
 };
 
 export const Table = {
-  render: () => <Story text={str(text.table, '')} extensions={[table()]} />,
+  render: () => <Story text={str(text.table, text.footer)} extensions={[table()]} />,
 };
 
 export const Image = {
-  render: () => <Story text={str(text.image, '', '')} readonly extensions={[image()]} />,
+  render: () => <Story text={str(text.image, text.footer)} readonly extensions={[image()]} />,
 };
 
 export const TaskList = {
   render: () => (
     <Story
-      text={str(text.tasks, '', text.list)}
+      text={str(text.tasks, '', text.list, text.footer)}
       extensions={[
         tasklist(),
         listener({
@@ -263,7 +275,7 @@ export const TaskList = {
 export const Autocomplete = {
   render: () => (
     <Story
-      text={str('# Autocomplete', '', '', '', '', '', '')}
+      text={str('# Autocomplete', '', 'Press CTRL-SPACE', text.footer)}
       extensions={[
         link({ onRender }),
         autocomplete({
@@ -279,7 +291,7 @@ const names = ['adam', 'alice', 'alison', 'bob', 'carol', 'charlie', 'sayuri', '
 export const Mention = {
   render: () => (
     <Story
-      text={str('# Mention', '', '', '', '', '', '')}
+      text={str('# Mention', '', 'Type @...', text.footer)}
       extensions={[
         mention({
           onSearch: (text) => names.filter((name) => name.toLowerCase().startsWith(text.toLowerCase())),
@@ -293,14 +305,15 @@ const mark = () => `[^${PublicKey.random().toHex()}]`;
 export const Comments = {
   render: () => (
     <Story
-      text={str(mark(), '', text.paragraphs, mark(), '', mark(), '')}
+      text={str(text.paragraphs, mark(), '', mark(), text.footer)}
       extensions={[
         comments({
           onCreate: () => PublicKey.random().toHex(),
           onUpdate: (info) => {
-            console.log('update', info);
+            // console.log('update', info);
           },
         }),
+        highlight(),
       ]}
     />
   ),
@@ -321,7 +334,7 @@ export const Diagnostics = {
 };
 
 export const Demo = {
-  render: () => <Story text={text.paragraphs} extensions={[demo()]} />,
+  render: () => <Story text={str(text.paragraphs, text.footer)} extensions={[demo()]} />,
 };
 
 export const Blast = {
@@ -348,3 +361,7 @@ export const Blast = {
     />
   ),
 };
+
+export const NoExtensions = {
+  render: () => <Story text={document} />,
+};

package/src/components/TextEditor/TextEditor.stories.tsx

@@ -57,6 +57,17 @@ export default {
 };
 
 export const Default = {
+  render: () => (
+    <Story
+      slots={defaultsDeep(
+        { editor: { theme: textTheme, placeholder: 'Enter text...' } } satisfies TextEditorSlots,
+        defaultSlots,
+      )}
+    />
+  ),
+};
+
+export const Text = {
   render: () => (
     <Story
       text={initialText}
@@ -71,12 +82,12 @@ export const Default = {
 export const Automerge = {
   render: () => (
     <Story
+      automerge
       text={initialText}
       slots={defaultsDeep(
         { editor: { theme: textTheme, placeholder: 'Enter text...' } } satisfies TextEditorSlots,
         defaultSlots,
       )}
-      automerge
     />
   ),
 };

package/src/components/TextEditor/TextEditor.tsx

@@ -88,6 +88,12 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
       }
     }, [awareness, peer, themeMode]);
 
+    // TODO(burdon): Get from model.
+    // useHighlights(view, [
+    //   { id: 'c-1', from: 0, to: 20 },
+    //   { id: 'c-2', from: 100, to: 120 },
+    // ]);
+
     useEffect(() => {
       if (!root) {
         return;
@@ -102,6 +108,7 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
           editorMode === 'vim' && vim(),
 
           // Theme.
+          // TODO(burdon): Make optional.
           EditorView.baseTheme(defaultTheme),
           EditorView.theme(slots?.editor?.theme ?? {}),
           // TODO(burdon): themeMode doesn't change in storybooks.
@@ -119,7 +126,17 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
       // If the new state is derived from the old state, it will likely not be visible other than the cursor resetting.
       // Ideally this should not be hit except when changing between text objects.
       view?.destroy();
-      setView(new EditorView({ state, parent: root }));
+      setView(
+        new EditorView({
+          state,
+          parent: root,
+          // NOTE: Uncomment to spy on all transactions.
+          // https://codemirror.net/docs/ref/#view.EditorView.dispatch
+          // dispatch: (transaction, view) => {
+          //   view.update([transaction]);
+          // },
+        }),
+      );
       setState(state);
 
       return () => {

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

@@ -6,7 +6,7 @@ import { closeBrackets } from '@codemirror/autocomplete';
 import { bracketMatching, defaultHighlightStyle, syntaxHighlighting } from '@codemirror/language';
 import { type Extension } from '@codemirror/state';
 import { oneDarkHighlightStyle } from '@codemirror/theme-one-dark';
-import { EditorView, placeholder } from '@codemirror/view';
+import { drawSelection, EditorView, placeholder } from '@codemirror/view';
 
 import type { ThemeMode } from '@dxos/react-ui';
 
@@ -18,12 +18,13 @@ export type BasicBundleOptions = {
 
 export const basicBundle = ({ readonly, themeMode, placeholder: _placeholder }: BasicBundleOptions): Extension[] =>
   [
+    EditorView.lineWrapping,
+
     // TODO(burdon): Compare with minimalSetup.
     // https://codemirror.net/docs/ref/#codemirror.minimalSetup
     bracketMatching(),
     closeBrackets(),
-    EditorView.lineWrapping,
-
+    drawSelection(),
     _placeholder && placeholder(_placeholder),
 
     // TODO(burdon): Is this required?

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

@@ -5,7 +5,7 @@
 // https://github.com/chinchang/code-blast-codemirror/blob/master/code-blast.js
 //
 
-import { type Extension, StateField } from '@codemirror/state';
+import { type Extension } from '@codemirror/state';
 import { EditorView, keymap } from '@codemirror/view';
 import defaultsDeep from 'lodash.defaultsdeep';
 
@@ -36,7 +36,7 @@ export const defaultOptions: BlastOptions = {
   shakeIntensity: 5,
 };
 
-export const blast = (options: Partial<BlastOptions>): Extension => {
+export const blast = (options: Partial<BlastOptions> = defaultOptions): Extension => {
   let blaster: Blaster | undefined;
   let last = 0;
 
@@ -77,39 +77,25 @@ export const blast = (options: Partial<BlastOptions>): Extension => {
         blaster.resize();
       }
 
-      const current = update.view.state.selection.main.head;
+      const current = update.state.selection.main.head;
       if (current !== last) {
         last = current;
         // TODO(burdon): Null if end of line.
-        const { element, point } = getPoint(update.view, current);
+        const { element, point } = getPoint(update.view, current - 1);
         if (element && point) {
           blaster.spawn({ element, point });
         }
       }
     }),
 
-    // Document changed.
-    StateField.define({
-      create: () => null,
-      update: (_value, transaction) => {
-        if (blaster && transaction.docChanged) {
-          // TODO(burdon): Only on delete.
-          const view = EditorView.findFromDOM(blaster.node)!;
-          const { element, point } = getPoint(view, transaction.selection!.main.head);
-          if (element && point) {
-            blaster.spawn({ element, point });
-          }
-        }
-
-        return null;
-      },
-    }),
-
     keymap.of([
       {
-        any: (view, event) => {
-          if (blaster && event.key === 'Enter' && event.shiftKey) {
-            blaster.shake({ time: 0.4 });
+        any: (_, event) => {
+          if (blaster) {
+            if (event.key === 'Enter' && event.shiftKey) {
+              blaster.shake({ time: 0.8 });
+              return true;
+            }
           }
 
           return false;
@@ -124,11 +110,11 @@ export const blast = (options: Partial<BlastOptions>): Extension => {
 //
 
 class Blaster {
+  private readonly _effect: Effect;
+
   _canvas: HTMLCanvasElement | undefined;
   _ctx: CanvasRenderingContext2D | undefined | null;
 
-  private readonly _effect: Effect;
-
   _running = false;
   _lastTime: number | undefined;
   _shakeTime = 0;
@@ -156,7 +142,7 @@ class Blaster {
     this._canvas.style.position = 'absolute';
     this._canvas.style.zIndex = '0';
     this._canvas.style.pointerEvents = 'none';
-    // this._canvas.style.border = '2px solid red';
+    // this._canvas.style.border = '2px dashed red';
 
     this._ctx = this._canvas.getContext('2d');
 
@@ -226,7 +212,7 @@ class Blaster {
   }
 
   shake = throttle<{ time: number }>(({ time }) => {
-    this._shakeTime = this._shakeTimeMax;
+    this._shakeTime = this._shakeTimeMax || time;
     this._shakeTimeMax = time;
   }, 100);
 

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

@@ -0,0 +1,99 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Range } from '@codemirror/state';
+import {
+  ViewPlugin,
+  type DecorationSet,
+  EditorView,
+  type ViewUpdate,
+  Decoration,
+  type BlockInfo,
+} from '@codemirror/view';
+import get from 'lodash.get';
+
+import { mx } from '@dxos/react-ui-theme';
+
+import { tokens } from '../../../styles';
+
+const CODE_REGEX = /```[\s\S]*?```/gs;
+
+// TODO(burdon): Reconcile with theme.
+const styles = EditorView.baseTheme({
+  '& .cm-code-block': {
+    display: 'block',
+    paddingInline: '4px !important',
+  },
+  '&light .cm-code-block': {
+    background: get(tokens, 'extend.colors.neutral.50'),
+  },
+  '&dark .cm-code-block': {
+    background: get(tokens, 'extend.colors.neutral.850'),
+  },
+  '& .cm-code-block-first': {
+    paddingTop: '4px !important',
+    borderTopLeftRadius: '4px',
+    borderTopRightRadius: '4px',
+  },
+  '& .cm-code-block-last': {
+    paddingBottom: '4px !important',
+    borderBottomLeftRadius: '4px',
+    borderBottomRightRadius: '4px',
+  },
+});
+
+const getLineRange = (lines: BlockInfo[], from: number, to: number) => {
+  const start = lines.findIndex((line) => line.from >= from);
+  const end = lines.findIndex((line) => line.to >= to);
+  return [start, end];
+};
+
+export const code = () => {
+  const getDecorations = (view: EditorView) => {
+    const decorations: Range<Decoration>[] = [];
+    if (view.state.readOnly) {
+      const text = view.state.doc.sliceString(0);
+      const matches = text.matchAll(CODE_REGEX);
+      const blocks = view.viewportLineBlocks;
+      for (const match of matches) {
+        const range = getLineRange(blocks, match.index!, match.index! + match[0].length);
+        for (let i = range[0]; i <= range[1]; i++) {
+          const block = blocks[i];
+          decorations.push(
+            Decoration.line({
+              class: mx(
+                'cm-code-block',
+                i === range[0] && 'cm-code-block-first',
+                i === range[1] && 'cm-code-block-last',
+              ),
+            }).range(block.from),
+          );
+        }
+      }
+    }
+
+    return Decoration.set(decorations);
+  };
+
+  return [
+    ViewPlugin.fromClass(
+      class {
+        decorations: DecorationSet;
+        constructor(view: EditorView) {
+          this.decorations = getDecorations(view);
+        }
+
+        update(update: ViewUpdate) {
+          if (update.docChanged || update.viewportChanged) {
+            this.decorations = getDecorations(update.view);
+          }
+        }
+      },
+      {
+        decorations: (value) => value.decorations,
+      },
+    ),
+    styles,
+  ];
+};

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

@@ -57,7 +57,7 @@ type CommentsInfo = {
 
 export type CommentsOptions = {
   key?: string;
-  onCreate?: () => string | void;
+  onCreate?: (from: number, to: number) => string | void;
   onUpdate?: (info: CommentsInfo) => void;
 };
 
@@ -108,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;
@@ -134,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): Handle multiple visible ranges in large documents.
-      const { from, to } = /* view.visibleRanges?.[0] ?? */ { from: 0, to: view.state.doc.length };
+      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));

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

@@ -92,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

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';