@dxos/react-ui-editor 0.8.4-main.b97322e → 0.8.4-main.bcb3aa67d6

package/src/extensions/command/action.ts

@@ -1,56 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { StateEffect } from '@codemirror/state';
-import { type KeyBinding, type Command, type EditorView } from '@codemirror/view';
-
-import { commandState } from './state';
-
-export type Action =
-  | {
-      type: 'insert';
-      text: string;
-    }
-  | {
-      type: 'cancel';
-    };
-
-export type ActionHandler = (action: Action) => void;
-
-export const openEffect = StateEffect.define<{ pos: number; fullWidth?: boolean }>();
-export const closeEffect = StateEffect.define<null>();
-
-export const openCommand: Command = (view: EditorView) => {
-  if (view.state.field(commandState, false)) {
-    const selection = view.state.selection.main;
-    const line = view.state.doc.lineAt(selection.from);
-    if (line.from === selection.from && line.from === line.to) {
-      view.dispatch({ effects: openEffect.of({ pos: selection.anchor, fullWidth: true }) });
-      return true;
-    }
-  }
-
-  return false;
-};
-
-export const closeCommand: Command = (view: EditorView) => {
-  if (view.state.field(commandState, false)) {
-    view.dispatch({ effects: closeEffect.of(null) });
-    return true;
-  }
-
-  return false;
-};
-
-export const commandKeyBindings: readonly KeyBinding[] = [
-  {
-    key: '/',
-    preventDefault: true,
-    run: openCommand,
-  },
-  {
-    key: 'Escape',
-    run: closeCommand,
-  },
-];

package/src/extensions/command/command-menu.ts

@@ -1,210 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { RangeSetBuilder, StateField, StateEffect, Prec } from '@codemirror/state';
-import { EditorView, ViewPlugin, type ViewUpdate, Decoration, keymap, type DecorationSet } from '@codemirror/view';
-
-import { placeholder, type PlaceholderOptions } from './placeholder';
-import { type Range } from '../../types';
-
-export type CommandMenuOptions = {
-  trigger: string | string[];
-  placeholder?: Partial<PlaceholderOptions>;
-
-  // TODO(burdon): Replace with onKey?
-  onClose?: () => void;
-  onArrowDown?: () => void;
-  onArrowUp?: () => void;
-  onEnter?: () => void;
-
-  onTextChange?: (trigger: string, text: string) => void;
-};
-
-export const commandMenu = (options: CommandMenuOptions) => {
-  const commandMenuPlugin = ViewPlugin.fromClass(
-    class {
-      decorations: DecorationSet = Decoration.none;
-
-      constructor(readonly view: EditorView) {}
-
-      // TODO(wittjosiah): The decorations are repainted on every update, this occasionally causes menu to flicker.
-      update(update: ViewUpdate) {
-        const builder = new RangeSetBuilder<Decoration>();
-        const selection = update.view.state.selection.main;
-        const { range: activeRange, trigger } = update.view.state.field(commandMenuState) ?? {};
-
-        // Check if we should show the widget - only if cursor is within the active command range.
-        const shouldShowWidget = activeRange && selection.head >= activeRange.from && selection.head <= activeRange.to;
-        if (shouldShowWidget) {
-          // Create mark decoration that wraps the entire line content in a dx-ref-tag.
-          builder.add(
-            activeRange.from,
-            activeRange.to,
-            Decoration.mark({
-              tagName: 'dx-ref-tag',
-              class: 'cm-ref-tag',
-              attributes: {
-                'data-auto-trigger': 'true',
-                'data-trigger': trigger!,
-              },
-            }),
-          );
-        }
-
-        const activeRangeChanged = update.transactions.some((tr) =>
-          tr.effects.some((effect) => effect.is(commandRangeEffect)),
-        );
-        if (activeRange && activeRangeChanged && trigger) {
-          const content = update.view.state.sliceDoc(
-            activeRange.from + 1, // Skip the trigger character.
-            activeRange.to,
-          );
-          options.onTextChange?.(trigger, content);
-        }
-
-        this.decorations = builder.finish();
-      }
-    },
-    {
-      decorations: (v) => v.decorations,
-    },
-  );
-
-  const triggers = Array.isArray(options.trigger) ? options.trigger : [options.trigger];
-
-  const commandKeymap = keymap.of([
-    ...triggers.map((trigger) => ({
-      key: trigger,
-      preventDefault: true,
-      run: (view: EditorView) => {
-        const selection = view.state.selection.main;
-        const line = view.state.doc.lineAt(selection.head);
-
-        // Check if we should trigger the command menu:
-        // 1. Empty lines or at the beginning of a line
-        // 2. When there's a preceding space
-        if (
-          line.text.trim() === '' ||
-          selection.head === line.from ||
-          (selection.head > line.from && line.text[selection.head - line.from - 1] === ' ')
-        ) {
-          // Insert and select the trigger.
-          view.dispatch({
-            changes: { from: selection.head, insert: trigger },
-            selection: { anchor: selection.head + 1, head: selection.head + 1 },
-            effects: commandRangeEffect.of({ trigger, range: { from: selection.head, to: selection.head + 1 } }),
-          });
-
-          return true;
-        }
-
-        return false;
-      },
-    })),
-    {
-      key: 'Enter',
-      run: (view) => {
-        const activeRange = view.state.field(commandMenuState)?.range;
-        if (activeRange) {
-          view.dispatch({ changes: { from: activeRange.from, to: activeRange.to, insert: '' } });
-          options.onEnter?.();
-          return true;
-        }
-
-        return false;
-      },
-    },
-    {
-      key: 'ArrowDown',
-      run: (view) => {
-        const activeRange = view.state.field(commandMenuState)?.range;
-        if (activeRange) {
-          options.onArrowDown?.();
-          return true;
-        }
-
-        return false;
-      },
-    },
-    {
-      key: 'ArrowUp',
-      run: (view) => {
-        const activeRange = view.state.field(commandMenuState)?.range;
-        if (activeRange) {
-          options.onArrowUp?.();
-          return true;
-        }
-
-        return false;
-      },
-    },
-  ]);
-
-  // Listen for selection and document changes to clean up the command menu.
-  const updateListener = EditorView.updateListener.of((update) => {
-    const { trigger, range: activeRange } = update.view.state.field(commandMenuState) ?? {};
-    if (!activeRange || !trigger) {
-      return;
-    }
-
-    const selection = update.view.state.selection.main;
-    const firstChar = update.view.state.doc.sliceString(activeRange.from, activeRange.from + 1);
-    const shouldRemove =
-      firstChar !== trigger || // Trigger deleted.
-      selection.head < activeRange.from || // Cursor moved before the range.
-      selection.head > activeRange.to + 1; // Cursor moved after the range (+1 to handle selection changing before doc).
-
-    const nextRange = shouldRemove
-      ? null
-      : update.docChanged
-        ? { from: activeRange.from, to: selection.head }
-        : activeRange;
-    if (nextRange !== activeRange) {
-      update.view.dispatch({ effects: commandRangeEffect.of(nextRange ? { trigger, range: nextRange } : null) });
-    }
-
-    // TODO(burdon): Should delete if user presses escape? How else to insert the trigger character?
-    if (shouldRemove) {
-      options.onClose?.();
-    }
-  });
-
-  return [
-    Prec.highest(commandKeymap),
-    placeholder(
-      Object.assign(
-        {
-          content: `Press '${Array.isArray(options.trigger) ? options.trigger[0] : options.trigger}' for commands`,
-        },
-        options.placeholder,
-      ),
-    ),
-    updateListener,
-    commandMenuState,
-    commandMenuPlugin,
-  ];
-};
-
-type CommandState = {
-  trigger: string;
-  range: Range;
-};
-
-// State effects for managing command menu state.
-export const commandRangeEffect = StateEffect.define<CommandState | null>();
-
-// State field to track the active command menu range.
-const commandMenuState = StateField.define<CommandState | null>({
-  create: () => null,
-  update: (value, tr) => {
-    let newValue = value;
-    for (const effect of tr.effects) {
-      if (effect.is(commandRangeEffect)) {
-        newValue = effect.value;
-      }
-    }
-
-    return newValue;
-  },
-});

package/src/extensions/command/command.ts

@@ -1,34 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Prec, type Extension } from '@codemirror/state';
-import { EditorView, keymap } from '@codemirror/view';
-
-import { isNonNullable } from '@dxos/util';
-
-import { closeEffect, commandKeyBindings } from './action';
-import { hint, type HintOptions } from './hint';
-import { commandConfig, commandState, type PopupOptions } from './state';
-
-// TODO(burdon): Create knowledge base for CM notes and ideas.
-// https://discuss.codemirror.net/t/inline-code-hints-like-vscode/5533/4
-// https://github.com/saminzadeh/codemirror-extension-inline-suggestion
-// https://github.com/ChromeDevTools/devtools-frontend/blob/main/front_end/ui/components/text_editor/config.ts#L370
-
-export type CommandOptions = Partial<PopupOptions & HintOptions>;
-
-export const command = (options: CommandOptions = {}): Extension => {
-  return [
-    Prec.highest(keymap.of(commandKeyBindings)),
-    commandConfig.of(options),
-    commandState,
-    options.onHint && hint(options),
-    EditorView.focusChangeEffect.of((_, focusing) => (focusing ? closeEffect.of(null) : null)),
-    EditorView.theme({
-      '.cm-tooltip': {
-        background: 'transparent',
-      },
-    }),
-  ].filter(isNonNullable);
-};

package/src/extensions/command/floating-menu.ts

@@ -1,133 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { EditorView, ViewPlugin, type ViewUpdate } from '@codemirror/view';
-
-import { type CleanupFn, addEventListener } from '@dxos/async';
-
-import { closeEffect, openEffect } from './action';
-
-export type FloatingMenuOptions = {
-  icon?: string;
-  height?: number;
-  padding?: number;
-};
-
-export const floatingMenu = (options: FloatingMenuOptions = {}) => [
-  ViewPlugin.fromClass(
-    class {
-      view: EditorView;
-      tag: HTMLElement;
-      rafId?: number | null;
-      cleanup?: CleanupFn;
-
-      constructor(view: EditorView) {
-        this.view = view;
-
-        // Position context.
-        const container = view.scrollDOM;
-        if (getComputedStyle(container).position === 'static') {
-          container.style.position = 'relative';
-        }
-
-        {
-          const icon = document.createElement('dx-icon');
-          icon.setAttribute('icon', options.icon ?? 'ph--dots-three-vertical--regular');
-          const button = document.createElement('button');
-          button.appendChild(icon);
-
-          this.tag = document.createElement('dx-ref-tag');
-          this.tag.classList.add('cm-ref-tag');
-          this.tag.appendChild(button);
-        }
-
-        container.appendChild(this.tag);
-
-        // Listen for scroll events.
-        const handler = () => this.scheduleUpdate();
-        this.cleanup = addEventListener(container, 'scroll', handler);
-        this.scheduleUpdate();
-      }
-
-      destroy() {
-        this.cleanup?.();
-        this.tag.remove();
-        if (this.rafId != null) {
-          cancelAnimationFrame(this.rafId);
-        }
-      }
-
-      update(update: ViewUpdate) {
-        this.tag.dataset.focused = update.view.hasFocus ? 'true' : 'false';
-        if (!update.view.hasFocus) {
-          return;
-        }
-
-        // TODO(burdon): Timer to fade in/out.
-        if (update.transactions.some((tr) => tr.effects.some((effect) => effect.is(openEffect)))) {
-          this.tag.style.display = 'none';
-          this.tag.classList.add('opacity-10');
-        } else if (update.transactions.some((tr) => tr.effects.some((effect) => effect.is(closeEffect)))) {
-          this.tag.style.display = 'block';
-        } else if (
-          update.docChanged ||
-          update.focusChanged ||
-          update.geometryChanged ||
-          update.selectionSet ||
-          update.viewportChanged
-        ) {
-          this.scheduleUpdate();
-        }
-      }
-
-      updateButtonPosition() {
-        const { x, width } = this.view.contentDOM.getBoundingClientRect();
-
-        const pos = this.view.state.selection.main.head;
-        const line = this.view.lineBlockAt(pos);
-        const coords = this.view.coordsAtPos(line.from);
-        if (!coords) {
-          return;
-        }
-
-        const lineHeight = coords.bottom - coords.top;
-        const dy = (lineHeight - (options.height ?? 32)) / 2;
-
-        const offsetTop = coords.top + dy;
-        const offsetLeft = x + width + (options.padding ?? 8);
-
-        this.tag.style.top = `${offsetTop}px`;
-        this.tag.style.left = `${offsetLeft}px`;
-        this.tag.style.display = 'block';
-      }
-
-      scheduleUpdate() {
-        if (this.rafId != null) {
-          cancelAnimationFrame(this.rafId);
-        }
-
-        this.rafId = requestAnimationFrame(this.updateButtonPosition.bind(this));
-      }
-    },
-  ),
-
-  EditorView.theme({
-    '.cm-ref-tag': {
-      position: 'fixed',
-      padding: '0',
-      border: 'none',
-      opacity: '0',
-    },
-    '[data-has-focus] & .cm-ref-tag': {
-      opacity: '1',
-    },
-    '.cm-ref-tag button': {
-      display: 'grid',
-      alignItems: 'center',
-      justifyContent: 'center',
-      width: '2rem',
-      height: '2rem',
-    },
-  }),
-];

package/src/extensions/command/hint.ts

@@ -1,102 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-// Based on https://github.com/codemirror/view/blob/main/src/placeholder.ts
-//
-
-import { RangeSetBuilder } from '@codemirror/state';
-import { Decoration, EditorView, ViewPlugin, type ViewUpdate, WidgetType } from '@codemirror/view';
-
-import { commandState } from './state';
-import { clientRectsFor, flattenRect } from '../../util';
-
-export type HintOptions = {
-  delay?: number;
-  onHint?: () => string | undefined;
-};
-
-export const hint = ({ delay = 3_000, onHint }: HintOptions) => {
-  return ViewPlugin.fromClass(
-    class {
-      decorations = Decoration.none;
-      timeout: ReturnType<typeof setTimeout> | undefined;
-
-      update(update: ViewUpdate) {
-        if (this.timeout) {
-          clearTimeout(this.timeout);
-          this.timeout = undefined;
-        }
-
-        const builder = new RangeSetBuilder<Decoration>();
-        const cState = update.view.state.field(commandState, false);
-        if (!cState?.tooltip) {
-          const selection = update.view.state.selection.main;
-          const line = update.view.state.doc.lineAt(selection.from);
-          // Only show if blank line.
-          if (selection.from === selection.to && line.from === line.to) {
-            // Set timeout to add decoration after delay.
-            this.timeout = setTimeout(() => {
-              const hint = onHint?.();
-              if (hint) {
-                const builder = new RangeSetBuilder<Decoration>();
-                builder.add(selection.from, selection.to, Decoration.widget({ widget: new Hint(hint) }));
-                this.decorations = builder.finish();
-                update.view.update([]);
-              }
-            }, delay);
-          }
-        }
-
-        this.decorations = builder.finish();
-      }
-
-      destroy() {
-        if (this.timeout) {
-          clearTimeout(this.timeout);
-        }
-      }
-    },
-    {
-      provide: (plugin) => [EditorView.decorations.of((view) => view.plugin(plugin)?.decorations ?? Decoration.none)],
-    },
-  );
-};
-
-export class Hint extends WidgetType {
-  constructor(readonly content: string | HTMLElement) {
-    super();
-  }
-
-  toDOM(): HTMLSpanElement {
-    const wrap = document.createElement('span');
-    wrap.className = 'cm-placeholder';
-    wrap.style.pointerEvents = 'none';
-    wrap.appendChild(typeof this.content === 'string' ? document.createTextNode(this.content) : this.content);
-    if (typeof this.content === 'string') {
-      wrap.setAttribute('aria-label', 'placeholder ' + this.content);
-    } else {
-      wrap.setAttribute('aria-hidden', 'true');
-    }
-
-    return wrap;
-  }
-
-  override coordsAt(dom: HTMLElement) {
-    const rects = dom.firstChild ? clientRectsFor(dom.firstChild) : [];
-    if (!rects.length) {
-      return null;
-    }
-
-    const style = window.getComputedStyle(dom.parentNode as HTMLElement);
-    const rect = flattenRect(rects[0], style.direction !== 'rtl');
-    const lineHeight = parseInt(style.lineHeight);
-    if (rect.bottom - rect.top > lineHeight * 1.5) {
-      return { left: rect.left, right: rect.right, top: rect.top, bottom: rect.top + lineHeight };
-    }
-
-    return rect;
-  }
-
-  override ignoreEvent(): boolean {
-    return false;
-  }
-}

package/src/extensions/command/index.ts

@@ -1,10 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './action';
-export * from './command';
-export * from './command-menu';
-export * from './floating-menu';
-export * from './typeahead';
-export * from './useCommandMenu';

package/src/extensions/command/placeholder.ts

@@ -1,113 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-// Based on https://github.com/codemirror/view/blob/main/src/placeholder.ts
-//
-
-import { type Extension } from '@codemirror/state';
-import { Decoration, EditorView, WidgetType, ViewPlugin, type ViewUpdate } from '@codemirror/view';
-
-import { clientRectsFor, flattenRect } from '../../util';
-
-type Content = string | HTMLElement | ((view: EditorView) => HTMLElement);
-
-export type PlaceholderOptions = {
-  delay?: number;
-  content: Content;
-};
-
-export const placeholder = ({ delay = 3_000, content }: PlaceholderOptions): Extension => {
-  const plugin = ViewPlugin.fromClass(
-    class {
-      decorations = Decoration.none;
-      timeout: ReturnType<typeof setTimeout> | undefined;
-
-      update(update: ViewUpdate) {
-        if (this.timeout) {
-          window.clearTimeout(this.timeout);
-          this.timeout = undefined;
-        }
-
-        // Check if the active line (where cursor is) is empty.
-        const activeLine = update.view.state.doc.lineAt(update.view.state.selection.main.head);
-        const isEmpty = activeLine.text.trim() === '';
-        if (isEmpty) {
-          // Create widget decoration at the start of the current line.
-          const lineStart = activeLine.from;
-          this.timeout = setTimeout(() => {
-            this.decorations = Decoration.set([
-              Decoration.widget({
-                widget: new Placeholder(content),
-                side: 1,
-              }).range(lineStart),
-            ]);
-
-            update.view.update([]);
-          }, delay);
-        }
-
-        this.decorations = Decoration.none;
-      }
-
-      destroy() {
-        if (this.timeout) {
-          clearTimeout(this.timeout);
-        }
-      }
-    },
-    {
-      provide: (plugin) => {
-        return [EditorView.decorations.of((view) => view.plugin(plugin)?.decorations ?? Decoration.none)];
-      },
-    },
-  );
-
-  return typeof content === 'string'
-    ? [plugin, EditorView.contentAttributes.of({ 'aria-placeholder': content })]
-    : plugin;
-};
-
-class Placeholder extends WidgetType {
-  constructor(readonly content: Content) {
-    super();
-  }
-
-  toDOM(view: EditorView) {
-    const wrap = document.createElement('span');
-    wrap.className = 'cm-placeholder';
-    wrap.style.pointerEvents = 'none';
-    wrap.appendChild(
-      typeof this.content === 'string'
-        ? document.createTextNode(this.content)
-        : typeof this.content === 'function'
-          ? this.content(view)
-          : this.content.cloneNode(true),
-    );
-    wrap.setAttribute('aria-hidden', 'true');
-    return wrap;
-  }
-
-  override coordsAt(dom: HTMLElement) {
-    const rects = dom.firstChild ? clientRectsFor(dom.firstChild) : [];
-    if (!rects.length) {
-      return null;
-    }
-
-    const style = window.getComputedStyle(dom.parentNode as HTMLElement);
-    const rect = flattenRect(rects[0], style.direction !== 'rtl');
-    const lineHeight = parseInt(style.lineHeight);
-    if (rect.bottom - rect.top > lineHeight * 1.5) {
-      return {
-        left: rect.left,
-        right: rect.right,
-        top: rect.top,
-        bottom: rect.top + lineHeight,
-      };
-    }
-
-    return rect;
-  }
-
-  override ignoreEvent() {
-    return false;
-  }
-}