@dxos/react-ui-editor 0.3.10-next.ef70620 → 0.3.11-main.008b7c6

package/src/extensions/link.ts

@@ -0,0 +1,192 @@
+//
+// Copyright 2023 DXOS.org
+// Copyright CodeMirror
+//
+
+import { syntaxTree } from '@codemirror/language';
+import {
+  type EditorState,
+  type Extension,
+  type RangeSet,
+  RangeSetBuilder,
+  StateField,
+  type Transaction,
+} from '@codemirror/state';
+import { Decoration, EditorView, WidgetType, hoverTooltip } from '@codemirror/view';
+
+import { tooltipContent } from '@dxos/react-ui-theme';
+
+const markdownLinkRegexp = /\[([^\]]+)]\(([^)]+)\)/;
+
+// Adapted from:
+// https://codemirror.net/try/?c=aW1wb3J0IHsgYmFzaWNTZXR1cCwgRWRpdG9yVmlldyB9IGZyb20gImNvZGVtaXJyb3IiCmltcG9ydCB7IG1hcmtkb3duIH0gZnJvbSAiQGNvZGVtaXJyb3IvbGFuZy1tYXJrZG93biIKaW1wb3J0IHsgc3ludGF4VHJlZSB9IGZyb20gIkBjb2RlbWlycm9yL2xhbmd1YWdlIjsKaW1wb3J0IHsgRWRpdG9yU3RhdGUsIFJhbmdlU2V0QnVpbGRlciwgU3RhdGVGaWVsZCB9IGZyb20gIkBjb2RlbWlycm9yL3N0YXRlIjsKaW1wb3J0IHsgRGVjb3JhdGlvbiwgV2lkZ2V0VHlwZSB9IGZyb20gIkBjb2RlbWlycm9yL3ZpZXciOwoKY2xhc3MgTGluayBleHRlbmRzIFdpZGdldFR5cGUgewogIGNvbnN0cnVjdG9yKHRleHQsIHVybCkgewogICAgc3VwZXIoKQogICAgdGhpcy50ZXh0ID0gdGV4dAogICAgdGhpcy51cmwgPSB1cmwKICB9CiAgZXEob3RoZXIpIHsgcmV0dXJuIHRoaXMudGV4dCA9PSBvdGhlci50ZXh0ICYmIHRoaXMudXJsID09IG90aGVyLnVybCB9CiAgdG9ET00oKSB7CiAgICBsZXQgbGluayA9IGRvY3VtZW50LmNyZWF0ZUVsZW1lbnQoImEiKQogICAgbGluay50ZXh0Q29udGVudCA9IHRoaXMudGV4dAogICAgbGluay5ocmVmID0gdGhpcy51cmwKICAgIHJldHVybiBsaW5rOwogIH0KfQoKbGV0IGRlY29yYXRpb25zRmllbGQgPSBTdGF0ZUZpZWxkLmRlZmluZSh7CiAgY3JlYXRlKCkgewogICAgcmV0dXJuIERlY29yYXRpb24ubm9uZTsKICB9LAogIHVwZGF0ZShfLCB0cikgewogICAgY29uc3QgYnVpbGRlciA9IG5ldyBSYW5nZVNldEJ1aWxkZXIoKTsKICAgIGxldCBjdXJzb3IgPSB0ci5zdGF0ZS5zZWxlY3Rpb24ubWFpbi5oZWFkOwogICAgc3ludGF4VHJlZSh0ci5zdGF0ZSkuaXRlcmF0ZSh7CiAgICAgIGVudGVyOiAobm9kZSkgPT4gewogICAgICAgIGlmICgoY3Vyc29yIDwgbm9kZS5mcm9tIHx8IGN1cnNvciA+IG5vZGUudG8pICYmIG5vZGUubmFtZSA9PSAiTGluayIpIHsKICAgICAgICAgIGxldCBtYXJrcyA9IG5vZGUubm9kZS5nZXRDaGlsZHJlbigiTGlua01hcmsiKTsKICAgICAgICAgIGxldCB0ZXh0ID0gbWFya3MubGVuZ3RoID49IDIgPyB0ci5zdGF0ZS5zbGljZURvYyhtYXJrc1swXS50bywgbWFya3NbMV0uZnJvbSkgOiAiIgoKICAgICAgICAgIGxldCB1cmxOb2RlID0gbm9kZS5ub2RlLmdldENoaWxkKCJVUkwiKTsKICAgICAgICAgIGxldCB1cmwgPSB1cmxOb2RlID8gdHIuc3RhdGUuc2xpY2VEb2ModXJsTm9kZS5mcm9tLCB1cmxOb2RlLnRvKSA6ICIiCiAgICAgICAgICBidWlsZGVyLmFkZChub2RlLmZyb20sIG5vZGUudG8sIERlY29yYXRpb24ucmVwbGFjZSh7CiAgICAgICAgICAgIHdpZGdldDogbmV3IExpbmsodGV4dCwgdXJsKSwKICAgICAgICAgIH0pLAogICAgICAgICAgICAgICAgICAgICApOwogICAgICAgICAgcmV0dXJuIGZhbHNlOwogICAgICAgIH0KICAgICAgICByZXR1cm4gdHJ1ZTsKICAgICAgfSwKICAgIH0pOwogICAgcmV0dXJuIGJ1aWxkZXIuZmluaXNoKCk7CiAgfSwKICBwcm92aWRlOiAoZikgPT4gRWRpdG9yVmlldy5kZWNvcmF0aW9ucy5mcm9tKGYpLAp9KTsKCmxldCB2aWV3ID0gbmV3IEVkaXRvclZpZXcoewogIGRvYzogIiMgSGVsbG8gV29ybGRcblxuW1Rlc3RdKGh0dHBzOi8vZXhhbXBsZS5jb20pXG5cblxuIiwKICBleHRlbnNpb25zOiBbZGVjb3JhdGlvbnNGaWVsZCwgbWFya2Rvd24oKV0sCiAgcGFyZW50OiBkb2N1bWVudC5ib2R5LAp9KTsKCnZpZXcuZm9jdXMoKTs=
+// https://discuss.codemirror.net/t/link-widget-is-clicked-only-if-editor-is-out-of-focus/7433
+
+export type LinkOptions = {
+  link?: boolean;
+  onHover?: (el: Element, url: string) => void;
+  onRender?: (el: Element, url: string) => void;
+};
+
+/**
+ * Creates a state field to replace AST elements with a hyperlink widget.
+ * https://codemirror.net/docs/ref/#state.StateField
+ */
+export const link = (options: LinkOptions = {}): Extension => {
+  const extensions: Extension[] = [
+    StateField.define<RangeSet<any>>({
+      create: (state) => update(state, options),
+      update: (_: RangeSet<any>, tr: Transaction) => update(tr.state, options),
+      provide: (field) => EditorView.decorations.from(field),
+    }),
+  ];
+
+  if (options.onHover) {
+    extensions.push(
+      // https://codemirror.net/examples/tooltip
+      // https://codemirror.net/docs/ref/#view.hoverTooltip
+      // https://github.com/codemirror/view/blob/main/src/tooltip.ts
+      hoverTooltip((view, pos) => {
+        const { from, text } = view.state.doc.lineAt(pos);
+        const p = pos - from;
+
+        let idx = 0;
+        let match;
+        do {
+          match = text.substring(idx).match(markdownLinkRegexp);
+          if (!match) {
+            match = undefined;
+            break;
+          }
+
+          idx = text.indexOf(match[0]);
+          if (p >= idx && p < idx + match[0].length) {
+            break;
+          }
+
+          idx += match[0].length;
+        } while (true);
+
+        if (!match) {
+          return null;
+        }
+
+        const [, , url] = match ?? [];
+
+        return {
+          pos: idx + from,
+          end: idx + from + match[0].length,
+          above: true,
+          create: () => {
+            const el = document.createElement('div');
+            el.className = tooltipContent({}, 'pli-2 plb-1');
+            options.onHover!(el, url);
+            return { dom: el, offset: { x: 0, y: 4 } };
+          },
+        };
+      }),
+    );
+  }
+
+  return extensions;
+};
+
+class LinkButton extends WidgetType {
+  constructor(
+    private readonly _pos: number,
+    private readonly _url: string,
+    private readonly _onAttach: LinkOptions['onRender'],
+  ) {
+    super();
+  }
+
+  override eq(other: LinkButton) {
+    return this._pos === other._pos && this._url === other._url;
+  }
+
+  toDOM(view: EditorView) {
+    const el = document.createElement('span');
+    this._onAttach!(el, this._url);
+    return el;
+  }
+}
+
+class LinkText extends WidgetType {
+  constructor(private readonly _text: string, private readonly _url?: string) {
+    super();
+  }
+
+  override eq(other: LinkText) {
+    return this._url === other._url;
+  }
+
+  toDOM(view: EditorView) {
+    const link = document.createElement('a');
+    link.setAttribute('class', 'cm-link');
+    link.textContent = this._text;
+    if (this._url) {
+      link.setAttribute('rel', 'noreferrer');
+      link.setAttribute('target', '_blank');
+      link.href = this._url;
+    } else {
+      link.onclick = () => {
+        view.dispatch({
+          selection: {
+            anchor: view.posAtDOM(link),
+          },
+        });
+      };
+    }
+
+    return link;
+  }
+}
+
+/**
+ * Range sets provide a data structure that can hold a collection of tagged,
+ * possibly overlapping ranges in such a way that they can efficiently be mapped though document changes.
+ * https://codemirror.net/docs/ref/#state
+ */
+const update = (state: EditorState, options: LinkOptions) => {
+  const builder = new RangeSetBuilder();
+  const cursor = state.selection.main.head;
+
+  syntaxTree(state).iterate({
+    enter: (node) => {
+      // Check if cursor is inside text.
+      if (node.name === 'Link') {
+        const marks = node.node.getChildren('LinkMark');
+        const text = marks.length >= 2 ? state.sliceDoc(marks[0].to, marks[1].from) : '';
+        const urlNode = node.node.getChild('URL');
+        const url = urlNode ? state.sliceDoc(urlNode.from, urlNode.to) : '';
+        if (!url) {
+          return false;
+        }
+
+        if (state.readOnly || cursor < node.from || cursor > node.to) {
+          builder.add(
+            node.from,
+            node.to,
+            Decoration.replace({
+              widget: new LinkText(text, options.link ? url : undefined),
+            }),
+          );
+        }
+
+        if (options.onRender) {
+          builder.add(
+            node.to,
+            node.to,
+            Decoration.replace({
+              widget: new LinkButton(node.from, url, options.onRender),
+            }),
+          );
+        }
+
+        return false;
+      }
+    },
+  });
+
+  return builder.finish();
+};

package/src/extensions/listener.ts

@@ -0,0 +1,35 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Extension } from '@codemirror/state';
+import { EditorView } from '@codemirror/view';
+
+export type ListenerOptions = {
+  onFocus?: (focused: boolean) => void;
+  onChange?: (text: string) => void;
+};
+
+/**
+ * Event listener.
+ */
+export const listener = ({ onFocus, onChange }: ListenerOptions): Extension => {
+  const extensions: Extension[] = [];
+
+  onFocus &&
+    extensions.push(
+      EditorView.focusChangeEffect.of((_, focused) => {
+        onFocus(focused);
+        return null;
+      }),
+    );
+
+  onChange &&
+    extensions.push(
+      EditorView.updateListener.of((update) => {
+        onChange(update.state.doc.toString());
+      }),
+    );
+
+  return extensions;
+};

package/src/extensions/markdown/bundle.ts

@@ -0,0 +1,106 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { closeBrackets, closeBracketsKeymap } from '@codemirror/autocomplete';
+import { history, historyKeymap, indentWithTab, standardKeymap } from '@codemirror/commands';
+import { markdownLanguage, markdown } from '@codemirror/lang-markdown';
+import { bracketMatching, defaultHighlightStyle, indentOnInput, syntaxHighlighting } from '@codemirror/language';
+import { languages } from '@codemirror/language-data';
+import { searchKeymap } from '@codemirror/search';
+import { EditorState, type Extension } from '@codemirror/state';
+import { oneDarkHighlightStyle } from '@codemirror/theme-one-dark';
+import {
+  crosshairCursor,
+  drawSelection,
+  dropCursor,
+  EditorView,
+  highlightActiveLine,
+  keymap,
+  placeholder,
+} from '@codemirror/view';
+
+import type { ThemeMode } from '@dxos/react-ui';
+
+import { markdownHighlightStyle, markdownTagsExtensions } from './highlight';
+
+export type MarkdownBundleOptions = {
+  readonly?: boolean;
+  themeMode?: ThemeMode;
+  placeholder?: string;
+};
+
+/**
+ * Markdown bundle.
+ * Refs:
+ * https://github.com/codemirror/basic-setup
+ * https://github.com/codemirror/basic-setup/blob/main/src/codemirror.ts#L50
+ * https://codemirror.net/docs/community
+ * https://codemirror.net/docs/ref/#codemirror.basicSetup
+ */
+// TODO(burdon): Add Composer here: https://codemirror.net/docs/community
+export const markdownBundle = ({
+  readonly,
+  themeMode,
+  placeholder: _placeholder,
+}: MarkdownBundleOptions): Extension[] => {
+  return [
+    EditorState.allowMultipleSelections.of(true),
+    EditorState.tabSize.of(2),
+    EditorView.lineWrapping,
+
+    customKeymap(),
+
+    bracketMatching(),
+    closeBrackets(),
+    crosshairCursor(),
+    dropCursor(),
+    drawSelection(),
+    highlightActiveLine(),
+    history(),
+    indentOnInput(),
+    _placeholder && placeholder(_placeholder),
+
+    // Main extension.
+    // https://github.com/codemirror/lang-markdown
+    // https://codemirror.net/5/mode/markdown/index.html (demo).
+    markdown({
+      // GRM by default (vs strict CommonMark):
+      // Table, TaskList, Strikethrough, and Autolink.
+      // NOTE: This extends the parser; it doesn't affect rendering.
+      // https://github.github.com/gfm
+      // https://github.com/lezer-parser/markdown?tab=readme-ov-file#github-flavored-markdown
+      base: markdownLanguage,
+
+      // Languages for syntax highlighting fenced code blocks.
+      codeLanguages: languages,
+
+      // Parser extensions.
+      extensions: [
+        // GFM provided by default.
+        markdownTagsExtensions,
+      ],
+    }),
+
+    // https://github.com/codemirror/theme-one-dark
+    themeMode === 'dark' ? syntaxHighlighting(oneDarkHighlightStyle) : syntaxHighlighting(defaultHighlightStyle),
+
+    // Custom styles.
+    syntaxHighlighting(markdownHighlightStyle(readonly)),
+  ].filter(Boolean) as Extension[];
+};
+
+// https://codemirror.net/docs/ref/#view.keymap
+const customKeymap = () =>
+  keymap.of([
+    // https://codemirror.net/docs/ref/#commands.indentWithTab
+    indentWithTab,
+    // https://codemirror.net/docs/ref/#commands.standardKeymap
+    ...standardKeymap,
+    // https://codemirror.net/docs/ref/#commands.historyKeymap
+    ...historyKeymap,
+    // https://codemirror.net/docs/ref/#autocomplete.closeBracketsKeymap
+    ...closeBracketsKeymap,
+    // https://codemirror.net/docs/ref/#search.searchKeymap
+    ...searchKeymap,
+  ]);

package/src/extensions/markdown/highlight.ts

@@ -0,0 +1,204 @@
+//
+// 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 {
+  blockquote,
+  bold,
+  code,
+  codeMark,
+  heading,
+  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 → extensions}/markdown/index.ts

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

package/src/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/extensions/mermaid.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type Extension } from '@codemirror/state';
+
+// TODO(burdon): How will this interact with the code extension?
+// TODO(burdon): Move to mermaid-plugin (which should contribute this extension).
+export const mermaid = (): Extension => {
+  return [];
+};