@dxos/react-ui-editor 0.4.4 → 0.4.5-main.2d76d4e

package/dist/lib/browser/index.mjs

@@ -8,7 +8,7 @@ import { tags as tags2 } from "@lezer/highlight";
 
 // packages/ui/react-ui-editor/src/components/TextEditor/TextEditor.tsx
 import { EditorState as EditorState2 } from "@codemirror/state";
-import { EditorView as EditorView15 } from "@codemirror/view";
+import { EditorView as EditorView16 } from "@codemirror/view";
 import { useFocusableGroup } from "@fluentui/react-tabster";
 import defaultsDeep2 from "lodash.defaultsdeep";
 import React, { forwardRef, useCallback, useEffect as useEffect2, useImperativeHandle, useRef, useState as useState2, useMemo as useMemo2 } from "react";
@@ -102,8 +102,8 @@ var annotations = (options = {}) => {
       annotationsState
     ], (state) => {
       const annotations2 = state.field(annotationsState);
-      const decorations = annotations2.map((annotation) => {
-        const range = Cursor.getRangeFromCursor(state, annotation.cursor);
+      const decorations = annotations2.map((annotation2) => {
+        const range = Cursor.getRangeFromCursor(state, annotation2.cursor);
         return range && annotationMark.range(range.from, range.to);
       }).filter(isNotFalsy);
       return Decoration.set(decorations);
@@ -1116,8 +1116,8 @@ var getToken = (path, defaultValue = void 0) => get2(tokens, path, defaultValue)
 
 // packages/ui/react-ui-editor/src/styles/layout.ts
 var editorWithToolbarLayout = "grid grid-cols-1 grid-rows-[min-content_1fr] data-[toolbar=disabled]:grid-rows-[1fr] justify-center content-start overflow-hidden";
-var editorFillLayoutRoot = "min-bs-full grid";
-var editorFillLayoutEditor = "min-bs-full";
+var editorFillLayoutRoot = "bs-full overflow-hidden grid";
+var editorFillLayoutEditor = "bs-full overflow-hidden [&>.cm-scroller]:bs-full [&>.cm-scroller]:overflow-y-auto";
 var editorHalfViewportOverscrollContent = "after:block after:min-bs-[50dvh] after:pointer-events-none";
 
 // packages/ui/react-ui-editor/src/util.ts
@@ -1553,15 +1553,66 @@ var useComments = (view, id, comments2 = []) => {
   ]);
 };
 
-// packages/ui/react-ui-editor/src/extensions/listener.ts
+// packages/ui/react-ui-editor/src/extensions/cursor-line-margin.ts
+import { Facet as Facet4, Transaction } from "@codemirror/state";
 import { EditorView as EditorView7 } from "@codemirror/view";
+var cursorLineMarginFacet = Facet4.define({
+  combine: (input) => input[0] ?? 3
+});
+var annotation = "cursorLineMargin";
+var lineAtPos = (s, pos) => s.doc.lineAt(pos).number;
+var cursorLineMargin = EditorView7.updateListener.of(({ transactions, state, selectionSet, startState, view }) => {
+  if (transactions.length < 1 || transactions.some((tr) => tr.isUserEvent(annotation))) {
+    return;
+  }
+  const s = state;
+  const { main } = s.selection;
+  const cursorLineMargin2 = s.facet(cursorLineMarginFacet);
+  const rect = view.dom.getBoundingClientRect();
+  const viewportTop = rect.top - view.documentTop;
+  const viewportBottom = rect.bottom - view.documentTop;
+  const mainLine = lineAtPos(s, main.head);
+  const _visTopLine = lineAtPos(s, view.lineBlockAtHeight(viewportTop).from);
+  const botLineBlk = view.lineBlockAtHeight(viewportBottom);
+  const visBotLineDoc = lineAtPos(s, Math.min(botLineBlk.to, s.doc.length));
+  const visBotLine = botLineBlk.bottom >= viewportBottom ? visBotLineDoc : visBotLineDoc + Math.floor((viewportBottom - botLineBlk.bottom) / view.defaultLineHeight);
+  const needsScrollTop = false;
+  const needsScrollBot = mainLine >= visBotLine - cursorLineMargin2;
+  if (needsScrollTop && needsScrollBot) {
+    console.warn("is cursorScrollMargin too large for the editor size?");
+    return;
+  }
+  if (!needsScrollTop && !needsScrollBot) {
+    return;
+  }
+  if (selectionSet) {
+    const { head } = startState.selection.main;
+    const oldMainLine = lineAtPos(startState, head);
+    if (needsScrollTop && oldMainLine < mainLine) {
+      return;
+    }
+    if (needsScrollBot && oldMainLine > mainLine) {
+      return;
+    }
+  }
+  view.dispatch({
+    annotations: Transaction.userEvent.of(annotation),
+    effects: EditorView7.scrollIntoView(s.selection.main.head, {
+      y: needsScrollTop ? "start" : "end",
+      yMargin: view.defaultLineHeight * cursorLineMargin2
+    })
+  });
+});
+
+// packages/ui/react-ui-editor/src/extensions/listener.ts
+import { EditorView as EditorView8 } from "@codemirror/view";
 var listener = ({ onFocus, onChange }) => {
   const extensions = [];
-  onFocus && extensions.push(EditorView7.focusChangeEffect.of((_, focused) => {
+  onFocus && extensions.push(EditorView8.focusChangeEffect.of((_, focused) => {
     onFocus(focused);
     return null;
   }));
-  onChange && extensions.push(EditorView7.updateListener.of((update2) => {
+  onChange && extensions.push(EditorView8.updateListener.of((update2) => {
     onChange(update2.state.doc.toString());
   }));
   return extensions;
@@ -1576,7 +1627,7 @@ import { languages } from "@codemirror/language-data";
 import { searchKeymap } from "@codemirror/search";
 import { EditorState } from "@codemirror/state";
 import { oneDarkHighlightStyle as oneDarkHighlightStyle2 } from "@codemirror/theme-one-dark";
-import { crosshairCursor, drawSelection as drawSelection2, dropCursor, EditorView as EditorView8, highlightActiveLine as highlightActiveLine2, keymap as keymap4, placeholder as placeholder2 } from "@codemirror/view";
+import { crosshairCursor, drawSelection as drawSelection2, dropCursor, EditorView as EditorView9, highlightActiveLine as highlightActiveLine2, keymap as keymap4, placeholder as placeholder2 } from "@codemirror/view";
 import { isNotFalsy as isNotFalsy3 } from "@dxos/util";
 
 // packages/ui/react-ui-editor/src/extensions/markdown/highlight.ts
@@ -1770,7 +1821,7 @@ var markdownHighlightStyle = (readonly) => {
 // packages/ui/react-ui-editor/src/extensions/markdown/bundle.ts
 var createMarkdownExtensions = ({ themeMode, placeholder: _placeholder, lineWrapping = true } = {}) => {
   return [
-    lineWrapping && EditorView8.lineWrapping,
+    lineWrapping && EditorView9.lineWrapping,
     EditorState.allowMultipleSelections.of(true),
     EditorState.tabSize.of(2),
     // https://github.com/codemirror/basic-setup
@@ -1823,9 +1874,9 @@ var createMarkdownExtensions = ({ themeMode, placeholder: _placeholder, lineWrap
 // packages/ui/react-ui-editor/src/extensions/markdown/code.ts
 import { syntaxTree } from "@codemirror/language";
 import { RangeSetBuilder } from "@codemirror/state";
-import { ViewPlugin as ViewPlugin3, EditorView as EditorView9, Decoration as Decoration4, WidgetType as WidgetType2 } from "@codemirror/view";
+import { ViewPlugin as ViewPlugin3, EditorView as EditorView10, Decoration as Decoration4, WidgetType as WidgetType2 } from "@codemirror/view";
 import { mx as mx2 } from "@dxos/react-ui-theme";
-var styles4 = EditorView9.baseTheme({
+var styles4 = EditorView10.baseTheme({
   "& .cm-code": {
     fontFamily: getToken("fontFamily.mono", []).join(",")
   },
@@ -1948,7 +1999,7 @@ var code2 = () => {
 import { snippet } from "@codemirror/autocomplete";
 import { syntaxTree as syntaxTree2 } from "@codemirror/language";
 import { RangeSetBuilder as RangeSetBuilder2, EditorSelection } from "@codemirror/state";
-import { Decoration as Decoration5, EditorView as EditorView10, keymap as keymap5, ViewPlugin as ViewPlugin4 } from "@codemirror/view";
+import { Decoration as Decoration5, EditorView as EditorView11, keymap as keymap5, ViewPlugin as ViewPlugin4 } from "@codemirror/view";
 import { useState, useMemo } from "react";
 var compareFormatting = (a, b) => a.blockType === b.blockType && a.strong === b.strong && a.emphasis === b.emphasis && a.strikethrough === b.strikethrough && a.code === b.code && a.link === b.link && a.listStyle === b.listStyle && a.blockQuote === b.blockQuote;
 var Inline;
@@ -3024,7 +3075,7 @@ var getFormatting = (state) => {
 };
 var useFormattingState = () => {
   const [state, setState] = useState(null);
-  const observer = useMemo(() => EditorView10.updateListener.of((update2) => {
+  const observer = useMemo(() => EditorView11.updateListener.of((update2) => {
     if (update2.docChanged || update2.selectionSet) {
       const newState = getFormatting(update2.state);
       if (!state || !compareFormatting(state, newState)) {
@@ -3089,8 +3140,8 @@ var heading2 = () => {
 // packages/ui/react-ui-editor/src/extensions/markdown/hr.ts
 import { syntaxTree as syntaxTree4 } from "@codemirror/language";
 import { RangeSetBuilder as RangeSetBuilder4 } from "@codemirror/state";
-import { Decoration as Decoration7, EditorView as EditorView11, ViewPlugin as ViewPlugin6, WidgetType as WidgetType3 } from "@codemirror/view";
-var styles5 = EditorView11.baseTheme({
+import { Decoration as Decoration7, EditorView as EditorView12, ViewPlugin as ViewPlugin6, WidgetType as WidgetType3 } from "@codemirror/view";
+var styles5 = EditorView12.baseTheme({
   "& .cm-hr": {
     // Note that block-level decorations should not have vertical margins,
     borderTop: `1px solid ${getToken("extend.colors.neutral.200")}`
@@ -3144,7 +3195,7 @@ var hr = () => {
 // packages/ui/react-ui-editor/src/extensions/markdown/image.ts
 import { syntaxTree as syntaxTree5 } from "@codemirror/language";
 import { StateField as StateField4 } from "@codemirror/state";
-import { Decoration as Decoration8, EditorView as EditorView12, WidgetType as WidgetType4 } from "@codemirror/view";
+import { Decoration as Decoration8, EditorView as EditorView13, WidgetType as WidgetType4 } from "@codemirror/view";
 var image = (options = {}) => {
   return StateField4.define({
     create: (state) => {
@@ -3171,7 +3222,7 @@ var image = (options = {}) => {
         add: buildDecorations4(from, to, tr.state)
       });
     },
-    provide: (field) => EditorView12.decorations.from(field)
+    provide: (field) => EditorView13.decorations.from(field)
   });
 };
 var buildDecorations4 = (from, to, state) => {
@@ -3353,12 +3404,12 @@ var buildDecorations5 = (view, options) => {
 // packages/ui/react-ui-editor/src/extensions/markdown/table.ts
 import { syntaxTree as syntaxTree7 } from "@codemirror/language";
 import { RangeSetBuilder as RangeSetBuilder6, StateField as StateField5 } from "@codemirror/state";
-import { Decoration as Decoration10, EditorView as EditorView13, WidgetType as WidgetType6 } from "@codemirror/view";
+import { Decoration as Decoration10, EditorView as EditorView14, WidgetType as WidgetType6 } from "@codemirror/view";
 var table = (options = {}) => {
   return StateField5.define({
     create: (state) => update(state, options),
     update: (_, tr) => update(tr.state, options),
-    provide: (field) => EditorView13.decorations.from(field)
+    provide: (field) => EditorView14.decorations.from(field)
   });
 };
 var update = (state, options) => {
@@ -3451,8 +3502,8 @@ var TableWidget = class extends WidgetType6 {
 // packages/ui/react-ui-editor/src/extensions/markdown/tasklist.ts
 import { syntaxTree as syntaxTree8 } from "@codemirror/language";
 import { RangeSetBuilder as RangeSetBuilder7 } from "@codemirror/state";
-import { EditorView as EditorView14, Decoration as Decoration11, WidgetType as WidgetType7, ViewPlugin as ViewPlugin8 } from "@codemirror/view";
-var styles6 = EditorView14.baseTheme({
+import { EditorView as EditorView15, Decoration as Decoration11, WidgetType as WidgetType7, ViewPlugin as ViewPlugin8 } from "@codemirror/view";
+var styles6 = EditorView15.baseTheme({
   "& .cm-task": {
     color: getToken("extend.colors.blue.500")
   },
@@ -3575,10 +3626,10 @@ var mention = ({ onSearch }) => {
 };
 
 // packages/ui/react-ui-editor/src/extensions/modes.ts
-import { Facet as Facet4 } from "@codemirror/state";
+import { Facet as Facet5 } from "@codemirror/state";
 import { keymap as keymap6 } from "@codemirror/view";
 import { vim } from "@replit/codemirror-vim";
-var editorMode = Facet4.define({
+var editorMode = Facet5.define({
   combine: (modes) => modes[0] ?? {}
 });
 var EditorModes = {
@@ -3942,7 +3993,7 @@ var BaseTextEditor = /* @__PURE__ */ forwardRef(({ model, readonly, autoFocus, s
       selection,
       extensions: [
         // TODO(burdon): Doesn't catch errors in keymap functions.
-        EditorView15.exceptionSink.of((err) => {
+        EditorView16.exceptionSink.of((err) => {
           log3.catch(err, void 0, {
             F: __dxlog_file4,
             L: 113,
@@ -3952,17 +4003,17 @@ var BaseTextEditor = /* @__PURE__ */ forwardRef(({ model, readonly, autoFocus, s
         }),
         // Theme.
         // TODO(burdon): Make configurable.
-        EditorView15.baseTheme(defaultTheme),
-        EditorView15.theme(theme ?? {}),
-        EditorView15.darkTheme.of(themeMode === "dark"),
-        EditorView15.editorAttributes.of({
+        EditorView16.baseTheme(defaultTheme),
+        EditorView16.theme(theme ?? {}),
+        EditorView16.darkTheme.of(themeMode === "dark"),
+        EditorView16.editorAttributes.of({
           class: slots.editor?.className ?? ""
         }),
-        EditorView15.contentAttributes.of({
+        EditorView16.contentAttributes.of({
           class: slots.content?.className ?? ""
         }),
         // Focus.
-        EditorView15.updateListener.of((update2) => {
+        EditorView16.updateListener.of((update2) => {
           update2.transactions.forEach((transaction) => {
             if (transaction.isUserEvent("focus.container")) {
               rootRef.current?.focus();
@@ -3970,7 +4021,7 @@ var BaseTextEditor = /* @__PURE__ */ forwardRef(({ model, readonly, autoFocus, s
           });
         }),
         // State.
-        EditorView15.editable.of(!readonly),
+        EditorView16.editable.of(!readonly),
         EditorState2.readOnly.of(!!readonly),
         // Storage and replication.
         // NOTE: This must come before user extensions.
@@ -3979,7 +4030,7 @@ var BaseTextEditor = /* @__PURE__ */ forwardRef(({ model, readonly, autoFocus, s
         ...extensions
       ].filter(isNotFalsy4)
     });
-    const newView = new EditorView15({
+    const newView = new EditorView16({
       state,
       parent: rootRef.current,
       scrollTo,
@@ -4535,7 +4586,7 @@ var useEditorView = (id) => {
 
 // packages/ui/react-ui-editor/src/hooks/useTextEditor.ts
 import { EditorSelection as EditorSelection2, EditorState as EditorState3 } from "@codemirror/state";
-import { EditorView as EditorView16 } from "@codemirror/view";
+import { EditorView as EditorView17 } from "@codemirror/view";
 import { useEffect as useEffect3, useRef as useRef3, useState as useState4 } from "react";
 import { log as log5 } from "@dxos/log";
 import { isNotFalsy as isNotFalsy5 } from "@dxos/util";
@@ -4552,7 +4603,7 @@ var useTextEditor = ({ autoFocus, scrollTo, debug, doc, selection, extensions }
         selection,
         extensions: [
           // TODO(burdon): Doesn't catch errors in keymap functions.
-          EditorView16.exceptionSink.of((err) => {
+          EditorView17.exceptionSink.of((err) => {
             log5.catch(err, void 0, {
               F: __dxlog_file6,
               L: 60,
@@ -4561,12 +4612,12 @@ var useTextEditor = ({ autoFocus, scrollTo, debug, doc, selection, extensions }
             });
           }),
           extensions,
-          EditorView16.updateListener.of(() => {
+          EditorView17.updateListener.of(() => {
             onUpdate.current?.();
           })
         ].filter(isNotFalsy5)
       });
-      view2 = new EditorView16({
+      view2 = new EditorView17({
         parent: parentRef.current,
         scrollTo,
         state,
@@ -4624,19 +4675,19 @@ var createDataExtensions = ({ readonly = false } = {}) => {
   return [
     //
     EditorState3.readOnly.of(readonly),
-    EditorView16.editable.of(!readonly)
+    EditorView17.editable.of(!readonly)
   ];
 };
 var createThemeExtensions = ({ theme, themeMode, slots } = {}) => {
   return [
     //
-    EditorView16.baseTheme(defaultTheme),
-    theme && EditorView16.theme(theme),
-    EditorView16.darkTheme.of(themeMode === "dark"),
-    EditorView16.editorAttributes.of({
+    EditorView17.baseTheme(defaultTheme),
+    theme && EditorView17.theme(theme),
+    EditorView17.darkTheme.of(themeMode === "dark"),
+    EditorView17.editorAttributes.of({
       class: slots?.editor?.className ?? ""
     }),
-    EditorView16.contentAttributes.of({
+    EditorView17.contentAttributes.of({
       class: slots?.content?.className ?? ""
     })
   ].filter(isNotFalsy5);
@@ -4745,6 +4796,8 @@ export {
   createDataExtensions,
   createMarkdownExtensions,
   createThemeExtensions,
+  cursorLineMargin,
+  cursorLineMarginFacet,
   defaultMarkdownSlots,
   defaultOptions,
   defaultSlots,