@dxos/react-ui-editor 0.3.10-next.c3f2d1d → 0.3.10-next.cec8a55

package/src/components/TextEditor/TextEditor.tsx

@@ -56,9 +56,10 @@ export type TextEditorSlots = {
 
 export type TextEditorProps = {
   model: EditorModel;
+  readonly?: boolean;
+  editorMode?: EditorMode;
   extensions?: Extension[];
   slots?: TextEditorSlots;
-  editorMode?: EditorMode;
 };
 
 /**
@@ -66,7 +67,7 @@ export type TextEditorProps = {
  * NOTE: Rather than adding properties, try to create extensions that can be reused.
  */
 export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
-  ({ model, extensions = [], slots = defaultSlots, editorMode }, forwardedRef) => {
+  ({ model, readonly, editorMode, extensions = [], slots = defaultSlots }, forwardedRef) => {
     const { themeMode } = useThemeContext();
     const tabsterDOMAttribute = useFocusableGroup({ tabBehavior: 'limited' });
 
@@ -87,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;
@@ -95,10 +102,13 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
       const state = EditorState.create({
         doc: model.text(),
         extensions: [
+          readonly && EditorState.readOnly.of(readonly),
+
           // TODO(burdon): Factor out VIM mode?
           editorMode === 'vim' && vim(),
 
           // Theme.
+          // TODO(burdon): Make optional.
           EditorView.baseTheme(defaultTheme),
           EditorView.theme(slots?.editor?.theme ?? {}),
           // TODO(burdon): themeMode doesn't change in storybooks.
@@ -116,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 () => {
@@ -124,7 +144,7 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
         setView(undefined);
         setState(undefined);
       };
-    }, [root, model, themeMode, editorMode]);
+    }, [root, model, themeMode, readonly, editorMode]);
 
     const handleKeyUp = useCallback(
       (event: KeyboardEvent) => {
@@ -157,15 +177,15 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
   },
 );
 
-// TODO(burdon): Set default text theme?
 export const TextEditor = forwardRef<TextEditorRef, TextEditorProps>(
-  ({ extensions = [], slots: _slots, ...props }, forwardedRef) => {
+  ({ readonly, extensions = [], slots: _slots, ...props }, forwardedRef) => {
     const { themeMode } = useThemeContext();
     const slots = defaultsDeep({}, _slots, defaultTextSlots);
     return (
       <BaseTextEditor
         ref={forwardedRef}
-        extensions={[basicBundle({ themeMode, placeholder: slots?.editor?.placeholder }), ...extensions]}
+        readonly={readonly}
+        extensions={[basicBundle({ readonly, themeMode, placeholder: slots?.editor?.placeholder }), ...extensions]}
         slots={slots}
         {...props}
       />
@@ -174,13 +194,14 @@ export const TextEditor = forwardRef<TextEditorRef, TextEditorProps>(
 );
 
 export const MarkdownEditor = forwardRef<TextEditorRef, TextEditorProps>(
-  ({ extensions = [], slots: _slots, ...props }, forwardedRef) => {
+  ({ readonly, extensions = [], slots: _slots, ...props }, forwardedRef) => {
     const { themeMode } = useThemeContext();
     const slots = defaultsDeep({}, _slots, defaultMarkdownSlots);
     return (
       <BaseTextEditor
         ref={forwardedRef}
-        extensions={[markdownBundle({ themeMode, placeholder: slots?.editor?.placeholder }), ...extensions]}
+        readonly={readonly}
+        extensions={[markdownBundle({ readonly, themeMode, placeholder: slots?.editor?.placeholder }), ...extensions]}
         slots={slots}
         {...props}
       />

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

@@ -2,23 +2,15 @@
 // Copyright 2023 DXOS.org
 //
 
-// TODO(burdon): Automcomplete: https://codemirror.net/5/doc/manual.html#addon_runmode
-// 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
-
 // https://codemirror.net/examples/autocompletion
 // https://codemirror.net/docs/ref/#autocomplete.autocompletion
 // https://codemirror.net/docs/ref/#autocomplete.Completion
 
 import {
   autocompletion,
+  completionKeymap,
   type Completion,
   type CompletionContext,
-  completionKeymap,
   type CompletionResult,
 } from '@codemirror/autocomplete';
 import { keymap } from '@codemirror/view';
@@ -51,21 +43,14 @@ export const autocomplete = ({ onSearch }: AutocompleteOptions) => {
       // TODO(burdon): Optional decoration via addToOptions
       override: [
         (context: CompletionContext): CompletionResult | null => {
-          const word = context.matchBefore(/\w*/);
-          if (!word || (word.from === word.to && !context.explicit)) {
+          const match = context.matchBefore(/\w*/);
+          if (!match || (match.from === match.to && !context.explicit)) {
             return null;
           }
 
-          // TODO(burdon): Option to convert to links?
           return {
-            from: word.from,
-            options: onSearch(word.text.toLowerCase()),
-            // options: [
-            //   { label: 'apple', type: 'keyword' },
-            //   { label: 'amazon', type: 'keyword' },
-            //   { label: 'hello', type: 'variable', info: '(World)' },
-            //   { label: 'magic', type: 'text', apply: '⠁⭒*.✩.*⭒⠁', detail: 'macro' },
-            // ],
+            from: match.from,
+            options: onSearch(match.text.toLowerCase()),
           };
         },
       ],

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

@@ -6,23 +6,25 @@ 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';
 
 export type BasicBundleOptions = {
+  readonly?: boolean;
   themeMode?: ThemeMode;
   placeholder?: string;
 };
 
-export const basicBundle = ({ themeMode, placeholder: _placeholder }: BasicBundleOptions): Extension[] =>
+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

@@ -0,0 +1,373 @@
+//
+// Copyright 2023 DXOS.org
+// Based on a demo by Joel Besada and Kushagra Gour.
+// https://twitter.com/JoelBesada/status/670343885655293952
+// https://github.com/chinchang/code-blast-codemirror/blob/master/code-blast.js
+//
+
+import { type Extension } from '@codemirror/state';
+import { EditorView, keymap } from '@codemirror/view';
+import defaultsDeep from 'lodash.defaultsdeep';
+
+import { invariant } from '@dxos/invariant';
+
+export type BlastOptions = {
+  effect?: number;
+  maxParticles: number;
+  particleGravity: number;
+  particleAlphaFadeout: number;
+  particleSize: { min: number; max: number };
+  particleNumRange: { min: number; max: number };
+  particleVelocityRange: { x: [number, number]; y: [number, number] };
+  particleShrinkRate: number;
+  shakeIntensity: number;
+  color?: () => number[];
+};
+
+export const defaultOptions: BlastOptions = {
+  effect: 2,
+  maxParticles: 200,
+  particleGravity: 0.08,
+  particleAlphaFadeout: 0.996,
+  particleSize: { min: 2, max: 8 },
+  particleNumRange: { min: 5, max: 10 },
+  particleVelocityRange: { x: [-1, 1], y: [-3.5, -1.5] },
+  particleShrinkRate: 0.95,
+  shakeIntensity: 5,
+};
+
+export const blast = (options: Partial<BlastOptions> = defaultOptions): Extension => {
+  let blaster: Blaster | undefined;
+  let last = 0;
+
+  const getPoint = (view: EditorView, pos: number) => {
+    const { left: x = 0, top: y = 0 } = view.coordsForChar(pos) ?? {};
+    const element = document.elementFromPoint(x, y);
+
+    const { offsetLeft: left = 0, offsetTop: top = 0 } = view.scrollDOM.parentElement ?? {};
+    const point = { x: x - left, y: y - top };
+
+    return { element, point };
+  };
+
+  return [
+    // Cursor moved.
+    EditorView.updateListener.of((update) => {
+      // NOTE: The MarkdownEditor may recreated the EditorView.
+      if (blaster?.node !== update.view.scrollDOM) {
+        if (blaster) {
+          blaster.destroy();
+        }
+
+        blaster = new Blaster(
+          update.view.scrollDOM,
+          defaultsDeep(
+            {
+              particleGravity: 0.2,
+              particleShrinkRate: 0.995,
+              color: () => [100 + Math.random() * 100, 0, 0],
+            },
+            options,
+            defaultOptions,
+          ),
+        );
+        blaster.initialize();
+        blaster.start(); // TODO(burdon): Stop/clean-up.
+      } else {
+        blaster.resize();
+      }
+
+      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 - 1);
+        if (element && point) {
+          blaster.spawn({ element, point });
+        }
+      }
+    }),
+
+    keymap.of([
+      {
+        any: (_, event) => {
+          if (blaster) {
+            if (event.key === 'Enter' && event.shiftKey) {
+              blaster.shake({ time: 0.8 });
+              return true;
+            }
+          }
+
+          return false;
+        },
+      },
+    ]),
+  ];
+};
+
+//
+// Blaster (no CM deps).
+//
+
+class Blaster {
+  private readonly _effect: Effect;
+
+  _canvas: HTMLCanvasElement | undefined;
+  _ctx: CanvasRenderingContext2D | undefined | null;
+
+  _running = false;
+  _lastTime: number | undefined;
+  _shakeTime = 0;
+  _shakeTimeMax = 0;
+
+  _particles: Particle[] = [];
+  _particlePointer = 0;
+
+  _lastPoint = { x: 0, y: 0 };
+
+  constructor(private readonly _node: HTMLElement, private readonly _options: BlastOptions) {
+    this._effect = this._options.effect === 1 ? new Effect1(_options) : new Effect2(_options);
+  }
+
+  get node() {
+    return this._node;
+  }
+
+  initialize() {
+    // console.log('initialize');
+    invariant(!this._canvas && !this._ctx);
+
+    this._canvas = document.createElement('canvas');
+    this._canvas.id = 'code-blast-canvas';
+    this._canvas.style.position = 'absolute';
+    this._canvas.style.zIndex = '0';
+    this._canvas.style.pointerEvents = 'none';
+    // this._canvas.style.border = '2px dashed red';
+
+    this._ctx = this._canvas.getContext('2d');
+
+    const parent = this._node.parentElement?.parentElement;
+    parent?.appendChild(this._canvas);
+
+    this.resize();
+  }
+
+  destroy() {
+    this.stop();
+    // console.log('destroy');
+    if (this._canvas) {
+      this._canvas.remove();
+      this._canvas = undefined;
+      this._ctx = undefined;
+    }
+  }
+
+  resize() {
+    if (this._node.parentElement && this._canvas) {
+      const { offsetLeft: x, offsetTop: y, offsetWidth: width, offsetHeight: height } = this._node.parentElement;
+      this._canvas.style.top = `${y}px`;
+      this._canvas.style.left = `${x}px`;
+      this._canvas.width = width;
+      this._canvas.height = height;
+    }
+  }
+
+  start() {
+    // console.log('start');
+    invariant(this._canvas && this._ctx);
+    this._running = true;
+    this.loop();
+  }
+
+  stop() {
+    // console.log('stop');
+    this._running = false;
+    this._node.style.transform = 'translate(0px, 0px)';
+  }
+
+  loop() {
+    if (!this._running || !this._canvas || !this._ctx) {
+      return;
+    }
+
+    this._ctx.clearRect(0, 0, this._canvas.width ?? 0, this._canvas.height ?? 0);
+
+    // Calculate the delta from the previous frame.
+    const now = new Date().getTime();
+    this._lastTime ??= now;
+    const dt = (now - this._lastTime) / 1000;
+    this._lastTime = now;
+
+    if (this._shakeTime > 0) {
+      this._shakeTime -= dt;
+      const magnitude = (this._shakeTime / this._shakeTimeMax) * this._options.shakeIntensity;
+      const shakeX = random(-magnitude, magnitude);
+      const shakeY = random(-magnitude, magnitude);
+      this._node!.style.transform = `translate(${shakeX}px,${shakeY}px)`;
+    }
+
+    this.drawParticles();
+
+    requestAnimationFrame(this.loop.bind(this));
+  }
+
+  shake = throttle<{ time: number }>(({ time }) => {
+    this._shakeTime = this._shakeTimeMax || time;
+    this._shakeTimeMax = time;
+  }, 100);
+
+  spawn = throttle<{ element: Element; point: { x: number; y: number } }>(({ element, point }) => {
+    const color = getRGBComponents(element, this._options.color);
+    const numParticles = random(this._options.particleNumRange.min, this._options.particleNumRange.max);
+    const dir = this._lastPoint.x === point.x ? 0 : this._lastPoint.x < point.x ? 1 : -1;
+    this._lastPoint = point;
+    for (let i = numParticles; i--; i > 0) {
+      this._particles[this._particlePointer] = this._effect.create(point.x - dir * 16, point.y, color);
+      this._particlePointer = (this._particlePointer + 1) % this._options.maxParticles;
+    }
+  }, 100);
+
+  drawParticles() {
+    for (let i = this._particles.length; i--; i > 0) {
+      const particle = this._particles[i];
+      if (!particle) {
+        continue;
+      }
+
+      if (particle.alpha < 0.01 || particle.size <= 0.5) {
+        continue;
+      }
+
+      this._effect.update(this._ctx!, particle);
+    }
+  }
+}
+
+//
+// Effects
+//
+
+type Particle = {
+  x: number;
+  y: number;
+  vx: number;
+  vy: number;
+  size: number;
+  color: (string | number)[];
+  alpha: number;
+  theta?: number;
+  drag?: number;
+  wander?: number;
+};
+
+abstract class Effect {
+  constructor(protected readonly _options: BlastOptions) {}
+  abstract create(x: number, y: number, color: Particle['color']): Particle;
+  abstract update(ctx: CanvasRenderingContext2D, particle: Particle): void;
+}
+
+class Effect1 extends Effect {
+  create(x: number, y: number, color: Particle['color']) {
+    return {
+      x,
+      y: y + 10,
+      vx: random(this._options.particleVelocityRange.x[0], this._options.particleVelocityRange.x[1]),
+      vy: random(this._options.particleVelocityRange.y[0], this._options.particleVelocityRange.y[1]),
+      size: random(this._options.particleSize.min, this._options.particleSize.max),
+      color,
+      alpha: 1,
+    };
+  }
+
+  update(ctx: CanvasRenderingContext2D, particle: Particle) {
+    particle.vy += this._options.particleGravity;
+    particle.x += particle.vx;
+    particle.y += particle.vy;
+    particle.alpha *= this._options.particleAlphaFadeout;
+
+    ctx.fillStyle = `rgba(${particle.color[0]},${particle.color[1]},${particle.color[2]},${particle.alpha})`;
+    ctx.fillRect(Math.round(particle.x - 1), Math.round(particle.y - 1), particle.size, particle.size);
+  }
+}
+
+/**
+ * Based on Soulwire's demo.
+ * http://codepen.io/soulwire/pen/foktm
+ */
+class Effect2 extends Effect {
+  create(x: number, y: number, color: Particle['color']) {
+    return {
+      x,
+      y: y + 10,
+      vx: random(this._options.particleVelocityRange.x[0], this._options.particleVelocityRange.x[1]),
+      vy: random(this._options.particleVelocityRange.y[0], this._options.particleVelocityRange.y[1]),
+      size: random(this._options.particleSize.min, this._options.particleSize.max),
+      color,
+      alpha: 1,
+      theta: (random(0, 360) * Math.PI) / 180,
+      drag: 0.92,
+      wander: 0.15,
+    };
+  }
+
+  update(ctx: CanvasRenderingContext2D, particle: Particle) {
+    particle.vy += this._options.particleGravity;
+    particle.x += particle.vx;
+    particle.y += particle.vy;
+    particle.vx *= particle.drag!;
+    particle.vy *= particle.drag!;
+    particle.theta! += random(-0.5, 0.5);
+    particle.vx += Math.sin(particle.theta!) * 0.1;
+    particle.vy += Math.cos(particle.theta!) * 0.1;
+    particle.size *= this._options.particleShrinkRate;
+    particle.alpha *= this._options.particleAlphaFadeout;
+
+    ctx.fillStyle = `rgba(${particle.color[0]},${particle.color[1]},${particle.color[2]},${particle.alpha})`;
+    ctx.beginPath();
+    ctx.arc(Math.round(particle.x - 1), Math.round(particle.y - 1), particle.size, 0, 2 * Math.PI);
+    ctx.fill();
+  }
+}
+
+//
+// Utils
+//
+
+function throttle<T>(callback: (arg: T) => void, limit: number): (arg: T) => void {
+  let wait = false;
+  return function (...args: any[]) {
+    if (!wait) {
+      // @ts-ignore
+      callback.apply(this, args);
+      wait = true;
+      setTimeout(() => {
+        wait = false;
+      }, limit);
+    }
+  };
+}
+
+const getRGBComponents = (node: Element, color: BlastOptions['color']): Particle['color'] => {
+  if (typeof color === 'function') {
+    return color();
+  }
+
+  const bgColor = getComputedStyle(node).color;
+  if (bgColor) {
+    const x = bgColor.match(/(\d+), (\d+), (\d+)/)?.slice(1);
+    if (x) {
+      return x;
+    }
+  }
+
+  return [50, 50, 50];
+};
+
+const random = (min: number, max: number) => {
+  if (!max) {
+    max = min;
+    min = 0;
+  }
+
+  return min + ~~(Math.random() * (max - min + 1));
+};

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,
+  ];
+};