@dxos/react-ui-editor 0.3.10-next.ef70620 → 0.3.10

package/src/components/TextEditor/extensions/markdown/highlight.ts

@@ -0,0 +1,207 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { markdownLanguage } from '@codemirror/lang-markdown';
+import { HighlightStyle } from '@codemirror/language';
+import { tags, styleTags, Tag } from '@lezer/highlight';
+import { type MarkdownConfig, Table } from '@lezer/markdown';
+import get from 'lodash.get';
+
+import { mx } from '@dxos/react-ui-theme';
+
+import {
+  blockquote,
+  bold,
+  code,
+  codeMark,
+  heading,
+  horizontalRule,
+  inlineUrl,
+  italic,
+  mark,
+  strikethrough,
+  tokens,
+} from '../../../../styles';
+
+/**
+ * Custom tags defined and processed by the GFM lezer extension.
+ * https://github.com/lezer-parser/markdown
+ * https://github.com/lezer-parser/markdown/blob/main/src/markdown.ts
+ */
+export const markdownTags = {
+  Blockquote: Tag.define(),
+  CodeMark: Tag.define(),
+  CodeText: Tag.define(),
+  EmphasisMark: Tag.define(),
+  HeaderMark: Tag.define(),
+  HorizontalRule: Tag.define(),
+  InlineCode: Tag.define(),
+  LinkLabel: Tag.define(),
+  LinkReference: Tag.define(),
+  ListMark: Tag.define(),
+  QuoteMark: Tag.define(),
+  URL: Tag.define(),
+
+  // Custom.
+  TableCell: Tag.define(),
+};
+
+// TODO(burdon): Customize table parser (make all content monospace).
+//  https://github.com/lezer-parser/markdown/blob/main/src/extension.ts
+Table.defineNodes?.forEach((node: any) => {
+  switch (node?.name) {
+    case 'TableCell': {
+      node.style = markdownTags.TableCell;
+      break;
+    }
+  }
+});
+
+export const markdownTagsExtensions: MarkdownConfig[] = [
+  Table,
+  {
+    props: [styleTags(markdownTags)],
+  },
+];
+
+/**
+ * Styling based on `lezer` parser tags.
+ * https://codemirror.net/examples/styling
+ * https://github.com/lezer-parser/highlight
+ * https://github.com/lezer-parser/highlight/blob/main/src/highlight.ts#L427
+ * https://lezer.codemirror.net/docs/ref/#highlight.tags (list of tags)
+ *
+ * Examples:
+ * - https://github.com/codemirror/language/blob/main/src/highlight.ts#L194
+ * - https://github.com/codemirror/theme-one-dark/blob/main/src/one-dark.ts#L115
+ */
+export const markdownHighlightStyle = (readonly?: boolean) => {
+  return HighlightStyle.define(
+    [
+      {
+        tag: [
+          tags.keyword,
+          tags.name,
+          tags.deleted,
+          tags.character,
+          tags.propertyName,
+          tags.macroName,
+          tags.color,
+          tags.constant(tags.name),
+          tags.standard(tags.name),
+          tags.definition(tags.name),
+          tags.separator,
+          tags.typeName,
+          tags.className,
+          tags.number,
+          tags.changed,
+          tags.annotation,
+          tags.modifier,
+          tags.self,
+          tags.namespace,
+          tags.operator,
+          tags.operatorKeyword,
+          tags.escape,
+          tags.regexp,
+          tags.special(tags.string),
+          tags.meta,
+          tags.comment,
+          tags.atom,
+          tags.bool,
+          tags.special(tags.variableName),
+          tags.processingInstruction,
+          tags.string,
+          tags.inserted,
+          tags.invalid,
+        ],
+        color: 'inherit !important',
+      },
+
+      // Markdown marks.
+      {
+        tag: [
+          tags.meta,
+          tags.processingInstruction,
+          markdownTags.LinkLabel,
+          markdownTags.LinkReference,
+          markdownTags.ListMark,
+        ],
+        class: mark,
+      },
+
+      // Markdown marks.
+      {
+        tag: [markdownTags.CodeMark, markdownTags.HeaderMark, markdownTags.QuoteMark, markdownTags.EmphasisMark],
+        class: readonly ? 'hidden' : mark,
+      },
+
+      // E.g., code block language (after ```).
+      {
+        tag: [tags.function(tags.variableName), tags.labelName],
+        class: readonly ? 'hidden' : codeMark,
+      },
+
+      {
+        tag: [tags.monospace],
+        class: 'font-mono',
+      },
+
+      // Headings.
+      { tag: tags.heading1, class: heading(1, readonly) },
+      { tag: tags.heading2, class: heading(2, readonly) },
+      { tag: tags.heading3, class: heading(3, readonly) },
+      { tag: tags.heading4, class: heading(4, readonly) },
+      { tag: tags.heading5, class: heading(5, readonly) },
+      { tag: tags.heading6, class: heading(6, readonly) },
+
+      // Emphasis.
+      { tag: tags.emphasis, class: italic },
+      { tag: tags.strong, class: bold },
+      { tag: tags.strikethrough, class: strikethrough },
+
+      // Naked URLs.
+      {
+        tag: [markdownTags.URL],
+        class: inlineUrl,
+      },
+
+      // NOTE: The `markdown` extension configures extensions for `lezer` to parse markdown tokens (incl. below).
+      // However, since `codeLanguages` is also defined, the `lezer` will not parse fenced code blocks,
+      // when a language is specified. In this case, the syntax highlighting extensions will colorize
+      // the code, but all other CSS properties will be inherited.
+      // IMPORTANT: Therefore, the fenced code block will use the base editor font.
+      {
+        tag: [markdownTags.CodeText, markdownTags.InlineCode],
+        class: code,
+      },
+
+      {
+        tag: [markdownTags.QuoteMark],
+        class: blockquote,
+      },
+
+      // TODO(burdon): Replace with extension.
+      {
+        tag: [markdownTags.HorizontalRule],
+        class: mx(horizontalRule, readonly && '-indent-[100rem]'),
+      },
+
+      // TODO(burdon): Only if being edited.
+      {
+        tag: [markdownTags.TableCell],
+        class: 'font-mono',
+      },
+
+      // Main content, paragraphs, etc.
+      // {
+      //   tag: [tags.content],
+      //   fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+      // },
+    ],
+    {
+      scope: markdownLanguage,
+      all: { fontFamily: get(tokens, 'fontFamily.body', []).join(',') },
+    },
+  );
+};

package/src/components/TextEditor/extensions/markdown/index.ts

@@ -3,4 +3,4 @@
 //
 
 export * from './bundle';
-export * from './theme';
+export * from './highlight';

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

@@ -0,0 +1,31 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { autocompletion, type CompletionContext, type CompletionResult } from '@codemirror/autocomplete';
+import type { Extension } from '@codemirror/state';
+
+export type MentionOptions = {
+  onSearch: (text: string) => string[];
+};
+
+export const mention = ({ onSearch }: MentionOptions): Extension => {
+  return autocompletion({
+    closeOnBlur: false, // For debugging.
+    override: [
+      (context: CompletionContext): CompletionResult | null => {
+        const match = context.matchBefore(/@(\w+)?/);
+        if (!match || (match.from === match.to && !context.explicit)) {
+          return null;
+        }
+
+        console.log(match);
+
+        return {
+          from: match.from,
+          options: onSearch(match.text.slice(1).toLowerCase()).map((value) => ({ label: `@${value}` })),
+        };
+      },
+    ],
+  });
+};

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

@@ -0,0 +1,119 @@
+//
+// 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
+
+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({ widget: new TableWidget(table) }));
+    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.tsx}

@@ -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: 12 } };
       },
     };
   });

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';