@dxos/react-ui-editor 0.3.11-main.73ee990 → 0.3.11-main.764a9c1

package/src/extensions/markdown/link.ts

@@ -91,7 +91,10 @@ export const link = (options: LinkOptions = {}): Extension => {
 };
 
 class LinkButton extends WidgetType {
-  constructor(private readonly _url: string, private readonly _onAttach: LinkOptions['onRender']) {
+  constructor(
+    private readonly _url: string,
+    private readonly _onAttach: LinkOptions['onRender'],
+  ) {
     super();
   }
 
@@ -107,7 +110,10 @@ class LinkButton extends WidgetType {
 }
 
 class LinkText extends WidgetType {
-  constructor(private readonly _text: string, private readonly _url?: string) {
+  constructor(
+    private readonly _text: string,
+    private readonly _url?: string,
+  ) {
     super();
   }
 

package/src/hooks/index.ts

@@ -6,5 +6,6 @@ export * from './awareness-provider';
 export * from './defs';
 
 export * from './useActionHandler';
+export * from './useEditorView';
 export * from './useTextEditor';
 export * from './useTextModel';

package/src/hooks/useActionHandler.ts

@@ -4,32 +4,78 @@
 
 import type { EditorView } from '@codemirror/view';
 
-import type { ToolbarProps } from '../components/Toolbar/Toolbar';
-import { createComment, setHeading, toggleBold, toggleItalic, toggleList, toggleStrikethrough } from '../extensions';
+import type { ToolbarProps } from '../components';
+import {
+  createComment,
+  insertTable,
+  setHeading,
+  setStyle,
+  toggleStyle,
+  addLink,
+  removeLink,
+  Inline,
+  List,
+  addList,
+  removeList,
+  toggleList,
+  addBlockquote,
+  removeBlockquote,
+  addCodeblock,
+  removeCodeblock,
+  toggleBlockquote,
+} from '../extensions';
 
-export const useActionHandler = (view: EditorView | null): ToolbarProps['onAction'] => {
+export const useActionHandler = (view?: EditorView | null): ToolbarProps['onAction'] => {
   return (action) => {
     if (!view) {
       return;
     }
 
+    let inlineType, listType;
     switch (action.type) {
       case 'heading':
         setHeading(parseInt(action.data))(view);
         break;
 
-      case 'bold':
-        toggleBold(view);
+      case 'strong':
+      case 'emphasis':
+      case 'strikethrough':
+      case 'code':
+        inlineType =
+          action.type === 'strong'
+            ? Inline.Strong
+            : action.type === 'emphasis'
+              ? Inline.Emphasis
+              : action.type === 'strikethrough'
+                ? Inline.Strikethrough
+                : Inline.Code;
+        (typeof action.data === 'boolean' ? setStyle(inlineType, action.data) : toggleStyle(inlineType))(view);
         break;
-      case 'italic':
-        toggleItalic(view);
+
+      case 'list-ordered':
+      case 'list-bullet':
+      case 'list-tasks':
+        listType =
+          action.type === 'list-ordered' ? List.Ordered : action.type === 'list-bullet' ? List.Bullet : List.Task;
+        (action.data === false
+          ? removeList(listType)
+          : action.data === true
+            ? addList(listType)
+            : toggleList(listType))(view);
         break;
-      case 'strikethrough':
-        toggleStrikethrough(view);
+
+      case 'blockquote':
+        (action.data === false ? removeBlockquote : action.data === true ? addBlockquote : toggleBlockquote)(view);
+        break;
+      case 'codeblock':
+        (action.data === false ? removeCodeblock : addCodeblock)(view);
+        break;
+      case 'table':
+        insertTable(view);
         break;
 
-      case 'list':
-        toggleList(view);
+      case 'link':
+        (action.data === false ? removeLink : addLink)(view);
         break;
 
       case 'comment':
@@ -37,9 +83,11 @@ export const useActionHandler = (view: EditorView | null): ToolbarProps['onActio
         break;
     }
 
-    // TODO(burdon): Hack since otherwise focus doesn't leave heading selector.
+    // TODO(burdon): Hack otherwise remains on heading selector.
     setTimeout(() => {
-      view.focus();
+      if (!view.hasFocus) {
+        view.focus();
+      }
     });
   };
 };

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

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

@@ -3,18 +3,17 @@
 //
 
 import get from 'lodash.get';
-import { useEffect, useState } from 'react';
+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 { isAutomergeObject, type Space, type TextObject } from '@dxos/react-client/echo';
 import { type Identity } from '@dxos/react-client/halo';
-import { isNotNullOrUndefined } from '@dxos/util';
 
 import { SpaceAwarenessProvider } from './awareness-provider';
 import { type EditorModel, modelState } from './defs';
-import { automerge, awareness, AwarenessProvider } from '../extensions';
+import { automerge, awareness } from '../extensions';
 import { cursorColor } from '../styles';
 
 // TODO(burdon): Remove space/identity dependency. Define interface for the framework re content and presence.
@@ -31,6 +30,22 @@ export const useTextModel = (props: UseTextModelProps): EditorModel | 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 createModel = ({ space, identity, text }: UseTextModelProps) => {
   invariant(isAutomergeObject(text));
   const obj = text as any as AutomergeTextCompat;
@@ -49,16 +64,20 @@ const createModel = ({ space, identity, text }: UseTextModelProps) => {
       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),
-    extension: [
-      modelState.init(() => model),
-      automerge({ handle: doc.handle, path: doc.path }),
-      awarenessProvider && AwarenessProvider.of(awarenessProvider),
-      awareness(),
-    ].filter(isNotNullOrUndefined),
+    extension: extensions,
     peer: identity
       ? {
           id: identity.identityKey.toHex(),

package/src/index.ts

@@ -5,7 +5,7 @@
 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 } from '@codemirror/view';
+export { type EditorView, keymap } from '@codemirror/view';
 
 export * from './components';
 export * from './extensions';

package/src/themes/default.ts

@@ -49,9 +49,11 @@ export const defaultTheme: ThemeStyles = {
   '&.cm-focused': {
     outline: 'none',
   },
+
   '.cm-scroller': {
-    overflow: 'visible',
+    // overflow: 'visible',
     fontFamily: get(tokens, 'fontFamily.mono', []).join(','),
+    lineHeight: 1.4,
   },
 
   '.cm-content': {
@@ -60,11 +62,11 @@ export const defaultTheme: ThemeStyles = {
     fontSize: '16px',
   },
   '&light .cm-content': {
-    color: get(tokens, 'extend.colors.neutral.900', 'black'),
+    color: get(tokens, 'extend.semanticColors.base.fg.light', 'black'),
     caretColor: 'black',
   },
   '&dark .cm-content': {
-    color: get(tokens, 'extend.colors.neutral.100', 'white'),
+    color: get(tokens, 'extend.semanticColors.base.fg.dark', 'white'),
     caretColor: 'white',
   },
 
@@ -77,8 +79,11 @@ export const defaultTheme: ThemeStyles = {
   '&dark .cm-cursor, &dark .cm-dropCursor': {
     borderLeft: '2px solid white',
   },
-  '.cm-placeholder': {
-    fontWeight: 100,
+  '&light .cm-placeholder': {
+    color: get(tokens, 'extend.semanticColors.description.light', 'rgba(0,0,0,.2)'),
+  },
+  '&dark .cm-placeholder': {
+    color: get(tokens, 'extend.semanticColors.description.dark', 'rgba(255,255,255,.2)'),
   },
 
   //

package/dist/types/src/components/TextEditor/comments.stories.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"comments.stories.d.ts","sourceRoot":"","sources":["../../../../../src/components/TextEditor/comments.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,YAAY,CAAC;AAEpB,OAAO,EAAE,KAAK,UAAU,EAAU,MAAM,kBAAkB,CAAC;AAG3D,OAAO,KAAwD,MAAM,OAAO,CAAC;AA6M7E,KAAK,UAAU,GAAG;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;;;;;mBAoHe,UAAU;;AAJ3B,wBAKE;AAWF,eAAO,MAAM,OAAO;;;;CAInB,CAAC;AAEF,eAAO,MAAM,OAAO;;;;;CAKnB,CAAC"}