@dxos/react-ui-editor 0.3.10-next.ef70620 → 0.3.11-main.008b7c6

package/src/extensions/awareness.ts

@@ -0,0 +1,316 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Annotation, Facet, type Extension, RangeSet, type Range } from '@codemirror/state';
+import {
+  Decoration,
+  type DecorationSet,
+  EditorView,
+  type PluginValue,
+  ViewPlugin,
+  type ViewUpdate,
+  WidgetType,
+} from '@codemirror/view';
+
+import { Event } from '@dxos/async';
+import { Context } from '@dxos/context';
+
+import { CursorConverter } from '../util';
+
+export interface AwarenessProvider {
+  remoteStateChange: Event<void>;
+
+  open(): void;
+  close(): void;
+
+  update(position: AwarenessPosition | undefined): void;
+  getRemoteStates(): AwarenessState[];
+}
+
+const dummyProvider: AwarenessProvider = {
+  remoteStateChange: new Event(),
+
+  open: () => {},
+  close: () => {},
+
+  update: () => {},
+  getRemoteStates: () => [],
+};
+
+export const AwarenessProvider = Facet.define<AwarenessProvider, AwarenessProvider>({
+  combine: (providers) => providers[0] ?? dummyProvider,
+});
+
+// TODO(dmaretskyi): Specify the users that actually changed. Currently, we recalculate positions for every user.
+const RemoteSelectionChangedAnnotation = Annotation.define();
+
+export type AwarenessPosition = {
+  anchor?: string;
+  head?: string;
+};
+
+export type AwarenessInfo = {
+  displayName?: string;
+  // TODO(burdon): Rename light/dark.
+  color?: string;
+  lightColor?: string;
+};
+
+export type AwarenessState = {
+  position?: AwarenessPosition;
+  peerId: string;
+  info: AwarenessInfo;
+};
+
+/**
+ * Extension provides presence information about other peers.
+ */
+// TODO(burdon): Why provide default?
+export const awareness = (provider = dummyProvider): Extension => {
+  return [
+    AwarenessProvider.of(provider),
+    ViewPlugin.fromClass(RemoteSelectionsDecorator, {
+      decorations: (value) => value.decorations,
+    }),
+    styles,
+  ];
+};
+
+/**
+ * Generates selection decorations from remote peers.
+ */
+export class RemoteSelectionsDecorator implements PluginValue {
+  public decorations: DecorationSet = RangeSet.of([]);
+
+  private readonly _ctx = new Context();
+
+  private _cursorConverter: CursorConverter;
+  private _provider: AwarenessProvider;
+  private _lastAnchor?: number = undefined;
+  private _lastHead?: number = undefined;
+
+  constructor(view: EditorView) {
+    this._cursorConverter = view.state.facet(CursorConverter);
+    this._provider = view.state.facet(AwarenessProvider);
+    this._provider.open();
+    this._provider.remoteStateChange.on(this._ctx, () => {
+      view.dispatch({ annotations: [RemoteSelectionChangedAnnotation.of([])] });
+    });
+  }
+
+  destroy() {
+    void this._ctx.dispose();
+    this._provider.close();
+  }
+
+  update(update: ViewUpdate) {
+    this._updateLocalSelection(update);
+    this._updateRemoteSelections(update);
+  }
+
+  private _updateLocalSelection(update: ViewUpdate) {
+    const hasFocus = update.view.hasFocus && update.view.dom.ownerDocument.hasFocus();
+    const { anchor = undefined, head = undefined } = hasFocus ? update.state.selection.main : {};
+    if (this._lastAnchor === anchor && this._lastHead === head) {
+      return;
+    }
+
+    this._lastAnchor = anchor;
+    this._lastHead = head;
+
+    this._provider.update(
+      anchor !== undefined && head !== undefined
+        ? {
+            anchor: this._cursorConverter.toCursor(anchor),
+            head: this._cursorConverter.toCursor(head),
+          }
+        : undefined,
+    );
+  }
+
+  private _updateRemoteSelections(update: ViewUpdate) {
+    const decorations: Range<Decoration>[] = [];
+    const awarenessStates = this._provider.getRemoteStates();
+    for (const state of awarenessStates) {
+      const anchor = state.position?.anchor ? this._cursorConverter.fromCursor(state.position.anchor) : null;
+      const head = state.position?.head ? this._cursorConverter.fromCursor(state.position.head) : null;
+      if (anchor == null || head == null) {
+        continue;
+      }
+
+      const start = Math.min(Math.min(anchor, head), update.view.state.doc.length);
+      const end = Math.min(Math.max(anchor, head), update.view.state.doc.length);
+
+      const startLine = update.view.state.doc.lineAt(start);
+      const endLine = update.view.state.doc.lineAt(end);
+
+      // TODO(burdon): Factor out styles.
+      const color = state.info.color ?? '#30bced';
+      const lightColor = state.info.lightColor ?? color + '33';
+
+      if (startLine.number === endLine.number) {
+        // Selected content in a single line.
+        decorations.push({
+          from: start,
+          to: end,
+          value: Decoration.mark({
+            attributes: { style: `background-color: ${lightColor}` },
+            class: 'cm-ySelection',
+          }),
+        });
+      } else {
+        // Selected content in multiple lines; first, render text-selection in the first line.
+        decorations.push({
+          from: start,
+          to: startLine.from + startLine.length,
+          value: Decoration.mark({
+            attributes: { style: `background-color: ${color}` },
+            class: 'cm-ySelection',
+          }),
+        });
+
+        // Render text-selection in the last line.
+        decorations.push({
+          from: endLine.from,
+          to: end,
+          value: Decoration.mark({
+            attributes: { style: `background-color: ${color}` },
+            class: 'cm-ySelection',
+          }),
+        });
+
+        for (let i = startLine.number + 1; i < endLine.number; i++) {
+          const linePos = update.view.state.doc.line(i).from;
+          decorations.push({
+            from: linePos,
+            to: linePos,
+            value: Decoration.line({
+              attributes: { style: `background-color: ${color}`, class: 'cm-yLineSelection' },
+            }),
+          });
+        }
+      }
+
+      decorations.push({
+        from: head,
+        to: head,
+        value: Decoration.widget({
+          side: head - anchor > 0 ? -1 : 1, // The local cursor should be rendered outside the remote selection.
+          block: false,
+          widget: new RemoteCaretWidget(state.info.displayName ?? 'Anonymous', color),
+        }),
+      });
+    }
+
+    this.decorations = Decoration.set(decorations, true);
+  }
+}
+
+class RemoteCaretWidget extends WidgetType {
+  constructor(public name: string, public color: string) {
+    super();
+    this.name = name;
+    this.color = color;
+  }
+
+  toDOM(): HTMLElement {
+    const span = document.createElement('span');
+    span.className = 'cm-ySelectionCaret';
+    span.style.backgroundColor = this.color;
+    span.style.borderColor = this.color;
+
+    const dot = document.createElement('div');
+    dot.className = 'cm-ySelectionCaretDot';
+
+    const info = document.createElement('div');
+    info.className = 'cm-ySelectionInfo';
+    info.innerText = this.name;
+
+    span.appendChild(document.createTextNode('\u2060'));
+    span.appendChild(dot);
+    span.appendChild(document.createTextNode('\u2060'));
+    span.appendChild(info);
+    span.appendChild(document.createTextNode('\u2060'));
+
+    return span;
+  }
+
+  override eq(widget: this) {
+    return widget.color === this.color;
+  }
+
+  compare(widget: this) {
+    return widget.color === this.color;
+  }
+
+  override updateDOM() {
+    return false;
+  }
+
+  override get estimatedHeight() {
+    return -1;
+  }
+
+  override ignoreEvent() {
+    return true;
+  }
+}
+
+// TODO(burdon): Rename prefix (y for yjs?)
+const styles = EditorView.baseTheme({
+  '.cm-ySelection': {},
+  '.cm-yLineSelection': {
+    padding: 0,
+    margin: '0px 2px 0px 4px',
+  },
+  '.cm-ySelectionCaret': {
+    position: 'relative',
+    borderLeft: '1px solid black',
+    borderRight: '1px solid black',
+    marginLeft: '-1px',
+    marginRight: '-1px',
+    boxSizing: 'border-box',
+    display: 'inline',
+  },
+  '.cm-ySelectionCaretDot': {
+    borderRadius: '50%',
+    position: 'absolute',
+    width: '.4em',
+    height: '.4em',
+    top: '-.2em',
+    left: '-.2em',
+    backgroundColor: 'inherit',
+    transition: 'transform .3s ease-in-out',
+    boxSizing: 'border-box',
+  },
+  '.cm-ySelectionCaret:hover > .cm-ySelectionCaretDot': {
+    transformOrigin: 'bottom center',
+    transform: 'scale(0)',
+  },
+  '.cm-ySelectionInfo': {
+    position: 'absolute',
+    top: '-1.05em',
+    left: '-1px',
+    fontSize: '.75em',
+    fontFamily: 'serif',
+    fontStyle: 'normal',
+    fontWeight: 'normal',
+    lineHeight: 'normal',
+    userSelect: 'none',
+    color: 'white',
+    paddingLeft: '2px',
+    paddingRight: '2px',
+    zIndex: 101,
+    transition: 'opacity .3s ease-in-out',
+    backgroundColor: 'inherit',
+    // these should be separate
+    opacity: 0,
+    transitionDelay: '0s',
+    whiteSpace: 'nowrap',
+  },
+  '.cm-ySelectionCaret:hover > .cm-ySelectionInfo': {
+    opacity: 1,
+    transitionDelay: '0s',
+  },
+});

package/src/{components/TextEditor/extensions/basic/bundle.ts → extensions/basic.ts}

@@ -6,23 +6,27 @@ 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(),
+    drawSelection(),
     _placeholder && placeholder(_placeholder),
 
-    EditorView.lineWrapping,
-
     // TODO(burdon): Is this required?
     themeMode === 'dark' ? syntaxHighlighting(oneDarkHighlightStyle) : syntaxHighlighting(defaultHighlightStyle),
   ].filter(Boolean) as Extension[];

package/src/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));
+};