@dxos/react-ui-editor 0.3.11-main.4eab977 → 0.3.11-main.508f304

package/src/extensions/automerge/update-automerge.ts

@@ -8,10 +8,10 @@ import { type EditorState, type StateField, type Text, type Transaction } from '
 
 import { next as am, type Heads } from '@dxos/automerge/automerge';
 
-import { type IDocHandle, type Value } from './defs';
+import { type IDocHandle, type State } from './defs';
 
 export const updateAutomerge = (
-  field: StateField<Value>,
+  field: StateField<State>,
   handle: IDocHandle,
   transactions: Transaction[],
   state: EditorState,

package/src/extensions/awareness.ts

@@ -12,11 +12,16 @@ import {
   type ViewUpdate,
   WidgetType,
 } from '@codemirror/view';
+import { useEffect } from 'react';
 
 import { Event } from '@dxos/async';
 import { Context } from '@dxos/context';
+import { generateName } from '@dxos/display-name';
+import { useThemeContext } from '@dxos/react-ui';
+import { getColorForValue } from '@dxos/react-ui-theme';
 
-import { CursorConverter } from '../util';
+import { Cursor, type CursorConverter } from './cursor';
+import { type EditorModel } from '../hooks';
 
 export interface AwarenessProvider {
   remoteStateChange: Event<void>;
@@ -66,7 +71,6 @@ export type AwarenessState = {
 /**
  * Extension provides presence information about other peers.
  */
-// TODO(burdon): Why provide default?
 export const awareness = (provider = dummyProvider): Extension => {
   return [
     AwarenessProvider.of(provider),
@@ -77,6 +81,19 @@ export const awareness = (provider = dummyProvider): Extension => {
   ];
 };
 
+export const useAwareness = ({ awareness, peer }: EditorModel) => {
+  const { themeMode } = useThemeContext();
+  useEffect(() => {
+    if (awareness && peer) {
+      awareness.setLocalStateField('user', {
+        name: peer.name ?? generateName(peer.id),
+        color: getColorForValue({ value: peer.id, type: 'color' }),
+        colorLight: getColorForValue({ value: peer.id, themeMode, type: 'highlight' }),
+      });
+    }
+  }, [awareness, peer, themeMode]);
+};
+
 /**
  * Generates selection decorations from remote peers.
  */
@@ -91,7 +108,7 @@ export class RemoteSelectionsDecorator implements PluginValue {
   private _lastHead?: number = undefined;
 
   constructor(view: EditorView) {
-    this._cursorConverter = view.state.facet(CursorConverter);
+    this._cursorConverter = view.state.facet(Cursor.converter);
     this._provider = view.state.facet(AwarenessProvider);
     this._provider.open();
     this._provider.remoteStateChange.on(this._ctx, () => {
@@ -156,7 +173,7 @@ export class RemoteSelectionsDecorator implements PluginValue {
           to: end,
           value: Decoration.mark({
             attributes: { style: `background-color: ${lightColor}` },
-            class: 'cm-ySelection',
+            class: 'cm-collab-selection',
           }),
         });
       } else {
@@ -166,7 +183,7 @@ export class RemoteSelectionsDecorator implements PluginValue {
           to: startLine.from + startLine.length,
           value: Decoration.mark({
             attributes: { style: `background-color: ${color}` },
-            class: 'cm-ySelection',
+            class: 'cm-collab-selection',
           }),
         });
 
@@ -176,7 +193,7 @@ export class RemoteSelectionsDecorator implements PluginValue {
           to: end,
           value: Decoration.mark({
             attributes: { style: `background-color: ${color}` },
-            class: 'cm-ySelection',
+            class: 'cm-collab-selection',
           }),
         });
 
@@ -186,7 +203,7 @@ export class RemoteSelectionsDecorator implements PluginValue {
             from: linePos,
             to: linePos,
             value: Decoration.line({
-              attributes: { style: `background-color: ${color}`, class: 'cm-yLineSelection' },
+              attributes: { style: `background-color: ${color}`, class: 'cm-collab-selectionLine' },
             }),
           });
         }
@@ -208,24 +225,22 @@ export class RemoteSelectionsDecorator implements PluginValue {
 }
 
 class RemoteCaretWidget extends WidgetType {
-  constructor(public name: string, public color: string) {
+  constructor(private readonly _name: string, private readonly _color: string) {
     super();
-    this.name = name;
-    this.color = color;
   }
 
-  toDOM(): HTMLElement {
+  override toDOM(): HTMLElement {
     const span = document.createElement('span');
-    span.className = 'cm-ySelectionCaret';
-    span.style.backgroundColor = this.color;
-    span.style.borderColor = this.color;
+    span.className = 'cm-collab-selectionCaret';
+    span.style.backgroundColor = this._color;
+    span.style.borderColor = this._color;
 
     const dot = document.createElement('div');
-    dot.className = 'cm-ySelectionCaretDot';
+    dot.className = 'cm-collab-selectionCaretDot';
 
     const info = document.createElement('div');
-    info.className = 'cm-ySelectionInfo';
-    info.innerText = this.name;
+    info.className = 'cm-collab-selectionInfo';
+    info.innerText = this._name;
 
     span.appendChild(document.createTextNode('\u2060'));
     span.appendChild(dot);
@@ -236,18 +251,14 @@ class RemoteCaretWidget extends WidgetType {
     return span;
   }
 
-  override eq(widget: this) {
-    return widget.color === this.color;
-  }
-
-  compare(widget: this) {
-    return widget.color === this.color;
-  }
-
   override updateDOM() {
     return false;
   }
 
+  override eq(widget: this) {
+    return widget._color === this._color;
+  }
+
   override get estimatedHeight() {
     return -1;
   }
@@ -257,14 +268,14 @@ class RemoteCaretWidget extends WidgetType {
   }
 }
 
-// TODO(burdon): Rename prefix (y for yjs?)
+// TODO(burdon): Mixed case?
 const styles = EditorView.baseTheme({
-  '.cm-ySelection': {},
-  '.cm-yLineSelection': {
+  '.cm-collab-selection': {},
+  '.cm-collab-selectionLine': {
     padding: 0,
     margin: '0px 2px 0px 4px',
   },
-  '.cm-ySelectionCaret': {
+  '.cm-collab-selectionCaret': {
     position: 'relative',
     borderLeft: '1px solid black',
     borderRight: '1px solid black',
@@ -273,7 +284,7 @@ const styles = EditorView.baseTheme({
     boxSizing: 'border-box',
     display: 'inline',
   },
-  '.cm-ySelectionCaretDot': {
+  '.cm-collab-selectionCaretDot': {
     borderRadius: '50%',
     position: 'absolute',
     width: '.4em',
@@ -284,11 +295,11 @@ const styles = EditorView.baseTheme({
     transition: 'transform .3s ease-in-out',
     boxSizing: 'border-box',
   },
-  '.cm-ySelectionCaret:hover > .cm-ySelectionCaretDot': {
+  '.cm-collab-selectionCaret:hover > .cm-collab-selectionCaretDot': {
     transformOrigin: 'bottom center',
     transform: 'scale(0)',
   },
-  '.cm-ySelectionInfo': {
+  '.cm-collab-selectionInfo': {
     position: 'absolute',
     top: '-1.05em',
     left: '-1px',
@@ -304,12 +315,12 @@ const styles = EditorView.baseTheme({
     zIndex: 101,
     transition: 'opacity .3s ease-in-out',
     backgroundColor: 'inherit',
-    // these should be separate
+    // These should be separate.
     opacity: 0,
     transitionDelay: '0s',
     whiteSpace: 'nowrap',
   },
-  '.cm-ySelectionCaret:hover > .cm-ySelectionInfo': {
+  '.cm-collab-selectionCaret:hover > .cm-collab-selectionInfo': {
     opacity: 1,
     transitionDelay: '0s',
   },

package/src/extensions/basic.ts

@@ -3,30 +3,35 @@
 //
 
 import { closeBrackets } from '@codemirror/autocomplete';
+import { history } from '@codemirror/commands';
 import { bracketMatching, defaultHighlightStyle, syntaxHighlighting } from '@codemirror/language';
 import { type Extension } from '@codemirror/state';
 import { oneDarkHighlightStyle } from '@codemirror/theme-one-dark';
-import { drawSelection, EditorView, placeholder } from '@codemirror/view';
+import { drawSelection, EditorView, highlightActiveLine, placeholder } from '@codemirror/view';
 
-import type { ThemeMode } from '@dxos/react-ui';
+import { type ThemeMode } from '@dxos/react-ui';
+
+import { type TextEditorProps } from '../components';
 
 export type BasicBundleOptions = {
-  readonly?: boolean;
   themeMode?: ThemeMode;
-  placeholder?: string;
-};
+} & Pick<TextEditorProps, 'placeholder' | 'multiline'>;
 
-export const basicBundle = ({ readonly, themeMode, placeholder: _placeholder }: BasicBundleOptions): Extension[] =>
-  [
-    EditorView.lineWrapping,
+export const basicBundle = ({
+  themeMode,
+  placeholder: _placeholder,
+  multiline = true,
+}: BasicBundleOptions): Extension[] => [
+  multiline ? EditorView.lineWrapping : [],
 
-    // TODO(burdon): Compare with minimalSetup.
-    // https://codemirror.net/docs/ref/#codemirror.minimalSetup
-    bracketMatching(),
-    closeBrackets(),
-    drawSelection(),
-    _placeholder && placeholder(_placeholder),
+  // https://codemirror.net/docs/ref/#codemirror.minimalSetup
+  bracketMatching(),
+  closeBrackets(),
+  drawSelection(),
+  highlightActiveLine(),
+  history(),
+  _placeholder ? placeholder(_placeholder) : [],
 
-    // TODO(burdon): Is this required?
-    themeMode === 'dark' ? syntaxHighlighting(oneDarkHighlightStyle) : syntaxHighlighting(defaultHighlightStyle),
-  ].filter(Boolean) as Extension[];
+  // https://github.com/codemirror/theme-one-dark
+  themeMode === 'dark' ? syntaxHighlighting(oneDarkHighlightStyle) : syntaxHighlighting(defaultHighlightStyle),
+];

package/src/extensions/code.ts

@@ -53,22 +53,20 @@ const getLineRange = (lines: BlockInfo[], from: number, to: number) => {
 };
 
 export const code = () => {
-  const getDecorations = (view: EditorView) => {
+  const buildDecorations = (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-codeblock', i === range[0] && 'cm-codeblock-first', i === range[1] && 'cm-codeblock-last'),
-            }).range(block.from),
-          );
-        }
+    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-codeblock', i === range[0] && 'cm-codeblock-first', i === range[1] && 'cm-codeblock-last'),
+          }).range(block.from),
+        );
       }
     }
 
@@ -78,14 +76,22 @@ export const code = () => {
   return [
     ViewPlugin.fromClass(
       class {
+        hasFocus = false;
         decorations: DecorationSet;
         constructor(view: EditorView) {
-          this.decorations = getDecorations(view);
+          this.decorations = buildDecorations(view);
         }
 
         update(update: ViewUpdate) {
-          if (update.docChanged || update.viewportChanged) {
-            this.decorations = getDecorations(update.view);
+          if (
+            // TODO(burdon): Generalize for other extensions.
+            this.hasFocus !== update.view.hasFocus ||
+            update.startState.readOnly !== update.view.state.readOnly ||
+            update.docChanged ||
+            update.viewportChanged
+          ) {
+            this.hasFocus = update.view.hasFocus;
+            this.decorations = buildDecorations(update.view);
           }
         }
       },