@dxos/react-ui-editor 0.3.11-main.3f845e1 → 0.3.11-main.463e5cd

package/src/hooks/useEditorView.ts

@@ -0,0 +1,29 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type EditorView } from '@codemirror/view';
+import { type RefCallback, useState } from 'react';
+
+/**
+ * Hook for accessing the editor view.
+ *
+ * ```tsx
+ * const Test = () => {
+ *   const [editorRef, editorView] = useEditorView();
+ *   useEffect(() => {
+ *     editorView?.focus();
+ *   }, [editorView]);
+ *   return <TextEditor ref={editorRef} />;
+ * };
+ * ```
+ */
+export const useEditorView = (): [RefCallback<EditorView | null>, EditorView | null] => {
+  const [view, setView] = useState<EditorView | null>(null);
+  return [
+    (ref: EditorView | null) => {
+      setView(ref);
+    },
+    view,
+  ];
+};

package/src/hooks/useTextEditor.ts

@@ -0,0 +1,153 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import {
+  EditorSelection,
+  EditorState,
+  type EditorStateConfig,
+  type Extension,
+  type StateEffect,
+} from '@codemirror/state';
+import { EditorView } from '@codemirror/view';
+import { type RefObject, useEffect, useRef, useState } from 'react';
+
+import { log } from '@dxos/log';
+import { type ThemeMode } from '@dxos/react-ui';
+import { isNotFalsy } from '@dxos/util';
+
+import { type ThemeStyles } from '..//styles';
+import { defaultTheme } from '../themes';
+import { logChanges } from '../util';
+
+export type UseTextEditorOptions = {
+  autoFocus?: boolean;
+  scrollTo?: StateEffect<any>;
+  debug?: boolean;
+} & EditorStateConfig;
+
+export type UseTextEditor = {
+  parentRef: RefObject<HTMLDivElement>;
+  view?: EditorView;
+};
+
+/**
+ * Hook for creating editor.
+ */
+export const useTextEditor = ({
+  autoFocus,
+  scrollTo,
+  debug,
+  doc,
+  selection,
+  extensions,
+}: UseTextEditorOptions = {}): UseTextEditor => {
+  const onUpdate = useRef<() => void>();
+  const [view, setView] = useState<EditorView>();
+  const parentRef = useRef<HTMLDivElement>(null);
+  useEffect(() => {
+    if (parentRef.current) {
+      // https://codemirror.net/docs/ref/#state.EditorStateConfig
+      const state = EditorState.create({
+        doc,
+        selection,
+        extensions: [
+          // TODO(burdon): Doesn't catch errors in keymap functions.
+          EditorView.exceptionSink.of((err) => {
+            log.catch(err);
+          }),
+          extensions,
+          EditorView.updateListener.of(() => {
+            onUpdate.current?.();
+          }),
+        ].filter(isNotFalsy),
+      });
+
+      // https://codemirror.net/docs/ref/#view.EditorViewConfig
+      const view = new EditorView({
+        parent: parentRef.current,
+        scrollTo,
+        state,
+        // NOTE: Uncomment to debug/monitor all transactions.
+        // https://codemirror.net/docs/ref/#view.EditorView.dispatch
+        dispatchTransactions: (trs, view) => {
+          if (debug) {
+            logChanges(trs);
+          }
+          view.update(trs);
+        },
+      });
+
+      setView(view);
+    }
+
+    return () => {
+      view?.destroy();
+    };
+  }, [parentRef]);
+
+  useEffect(() => {
+    if (view) {
+      // Select end of line if not specified.
+      if (!selection && !view.state.selection.main.anchor) {
+        selection = EditorSelection.single(view.state.doc.line(1).to);
+      }
+
+      // Set selection after first update (since content may rerender on focus).
+      // TODO(burdon): BUG on first render may appear in middle of formatted heading.
+      // TODO(burdon): Make invisible until first render?
+      if (selection || scrollTo) {
+        onUpdate.current = () => {
+          onUpdate.current = undefined;
+          view.dispatch({ selection, effects: scrollTo && [scrollTo], scrollIntoView: !scrollTo });
+        };
+      }
+
+      if (autoFocus) {
+        view.focus();
+      }
+    }
+  }, [view, autoFocus, selection, scrollTo]);
+
+  return { parentRef, view };
+};
+
+// TODO(burdon): Factor out extension factories.
+
+export type DataExtensionsOptions = {
+  readonly?: boolean;
+};
+
+// TODO(burdon): Pass in TextObject (remove model).
+export const createDataExtensions = ({ readonly = false } = {}): Extension => {
+  return [
+    //
+    EditorState.readOnly.of(readonly),
+    EditorView.editable.of(!readonly),
+  ];
+};
+
+export type ThemeExtensionsOptions = {
+  theme?: ThemeStyles;
+  themeMode?: ThemeMode;
+  lineWrap?: boolean;
+  slots?: {
+    editor?: {
+      className?: string;
+    };
+    content?: {
+      className?: string;
+    };
+  };
+};
+
+export const createThemeExtensions = ({ theme, themeMode, slots }: ThemeExtensionsOptions = {}): Extension => {
+  return [
+    //
+    EditorView.baseTheme(defaultTheme),
+    theme && EditorView.theme(theme),
+    EditorView.darkTheme.of(themeMode === 'dark'),
+    EditorView.editorAttributes.of({ class: slots?.editor?.className ?? '' }),
+    EditorView.contentAttributes.of({ class: slots?.content?.className ?? '' }),
+  ].filter(isNotFalsy);
+};

package/src/hooks/useTextModel.ts

@@ -2,67 +2,19 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type Extension, StateField } from '@codemirror/state';
 import get from 'lodash.get';
-import { useEffect, useState } from 'react';
-import { yCollab } from 'y-codemirror.next';
-import type * as awarenessProtocol from 'y-protocols/awareness';
-import * as Y from 'yjs';
+import { type Dispatch, type SetStateAction, useEffect, useState } from 'react';
 
+import { generateName } from '@dxos/display-name';
+import { type AutomergeTextCompat, getRawDoc } from '@dxos/echo-schema';
 import { invariant } from '@dxos/invariant';
-import {
-  type DocAccessor,
-  type Space,
-  type TextObject,
-  type AutomergeTextCompat,
-  getRawDoc,
-  isActualAutomergeObject,
-} from '@dxos/react-client/echo';
+import { isAutomergeObject, type Space, type TextObject } from '@dxos/react-client/echo';
 import { type Identity } from '@dxos/react-client/halo';
-import type { YText, YXmlFragment } from '@dxos/text-model';
-import { arrayToString, stringToArray } from '@dxos/util';
 
-import { automergePlugin } from './automerge';
-import { SpaceAwarenessProvider } from './yjs';
-
-// TODO(burdon): Move.
-type Awareness = awarenessProtocol.Awareness;
-
-/**
- * State field makes the model available to other extensions.
- */
-// TODO(burdon): Use facet?
-export const modelState = StateField.define<EditorModel | undefined>({
-  create: () => undefined,
-  update: (model) => model,
-});
-
-export type Range = {
-  from: number;
-  to: number;
-};
-
-export type CommentRange = {
-  id: string;
-  // TODO(burdon): Split into begin/end?
-  cursor: string;
-};
-
-// TODO(wittjosiah): Factor out to common package? @dxos/react-client?
-export type EditorModel = {
-  id: string;
-  // TODO(burdon): Remove.
-  content: string | YText | YXmlFragment | DocAccessor;
-  text: () => string;
-  getCursorFromRange?: (value: Range) => string;
-  getRangeFromCursor?: (cursor: string) => Range;
-  extension?: Extension;
-  awareness?: Awareness;
-  peer?: {
-    id: string;
-    name?: string;
-  };
-};
+import { SpaceAwarenessProvider } from './awareness-provider';
+import { type EditorModel, modelState } from './defs';
+import { automerge, awareness } from '../extensions';
+import { cursorColor } from '../styles';
 
 // TODO(burdon): Remove space/identity dependency. Define interface for the framework re content and presence.
 export type UseTextModelProps = {
@@ -71,79 +23,61 @@ export type UseTextModelProps = {
   text?: TextObject;
 };
 
-// TODO(burdon): Remove YJS/Automerge deps (from UI component -- create abstraction; incl. all ECHO/Space deps).
-// TODO(wittjosiah): Factor out to common package? @dxos/react-client?
 export const useTextModel = (props: UseTextModelProps): EditorModel | undefined => {
   const { identity, space, text } = props;
-  const [model, setModel] = useState<EditorModel | undefined>(() => createModel(props));
+  const [model, setModel] = useState<EditorModel | undefined>();
   useEffect(() => setModel(createModel(props)), [identity, space, text]);
   return model;
 };
 
-const createModel = (props: UseTextModelProps) => {
-  const { text } = props;
-  if (isActualAutomergeObject(text)) {
-    return createAutomergeModel(props);
-  } else {
-    if (!text?.doc) {
-      return undefined;
-    }
-
-    return createYjsModel(props);
-  }
-};
-
-const createYjsModel = ({ identity, space, text }: UseTextModelProps): EditorModel => {
-  invariant(text?.doc && text?.content);
-  const provider = space
-    ? new SpaceAwarenessProvider({ space, doc: text.doc, channel: `yjs.awareness.${text.id}` })
-    : undefined;
-
-  const model: EditorModel = {
-    id: text.doc.guid,
-    content: text.content,
-    text: () => text.content!.toString(),
-    // https://github.com/yjs/yjs?tab=readme-ov-file#relative-positions
-    getCursorFromRange: (range: Range) => {
-      const from = Y.encodeRelativePosition(Y.createRelativePositionFromTypeIndex(text.content as YText, range.from));
-      const to = Y.encodeRelativePosition(Y.createRelativePositionFromTypeIndex(text.content as YText, range.to, -1));
-      return [arrayToString(from), arrayToString(to)].join(':');
-    },
-    getRangeFromCursor: (cursor: string) => {
-      const parts = cursor.split(':');
-      const from = Y.createAbsolutePositionFromRelativePosition(
-        Y.decodeRelativePosition(stringToArray(parts[0])),
-        text.doc!,
-      );
-      const to = Y.createAbsolutePositionFromRelativePosition(
-        Y.decodeRelativePosition(stringToArray(parts[1])),
-        text.doc!,
-      );
-      return { from: from!.index, to: to!.index };
-    },
-    extension: [yCollab(text.content as YText, provider?.awareness), modelState.init(() => model)],
-    awareness: provider?.awareness,
-    peer: identity
-      ? {
-          id: identity.identityKey.toHex(),
-          name: identity.profile?.displayName,
-        }
-      : undefined,
-  };
-
-  return model;
+/**
+ * For use primarily in stories & tests so the dependence on TextObject can be avoided.
+ * @param id
+ * @param defaultContent
+ */
+export const useInMemoryTextModel = ({
+  id,
+  defaultContent,
+}: {
+  id: string;
+  defaultContent?: string;
+}): EditorModel & { setContent: Dispatch<SetStateAction<string>> } => {
+  const [content, setContent] = useState(defaultContent ?? '');
+  return { id, content, setContent, text: () => content };
 };
 
-const createAutomergeModel = ({ identity, text }: UseTextModelProps): EditorModel => {
+const createModel = ({ space, identity, text }: UseTextModelProps) => {
+  invariant(isAutomergeObject(text));
   const obj = text as any as AutomergeTextCompat;
   const doc = getRawDoc(obj, [obj.field]);
 
+  const awarenessProvider =
+    space &&
+    new SpaceAwarenessProvider({
+      space,
+      channel: `automerge.awareness.${obj.id}`,
+      info: {
+        displayName: identity ? identity.profile?.displayName ?? generateName(identity.identityKey.toHex()) : undefined,
+        color: cursorColor.color,
+        lightColor: cursorColor.light,
+      },
+      peerId: identity?.identityKey.toHex() ?? 'Anonymous',
+    });
+
+  const extensions = [
+    //
+    modelState.init(() => model),
+    automerge({ handle: doc.handle, path: doc.path }),
+  ];
+  if (awarenessProvider) {
+    extensions.push(awareness(awarenessProvider));
+  }
+
   const model: EditorModel = {
     id: obj.id,
     content: doc,
     text: () => get(doc.handle.docSync(), doc.path),
-    // TODO(burdon): https://automerge.org/automerge/api-docs/js/functions/next.getCursor.html
-    extension: [automergePlugin(doc.handle, doc.path), modelState.init(() => model)],
+    extension: extensions,
     peer: identity
       ? {
           id: identity.identityKey.toHex(),

package/src/index.ts

@@ -5,6 +5,11 @@
 export { TextKind } from '@dxos/protocols/proto/dxos/echo/model/text';
 export { Doc, YText, YXmlFragment } from '@dxos/text-model';
 export { type Extension } from '@codemirror/state';
+export { type EditorView, keymap } from '@codemirror/view';
 
 export * from './components';
+export * from './extensions';
 export * from './hooks';
+export { getToken } from './styles';
+export * from './themes';
+export * from './util';

package/src/styles/index.ts

@@ -2,5 +2,6 @@
 // Copyright 2023 DXOS.org
 //
 
+export * from './cursors';
 export * from './markdown';
 export * from './tokens';

package/src/styles/markdown.ts

@@ -8,18 +8,17 @@ export type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
 
 // TODO(burdon): Better way to align vertically than negative margin? Font-specific?
 // https://tailwindcss.com/docs/font-weight
-export const headings: Record<HeadingLevel, string[]> = {
-  1: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-4xl', '-ml-[10px]'],
-  2: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-3xl', '-ml-[8px]'],
-  3: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-2xl', '-ml-[7px]'],
-  4: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-xl', '-ml-[6px]'],
-  5: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-lg', '-ml-[5px]'],
-  6: ['mbs-4 mbe-2 font-medium text-inherit no-underline', '-ml-[4px]'],
+export const headings: Record<HeadingLevel, string> = {
+  1: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-4xl',
+  2: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-3xl',
+  3: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-2xl',
+  4: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-xl',
+  5: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-lg',
+  6: 'mbs-4 mbe-2 font-medium text-inherit no-underline',
 };
 
-export const heading = (level: HeadingLevel, readonly?: boolean) => {
-  const [style, offset] = headings[level];
-  return mx(style, readonly && offset);
+export const heading = (level: HeadingLevel) => {
+  return headings[level];
 };
 
 export const text = 'text-neutral-800 dark:text-neutral-200';
@@ -39,10 +38,8 @@ export const codeBlock = 'mlb-2 font-mono bg-neutral-500/10 p-3 rounded';
 
 export const inlineUrl = mx(code, 'px-1');
 
-// TODO(burdon): Replace with widget.
 export const blockquote = mx('pl-1 mr-1 border-is-4 border-primary-500/70 dark:border-primary-500/30', light);
 
-// TODO(burdon): Replace with widget.
 export const horizontalRule =
   'flex mlb-4 border-b text-neutral-100 dark:text-neutral-900 border-neutral-200 dark:border-neutral-800';
 

package/src/styles/tokens.ts

@@ -2,6 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
+import get from 'lodash.get';
 import type { StyleSpec } from 'style-mod';
 
 import { tailwindConfig, type TailwindConfig } from '@dxos/react-ui-theme';
@@ -12,3 +13,5 @@ export type ThemeStyles = {
 
 // TODO(thure): Why export the whole theme? Can this be done differently?
 export const tokens: TailwindConfig['theme'] = tailwindConfig({}).theme;
+
+export const getToken = (path: string, defaultValue: any = undefined) => get(tokens, path, defaultValue);