@dxos/react-ui-editor 0.3.10-next.ef70620 → 0.3.11-main.1caa3af

package/src/components/TextEditor/extensions/table.ts

@@ -0,0 +1,132 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { syntaxTree } from '@codemirror/language';
+import { type EditorState, type RangeSet, RangeSetBuilder, StateField, type Transaction } from '@codemirror/state';
+import { Decoration, EditorView, WidgetType } from '@codemirror/view';
+
+// TODO(burdon): Snippet to create basic table.
+//  https://codemirror.net/docs/ref/#autocomplete.snippet
+
+// TODO(burdon): Advanced formatting (left/right/center).
+// TODO(burdon): Editor to auto balance columns.
+
+export type TableOptions = {};
+
+/**
+ * GFM tables.
+ * https://github.github.com/gfm/#tables-extension
+ */
+export const table = (options: TableOptions = {}) => {
+  return StateField.define<RangeSet<any>>({
+    create: (state) => update(state, options),
+    update: (_: RangeSet<any>, tr: Transaction) => update(tr.state, options),
+    provide: (field) => EditorView.decorations.from(field),
+  });
+};
+
+type Table = {
+  from: number;
+  to: number;
+  header?: string[];
+  rows?: string[][];
+};
+
+const update = (state: EditorState, options: TableOptions) => {
+  const builder = new RangeSetBuilder();
+  const cursor = state.selection.main.head;
+
+  const tables: Table[] = [];
+  const getTable = () => tables[tables.length - 1];
+  const getRow = () => {
+    const table = getTable();
+    return table.rows?.[table.rows.length - 1];
+  };
+
+  // Parse table.
+  syntaxTree(state).iterate({
+    enter: (node) => {
+      // Check if cursor is inside text.
+      switch (node.name) {
+        case 'Table': {
+          tables.push({ from: node.from, to: node.to });
+          break;
+        }
+        case 'TableHeader': {
+          getTable().header = [];
+          break;
+        }
+        case 'TableRow': {
+          (getTable().rows ??= []).push([]);
+          break;
+        }
+        case 'TableCell': {
+          const row = getRow();
+          if (row) {
+            row.push(state.sliceDoc(node.from, node.to));
+          } else {
+            getTable().header?.push(state.sliceDoc(node.from, node.to));
+          }
+          break;
+        }
+      }
+    },
+  });
+
+  tables.forEach((table) => {
+    const hide = state.readOnly || cursor < table.from || cursor > table.to;
+    hide &&
+      builder.add(
+        table.from,
+        table.to,
+        Decoration.replace({
+          block: true,
+          widget: new TableWidget(table),
+        }),
+      );
+
+    // Add class for styling.
+    builder.add(table.from, table.to, Decoration.mark({ class: 'cm-table' }));
+  });
+
+  return builder.finish();
+};
+
+class TableWidget extends WidgetType {
+  constructor(readonly _table: Table) {
+    super();
+  }
+
+  override eq(other: WidgetType) {
+    return this._table.from === (other as any as TableWidget)?._table?.from;
+  }
+
+  toDOM(view: EditorView) {
+    const table = document.createElement('table');
+
+    {
+      const header = table.appendChild(document.createElement('thead'));
+      const tr = header.appendChild(document.createElement('tr'));
+      this._table.header?.forEach((cell) => {
+        const th = document.createElement('th');
+        th.setAttribute('class', 'cm-table-head');
+        tr.appendChild(th).textContent = cell;
+      });
+    }
+
+    {
+      const body = table.appendChild(document.createElement('tbody'));
+      this._table.rows?.forEach((row) => {
+        const tr = body.appendChild(document.createElement('tr'));
+        row.forEach((cell) => {
+          const td = document.createElement('td');
+          td.setAttribute('class', 'cm-table-cell');
+          tr.appendChild(td).textContent = cell;
+        });
+      });
+    }
+
+    return table;
+  }
+}

package/src/components/TextEditor/extensions/tasklist.ts

@@ -0,0 +1,121 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import {
+  EditorView,
+  Decoration,
+  WidgetType,
+  MatchDecorator,
+  ViewPlugin,
+  type DecorationSet,
+  type ViewUpdate,
+} from '@codemirror/view';
+
+// TODO(burdon): Reconcile with theme.
+const styles = EditorView.baseTheme({
+  '& .cm-task-item': {
+    paddingLeft: '4px',
+    paddingRight: '8px',
+  },
+});
+
+class CheckboxWidget extends WidgetType {
+  constructor(
+    private readonly _pos: number,
+    private _checked: boolean,
+    private readonly _indent: number,
+    private readonly _onCheck?: (check: boolean) => void,
+  ) {
+    super();
+  }
+
+  override eq(other: CheckboxWidget) {
+    return this._pos === other._pos && this._checked === other._checked && this._indent === other._indent;
+  }
+
+  toDOM(view: EditorView) {
+    const wrap = document.createElement('span');
+    wrap.className = 'cm-task-item';
+    wrap.setAttribute('aria-hidden', 'true');
+    wrap.style.setProperty('margin-left', this._indent * 24 + 'px');
+
+    const input = wrap.appendChild(document.createElement('input'));
+    input.type = 'checkbox';
+    input.checked = this._checked;
+    if (!this._onCheck) {
+      input.setAttribute('disabled', 'true');
+    }
+    if (this._onCheck) {
+      input.onchange = (event: Event) => {
+        this._onCheck?.((event.target as any).checked);
+        return true;
+      };
+    }
+
+    return wrap;
+  }
+
+  override ignoreEvent() {
+    return false;
+  }
+}
+
+export type TasklistOptions = {};
+
+export const tasklist = (options: TasklistOptions = {}) => {
+  // TODO(burdon): Matcher isn't as precise as syntax tree.
+  //  Allows for indents to be greater than AST would allow.
+  const taskMatcher = new MatchDecorator({
+    regexp: /^(\s*)- \[([ xX])\]\s/g,
+    decoration: (match, view, pos) => {
+      const indent = Math.floor(match[1].length / 2);
+      const checked = match[2] === 'x' || match[2] === 'X';
+      return Decoration.replace({
+        widget: new CheckboxWidget(
+          pos,
+          checked,
+          indent,
+          view.state.readOnly
+            ? undefined
+            : (checked) => {
+                const idx = pos + match[0].indexOf('[') + 1;
+                view.dispatch({
+                  changes: {
+                    from: idx,
+                    to: idx + 1,
+                    insert: checked ? 'x' : ' ',
+                  },
+                  // TODO(burdon): Restore cursor position? More useful to move to end of line (can indent).
+                  selection: {
+                    anchor: idx + 3,
+                  },
+                });
+              },
+        ),
+      });
+    },
+  });
+
+  const tasks = ViewPlugin.fromClass(
+    class {
+      tasks: DecorationSet;
+      constructor(view: EditorView) {
+        this.tasks = taskMatcher.createDeco(view);
+      }
+
+      update(update: ViewUpdate) {
+        this.tasks = taskMatcher.updateDeco(update, this.tasks);
+      }
+    },
+    {
+      decorations: (value) => value.tasks,
+      provide: (plugin) =>
+        EditorView.atomicRanges.of((view) => {
+          return view.plugin(plugin)?.tasks || Decoration.none;
+        }),
+    },
+  );
+
+  return [tasks, styles];
+};

package/src/components/TextEditor/extensions/{hyperlink/hyperlinkTooltip.tsx → tooltip.ts}

@@ -2,21 +2,24 @@
 // Copyright 2023 DXOS.org
 //
 
+import { type Extension } from '@codemirror/state';
 import { hoverTooltip } from '@codemirror/view';
 
 import { tooltipContent } from '@dxos/react-ui-theme';
 
 const markdownLinkRegexp = /\[([^\]]+)]\(([^)]+)\)/;
 
-export type OnHyperlinkHover = (el: Element, url: string) => void;
+export type TooltipOptions = {
+  onHover: (el: Element, url: string) => void;
+  regexp?: RegExp;
+};
 
 /**
  * https://codemirror.net/examples/tooltip
  * https://codemirror.net/docs/ref/#view.hoverTooltip
  * https://github.com/codemirror/view/blob/main/src/tooltip.ts
  */
-// TODO(burdon): Create config object.
-export const createHyperlinkTooltip = (onHover: OnHyperlinkHover, regexp = markdownLinkRegexp) =>
+export const tooltip = ({ onHover, regexp = markdownLinkRegexp }: TooltipOptions): Extension =>
   hoverTooltip((view, pos) => {
     const { from, text } = view.state.doc.lineAt(pos);
     const p = pos - from;
@@ -49,13 +52,10 @@ export const createHyperlinkTooltip = (onHover: OnHyperlinkHover, regexp = markd
       end: idx + from + match[0].length,
       above: true,
       create: () => {
-        const el = document.createElement('a');
-        el.innerText = '_'; // Required so doesn't collapse.
-        el.className = tooltipContent({}, 'mb-2 p-1');
-        el.setAttribute('target', '_blank');
-        el.setAttribute('href', url);
+        const el = document.createElement('div');
+        el.className = tooltipContent({}, 'pli-2 plb-1');
         onHover(el, url);
-        return { dom: el };
+        return { dom: el, offset: { x: 0, y: 4 } };
       },
     };
   });

package/src/components/TextEditor/extensions/typewriter.ts

@@ -0,0 +1,68 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Extension } from '@codemirror/state';
+import { keymap } from '@codemirror/view';
+
+// TODO(burdon): Review https://github.com/sergeche/codemirror-movie?tab=readme-ov-file
+
+export type DemoOptions = {
+  delay?: number;
+  items?: string[];
+};
+
+const defaultItems = ['hello world!', 'this is a test.', 'this is [DXOS](https://dxos.org)'];
+
+/**
+ * Configurable plugin that let's user cycle through pre-configured input script.
+ */
+export const typewriter = ({ delay = 75, items = defaultItems }: DemoOptions = {}): Extension => {
+  let t: any;
+  let idx = 0;
+
+  return [
+    keymap.of([
+      {
+        // Reset.
+        key: "alt-meta-'",
+        run: (view) => {
+          clearTimeout(t);
+          idx = 0;
+          return true;
+        },
+      },
+      {
+        // Next prompt.
+        // TODO(burdon): Press 1-9 to select prompt?
+        key: "shift-meta-'",
+        run: (view) => {
+          clearTimeout(t);
+          // TODO(burdon): Add space if needed.
+          const text = items[idx++];
+          if (idx === items?.length) {
+            idx = 0;
+          }
+
+          let i = 0;
+          const insert = (d = 0) => {
+            t = setTimeout(() => {
+              const pos = view.state.selection.main.head;
+              view.dispatch({
+                changes: { from: pos, insert: text[i++] },
+                selection: { anchor: pos + 1 },
+              });
+
+              if (i < text.length) {
+                insert(Math.random() * delay * (text[i] === ' ' ? 2 : 1));
+              }
+            }, d);
+          };
+
+          insert();
+          return true;
+        },
+      },
+    ]),
+  ];
+};

package/src/components/TextEditor/extensions/util.ts

@@ -0,0 +1,18 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { log } from '@dxos/log';
+
+/**
+ * CodeMirror callbacks swallow errors so wrap handlers.
+ */
+// TODO(burdon): Figure out how to systematize this.
+export const callbackWrapper = <T extends Function>(fn: T): T =>
+  ((...args: any[]) => {
+    try {
+      return fn(...args);
+    } catch (error) {
+      log.catch(error);
+    }
+  }) as unknown as T;

package/src/components/TextEditor/index.ts

@@ -3,6 +3,9 @@
 //
 
 export { tags } from '@lezer/highlight';
+export { type Extension } from '@codemirror/state';
 
 export * from './extensions';
+export * from './themes';
+
 export * from './TextEditor';

package/src/components/TextEditor/themes/default.ts

@@ -0,0 +1,302 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import get from 'lodash.get';
+
+import { type ThemeStyles, tokens } from '../../../styles';
+
+// TODO(burdon): Can we erase All of the default CM styles?
+// TODO(burdon): Theme styles seem to be added multiple times?
+
+/**
+ * Minimal styles.
+ * https://codemirror.net/examples/styling
+ *
+ * Examples:
+ * - https://github.com/codemirror/view/blob/main/src/theme.ts
+ * - https://github.com/codemirror/theme-one-dark/blob/main/src/one-dark.ts
+ *
+ * NOTE: Use one of '&', '&light', and '&dark' prefix to scope instance.
+ * NOTE: `light` and `dark` selectors are preprocessed by CodeMirror and can only be in the base theme.
+ */
+export const defaultTheme: ThemeStyles = {
+  //
+  // Main layout:
+  // https://codemirror.net/examples/styling
+  //
+  // <div class="cm-editor [cm-focused] [generated classes]">
+  //   <div class="cm-scroller">
+  //     <div class="cm-gutters">
+  //       <div class="cm-gutter [...]">
+  //         <div class="cm-gutterElement">...</div>
+  //       </div>
+  //     </div>
+  //     <div class="cm-content" role="textbox" contenteditable="true">
+  //       <div class="cm-line"></div>
+  //     </div>
+  //     <div class="cm-selectionLayer">
+  //       <div class="cm-selectionBackground"></div>
+  //     </div>
+  //     <div class="cm-cursorLayer">
+  //       <div class="cm-cursor"></div>
+  //     </div>
+  //   </div>
+  // </div>
+  //
+
+  '&': {},
+  '&.cm-focused': {
+    outline: 'none',
+  },
+  '& .cm-scroller': {
+    overflow: 'visible',
+    fontFamily: get(tokens, 'fontFamily.mono', []).join(','),
+  },
+
+  '& .cm-content': {
+    padding: 0,
+    // NOTE: Base font size (otherwise defined by HTML tag, which might be different for storybook).
+    fontSize: '16px',
+  },
+  '&light .cm-content': {
+    color: get(tokens, 'extend.colors.neutral.900', 'black'),
+    caretColor: 'black',
+  },
+  '&dark .cm-content': {
+    color: get(tokens, 'extend.colors.neutral.100', 'white'),
+    caretColor: 'white',
+  },
+
+  //
+  // Cursor
+  //
+  '&light .cm-cursor, &light .cm-dropCursor': {
+    borderLeft: '2px solid black',
+  },
+  '&dark .cm-cursor, &dark .cm-dropCursor': {
+    borderLeft: '2px solid white',
+  },
+  '& .cm-placeholder': {
+    fontWeight: 100,
+  },
+
+  //
+  // line
+  //
+  '& .cm-line': {
+    paddingInline: 0,
+  },
+  '& .cm-activeLine': {
+    background: 'inherit',
+  },
+
+  //
+  // Selection
+  //
+
+  '&light .cm-selectionBackground': {
+    background: get(tokens, 'extend.colors.primary.100'),
+  },
+  '&light.cm-focused > .cm-scroller > .cm-selectionLayer .cm-selectionBackground': {
+    background: get(tokens, 'extend.colors.primary.200'),
+  },
+  '&dark .cm-selectionBackground': {
+    background: get(tokens, 'extend.colors.primary.700'),
+  },
+  '&dark.cm-focused > .cm-scroller > .cm-selectionLayer .cm-selectionBackground': {
+    background: get(tokens, 'extend.colors.primary.600'),
+  },
+
+  //
+  // Search
+  //
+
+  '&light .cm-searchMatch': {
+    backgroundColor: get(tokens, 'extend.colors.yellow.100'),
+  },
+  '&dark .cm-searchMatch': {
+    backgroundColor: get(tokens, 'extend.colors.yellow.700'),
+  },
+
+  //
+  // collaboration
+  // TODO(burdon): Review classnames (YJS dependent?) Note: e2e tests depend on this class.
+  //
+
+  '&light .cm-ySelection, &light .cm-yLineSelection': {
+    mixBlendMode: 'multiply',
+  },
+  '&dark .cm-ySelection, &dark .cm-yLineSelection': {
+    mixBlendMode: 'screen',
+  },
+
+  '& .cm-ySelectionInfo': {
+    padding: '2px 4px',
+    marginBlockStart: '-4px',
+  },
+  '& .cm-ySelection, & .cm-selectionMatch': {
+    paddingBlockStart: '.15em',
+    paddingBlockEnd: '.15em',
+  },
+  '& .cm-ySelectionCaret': {
+    display: 'inline-block',
+    insetBlockStart: '.1em',
+    blockSize: '1.4em',
+    verticalAlign: 'top',
+  },
+  '& .cm-yLineSelection': {
+    margin: 0,
+  },
+
+  //
+  // link
+  //
+  '& .cm-link': {
+    color: get(tokens, 'extend.colors.primary.500'),
+    textDecorationLine: 'underline',
+    textDecorationThickness: '1px',
+    textUnderlineOffset: '2px',
+    borderRadius: '.125rem',
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+  },
+
+  //
+  // tooltip
+  //
+  '& .cm-tooltip': {
+    border: 'none',
+  },
+  '& .cm-tooltip-below': {},
+
+  //
+  // autocomplete
+  //
+  '& .cm-tooltip-autocomplete': {
+    marginTop: '4px',
+    marginLeft: '-3px',
+  },
+  '& .cm-tooltip-autocomplete ul li': {},
+  '& .cm-tooltip-autocomplete ul li[aria-selected]': {},
+  '& .cm-completionIcon': {
+    display: 'none',
+  },
+  '& .cm-completionLabel': {
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+  },
+  '& .cm-completionMatchedText': {
+    textDecoration: 'none',
+  },
+
+  //
+  // widgets
+  //
+  '& .cm-widgetBuffer': {
+    display: 'none',
+    height: 0,
+  },
+
+  //
+  // table
+  //
+  '& .cm-table *': {
+    fontFamily: `${get(tokens, 'fontFamily.mono', []).join(',')} !important`,
+    textDecoration: 'none !important',
+  },
+  '& .cm-table-head': {
+    padding: '2px 16px 2px 0px',
+    borderBottom: `1px solid ${get(tokens, 'extend.colors.neutral.500')}`,
+    fontWeight: 100,
+    textAlign: 'left',
+    color: get(tokens, 'extend.colors.neutral.500'),
+  },
+  '& .cm-table-cell': {
+    padding: '2px 16px 2px 0px',
+  },
+
+  //
+  // image
+  //
+  '& .cm-image': {
+    margin: '0.5rem 0',
+  },
+
+  //
+  // font size
+  // TODO(thure): This appears to be the best or only way to set selection caret heights, but it's far more verbose than it needs to be.
+  //
+  ...Object.keys(get(tokens, 'extend.fontSize', {})).reduce((acc: Record<string, any>, fontSize) => {
+    const height = get(tokens, ['extend', 'fontSize', fontSize, 1, 'lineHeight']);
+
+    acc[`& .text-${fontSize} + .cm-ySelectionCaret`] = { height };
+    acc[`& .text-${fontSize} + .cm-ySelection + .cm-ySelectionCaret`] = { height };
+    acc[`& .text-${fontSize} + .cm-widgetBuffer + .cm-ySelectionCaret`] = { height };
+    return acc;
+  }, {}),
+
+  /**
+   * Panels
+   * TODO(burdon): Needs styling attention (esp. dark mode).
+   * https://github.com/codemirror/search/blob/main/src/search.ts#L745
+   *
+   * Find/replace panel.
+   * <div class="cm-announced">...</div>
+   * <div class="cm-scroller">...</div>
+   * <div class="cm-panels cm-panels-bottom">
+   *   <div class="cm-search cm-panel">
+   *     <input class="cm-textfield" />
+   *     <button class="cm-button">...</button>
+   *     <label><input type="checkbox" />...</label>
+   *   </div>
+   * </div
+   */
+  '& .cm-panels': {
+    border: `1px solid ${get(tokens, 'extend.colors.neutral.200')}`,
+  },
+  '& .cm-panel': {
+    background: get(tokens, 'extend.colors.neutral.50'),
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+  },
+  '& .cm-button': {
+    margin: '4px',
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+    background: get(tokens, 'extend.colors.neutral.100'),
+    backgroundImage: 'none',
+    border: 'none',
+    '&:hover': {
+      background: get(tokens, 'extend.colors.neutral.200'),
+    },
+    '&:active': {
+      background: get(tokens, 'extend.colors.neutral.300'),
+      backgroundImage: 'none',
+    },
+  },
+  '& .cm-panel input[type=checkbox]': {
+    marginRight: '0.4rem !important',
+  },
+};
+
+export const textTheme: ThemeStyles = {
+  '& .cm-scroller': {
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+  },
+  '& .cm-placeholder': {
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+  },
+};
+
+export const markdownTheme: ThemeStyles = {
+  // NOTE: Must leave base font family as is (i.e., monospace) due to fenced code blocks.
+  '& .cm-placeholder': {
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+  },
+};
+
+export const codeTheme: ThemeStyles = {
+  '& .cm-scroller': {
+    fontFamily: get(tokens, 'fontFamily.mono', []).join(','),
+  },
+  '& .cm-placeholder': {
+    fontFamily: get(tokens, 'fontFamily.mono', []).join(','),
+  },
+};

package/src/components/TextEditor/themes/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export * from './default';