@dxos/react-ui-editor 0.6.12-main.ed7cda7 → 0.6.12-staging.e11e696

package/src/extensions/markdown/styles.ts

@@ -39,6 +39,16 @@ export const formattingStyles = EditorView.theme({
     width: `${orderedListIndentationWidth}px`,
   },
 
+  /**
+   * Blockquote.
+   */
+  '& .cm-blockquote': {
+    background: 'var(--dx-cmCodeblock)',
+    borderLeft: '2px solid var(--dx-cmSeparator)',
+    paddingLeft: '1rem',
+    margin: '0',
+  },
+
   /**
    * Code and codeblocks.
    */

package/src/extensions/markdown/table.ts

@@ -25,9 +25,9 @@ export type TableOptions = {};
  * https://github.github.com/gfm/#tables-extension
  */
 export const table = (options: TableOptions = {}): Extension => {
-  return StateField.define<RangeSet<any>>({
+  return StateField.define<RangeSet<Decoration>>({
     create: (state) => update(state, options),
-    update: (_: RangeSet<any>, tr: Transaction) => update(tr.state, options),
+    update: (_: RangeSet<Decoration>, tr: Transaction) => update(tr.state, options),
     provide: (field) => EditorView.decorations.from(field),
   });
 };
@@ -40,7 +40,7 @@ type Table = {
 };
 
 const update = (state: EditorState, _options: TableOptions) => {
-  const builder = new RangeSetBuilder();
+  const builder = new RangeSetBuilder<Decoration>();
   const cursor = state.selection.main.head;
 
   const tables: Table[] = [];

package/src/extensions/modes.ts

@@ -2,26 +2,27 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type Extension, Facet } from '@codemirror/state';
+import { type Extension } from '@codemirror/state';
 import { keymap } from '@codemirror/view';
 import { vim } from '@replit/codemirror-vim';
 import { vscodeKeymap } from '@replit/codemirror-vscode-keymap';
 
+import { singleValueFacet } from '../state';
+
 export const focusEvent = 'focus.container';
 
 export const EditorViewModes = ['preview', 'readonly', 'source'] as const;
 export type EditorViewMode = (typeof EditorViewModes)[number];
+
 export const EditorInputModes = ['default', 'vim', 'vscode'] as const;
 export type EditorInputMode = (typeof EditorInputModes)[number];
 
 export type EditorInputConfig = {
-  type: string;
+  type?: string;
   noTabster?: boolean;
 };
 
-export const editorInputMode = Facet.define<EditorInputConfig, EditorInputConfig>({
-  combine: (modes) => modes[0] ?? {},
-});
+export const editorInputMode = singleValueFacet<EditorInputConfig>({});
 
 export const InputModeExtensions: { [mode: string]: Extension } = {
   default: [],

package/src/extensions/util/overlap.ts

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type Range } from '../types';
+import { type Range } from '../../state';
 
 /**
  * Determines if two ranges overlap.

package/src/extensions/util/react.tsx

@@ -8,6 +8,8 @@ import { createRoot } from 'react-dom/client';
 import { ThemeProvider } from '@dxos/react-ui';
 import { defaultTx } from '@dxos/react-ui-theme';
 
+// TODO(burdon): Factor out.
+
 export type ElementOptions = {
   className?: string;
 };
@@ -23,7 +25,9 @@ export const createElement = (tag: string, options?: ElementOptions, children?:
   return el;
 };
 
-export const renderRoot = (root: HTMLElement, node: ReactNode): HTMLElement => {
+// TODO(burdon): Remove react rendering; use DOM directly.
+// NOTE: CM seems to remove/detach/overwrite portals that are attached to the DOM it control.s
+export const renderRoot = <T extends Element>(root: T, node: ReactNode): T => {
   createRoot(root).render(<ThemeProvider tx={defaultTx}>{node}</ThemeProvider>);
   return root;
 };

package/src/hooks/useTextEditor.ts

@@ -19,10 +19,12 @@ import {
 import { log } from '@dxos/log';
 import { getProviderValue, isNotFalsy, type MaybeProvider } from '@dxos/util';
 
-import { createEditorStateTransaction, documentId, editorInputMode, type EditorSelection } from '../extensions';
+import { editorInputMode } from '../extensions';
+import { type EditorSelection, createEditorStateTransaction, documentId } from '../state';
 import { logChanges } from '../util';
 
 export type UseTextEditor = {
+  // TODO(burdon): Rename.
   parentRef: RefObject<HTMLDivElement>;
   view?: EditorView;
   focusAttributes: ReturnType<typeof useFocusableGroup> & {
@@ -109,7 +111,6 @@ export const useTextEditor = (
       // https://codemirror.net/docs/ref/#view.EditorViewConfig
       view = new EditorView({
         parent: parentRef.current,
-        selection: initialSelection,
         state,
         // NOTE: Uncomment to debug/monitor all transactions.
         // https://codemirror.net/docs/ref/#view.EditorView.dispatch

package/src/index.ts

@@ -14,6 +14,7 @@ export * from './components';
 export * from './defaults';
 export * from './extensions';
 export * from './hooks';
+export * from './state';
 export * from './util';
 
 export { translations };

package/src/{extensions → state}/cursor.ts

@@ -2,9 +2,10 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type EditorState, Facet } from '@codemirror/state';
+import { type EditorState } from '@codemirror/state';
 
 import { type Range } from './types';
+import { singleValueFacet } from './util';
 
 /**
  * Converts indexes into the text document into stable peer-independent cursors.
@@ -27,11 +28,7 @@ const defaultCursorConverter: CursorConverter = {
 };
 
 export class Cursor {
-  static readonly converter = Facet.define<CursorConverter, CursorConverter>({
-    combine: (providers) => {
-      return providers[0] ?? defaultCursorConverter;
-    },
-  });
+  static readonly converter = singleValueFacet(defaultCursorConverter);
 
   static readonly getCursorFromRange = (state: EditorState, range: Range) => {
     const cursorConverter = state.facet(Cursor.converter);

package/src/state/doc.ts

@@ -0,0 +1,10 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { singleValueFacet } from './util';
+
+/**
+ * Currently edited document id as FQ string.
+ */
+export const documentId = singleValueFacet<string>();

package/src/state/index.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+// Non-UX exports.
+
+export * from './cursor';
+export * from './doc';
+export * from './state';
+export * from './types';
+export * from './util';

package/src/{extensions → state}/state.ts

@@ -54,6 +54,7 @@ export const createEditorStateTransaction = ({ scrollTo, selection }: EditorSele
 /**
  * Track scrolling and selection state to be restored when switching to document.
  */
+// TODO(burdon): Rename.
 export const state = ({ getState, setState }: Partial<EditorStateOptions> = {}): Extension => {
   const setStateDebounced = debounce(setState!, 1_000);
 

package/src/state/util.ts

@@ -0,0 +1,13 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Facet } from '@codemirror/state';
+
+export const singleValueFacet = <I, O = I>(defaultValue?: O) =>
+  Facet.define<I, O>({
+    // Called immediately.
+    combine: (providers) => {
+      return (providers[0] ?? defaultValue) as O;
+    },
+  });

package/src/styles/markdown.ts

@@ -17,11 +17,9 @@ const headings: Record<HeadingLevel, string> = {
 };
 
 export const theme = {
-  mark: 'opacity-50',
   code: 'font-mono !no-underline text-neutral-700 dark:text-neutral-300',
   codeMark: 'font-mono text-primary-500',
-  // TODO(burdon): Replace with widget.
-  blockquote: 'pl-1 mr-1 border-is-4 border-orange-500 dark:border-orange-500 dark:text-neutral-500',
+  mark: 'opacity-50',
   heading: (level: HeadingLevel) => {
     return mx(headings[level], 'dark:text-primary-400');
   },

package/src/styles/theme.ts

@@ -71,9 +71,11 @@ export const defaultTheme: ThemeStyles = {
   /**
    * Gutters
    * NOTE: Gutters should have the same top margin as the content.
+   * NOTE: They can't be transparent since the content needs to scroll below.
    */
   '.cm-gutters': {
     background: 'var(--surface-bg)',
+    borderRight: 'none',
   },
   '.cm-gutter': {},
   '.cm-gutter.cm-lineNumbers .cm-gutterElement': {

package/dist/types/src/extensions/cursor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"cursor.d.ts","sourceRoot":"","sources":["../../../../src/extensions/cursor.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;;;;;;;;GASG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS,GAAG,MAAM,CAAC;IAC/D,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;CACpC;AAOD,qBAAa,MAAM;IACjB,MAAM,CAAC,QAAQ,CAAC,SAAS,0CAItB;IAEH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,UAAW,WAAW,SAAS,KAAK,YAMpE;IAEF,MAAM,CAAC,QAAQ,CAAC,kBAAkB,UAAW,WAAW,UAAU,MAAM;;;kBAOtE;CACH"}

package/dist/types/src/extensions/doc.d.ts

@@ -1,6 +0,0 @@
-import { Facet } from '@codemirror/state';
-/**
- * Currently edited document id as FQ string.
- */
-export declare const documentId: Facet<string, string>;
-//# sourceMappingURL=doc.d.ts.map

package/dist/types/src/extensions/doc.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"doc.d.ts","sourceRoot":"","sources":["../../../../src/extensions/doc.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAI1C;;GAEG;AACH,eAAO,MAAM,UAAU,uBAKrB,CAAC"}

package/dist/types/src/extensions/state.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../../../src/extensions/state.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,SAAS,EAAe,KAAK,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAWtF,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAC5D,QAAQ,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,oBAAoB,GAAG,SAAS,CAAC;CAC5D,CAAC;AAGF,eAAO,MAAM,6BAA6B,EAAE,kBAW3C,CAAC;AAEF,eAAO,MAAM,4BAA4B,4BAA6B,oBAAoB,KAAG,eAO5F,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,KAAK,4BAA4B,OAAO,CAAC,kBAAkB,CAAC,KAAQ,SAuChF,CAAC"}

package/dist/types/src/extensions/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/extensions/types.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAIF,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/src/extensions/doc.ts

@@ -1,17 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Facet } from '@codemirror/state';
-
-import { invariant } from '@dxos/invariant';
-
-/**
- * Currently edited document id as FQ string.
- */
-export const documentId = Facet.define<string, string>({
-  combine: (providers) => {
-    invariant(providers.length <= 1);
-    return providers[0];
-  },
-});