@dxos/react-ui-editor 0.3.10-main.90b298e → 0.3.10-main.92d1f2c

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

@@ -0,0 +1,387 @@
+//
+// 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, StateField } 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>): 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.view.state.selection.main.head;
+      if (current !== last) {
+        last = current;
+        // TODO(burdon): Null if end of line.
+        const { element, point } = getPoint(update.view, current);
+        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 });
+          }
+
+          return false;
+        },
+      },
+    ]),
+  ];
+};
+
+//
+// Blaster (no CM deps).
+//
+
+class Blaster {
+  _canvas: HTMLCanvasElement | undefined;
+  _ctx: CanvasRenderingContext2D | undefined | null;
+
+  private readonly _effect: Effect;
+
+  _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 solid 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;
+    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/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/demo.ts

@@ -2,8 +2,11 @@
 // Copyright 2023 DXOS.org
 //
 
+import { type Extension } from '@codemirror/state';
 import { keymap } from '@codemirror/view';
 
+// TODO(burdon): Review https://github.com/sergeche/codemirror-movie?tab=readme-ov-file
+
 export type DemoOptions = {
   delay?: number;
   items?: string[];
@@ -15,7 +18,7 @@ const defaultItems = ['hello world!', 'this is a test.', 'this is [DXOS](https:/
  * Demo script.
  * Configurable plugin that let's user cycle through pre-configured input script.
  */
-export const demo = ({ delay = 75, items = defaultItems }: DemoOptions = {}) => {
+export const demo = ({ delay = 75, items = defaultItems }: DemoOptions = {}): Extension => {
   let t: any;
   let idx = 0;
 

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

@@ -0,0 +1,67 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { syntaxTree } from '@codemirror/language';
+import {
+  type EditorState,
+  type Extension,
+  type RangeSet,
+  RangeSetBuilder,
+  StateField,
+  type Transaction,
+} from '@codemirror/state';
+import { Decoration, EditorView, WidgetType } from '@codemirror/view';
+
+export type ImageOptions = {};
+
+export const image = (options: ImageOptions = {}): Extension => {
+  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),
+  });
+};
+
+const update = (state: EditorState, options: ImageOptions) => {
+  const builder = new RangeSetBuilder();
+  const cursor = state.selection.main.head;
+
+  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(
+            hide ? node.from : node.to,
+            node.to,
+            Decoration.replace({
+              widget: new ImageWidget(url),
+            }),
+          );
+        }
+      }
+    },
+  });
+
+  return builder.finish();
+};
+
+class ImageWidget extends WidgetType {
+  constructor(readonly _url: string) {
+    super();
+  }
+
+  override eq(other: WidgetType) {
+    return this._url === (other as any as ImageWidget)?._url;
+  }
+
+  toDOM(view: EditorView) {
+    const img = document.createElement('img');
+    img.setAttribute('src', this._url);
+    img.setAttribute('class', 'cm-image');
+    return img;
+  }
+}

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

@@ -4,10 +4,14 @@
 
 export * from './autocomplete';
 export * from './basic';
+export * from './blast';
 export * from './demo';
 export * from './comments';
+export * from './image';
 export * from './link';
 export * from './listener';
 export * from './markdown';
+export * from './mention';
+export * from './table';
 export * from './tasklist';
 export * from './tooltip';