@dxos/react-ui-editor 0.3.10-main.3645708 → 0.3.10-main.396fa89

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

@@ -18,13 +18,22 @@ import { Decoration, EditorView, WidgetType } from '@codemirror/view';
 // https://codemirror.net/try/?c=aW1wb3J0IHsgYmFzaWNTZXR1cCwgRWRpdG9yVmlldyB9IGZyb20gImNvZGVtaXJyb3IiCmltcG9ydCB7IG1hcmtkb3duIH0gZnJvbSAiQGNvZGVtaXJyb3IvbGFuZy1tYXJrZG93biIKaW1wb3J0IHsgc3ludGF4VHJlZSB9IGZyb20gIkBjb2RlbWlycm9yL2xhbmd1YWdlIjsKaW1wb3J0IHsgRWRpdG9yU3RhdGUsIFJhbmdlU2V0QnVpbGRlciwgU3RhdGVGaWVsZCB9IGZyb20gIkBjb2RlbWlycm9yL3N0YXRlIjsKaW1wb3J0IHsgRGVjb3JhdGlvbiwgV2lkZ2V0VHlwZSB9IGZyb20gIkBjb2RlbWlycm9yL3ZpZXciOwoKY2xhc3MgTGluayBleHRlbmRzIFdpZGdldFR5cGUgewogIGNvbnN0cnVjdG9yKHRleHQsIHVybCkgewogICAgc3VwZXIoKQogICAgdGhpcy50ZXh0ID0gdGV4dAogICAgdGhpcy51cmwgPSB1cmwKICB9CiAgZXEob3RoZXIpIHsgcmV0dXJuIHRoaXMudGV4dCA9PSBvdGhlci50ZXh0ICYmIHRoaXMudXJsID09IG90aGVyLnVybCB9CiAgdG9ET00oKSB7CiAgICBsZXQgbGluayA9IGRvY3VtZW50LmNyZWF0ZUVsZW1lbnQoImEiKQogICAgbGluay50ZXh0Q29udGVudCA9IHRoaXMudGV4dAogICAgbGluay5ocmVmID0gdGhpcy51cmwKICAgIHJldHVybiBsaW5rOwogIH0KfQoKbGV0IGRlY29yYXRpb25zRmllbGQgPSBTdGF0ZUZpZWxkLmRlZmluZSh7CiAgY3JlYXRlKCkgewogICAgcmV0dXJuIERlY29yYXRpb24ubm9uZTsKICB9LAogIHVwZGF0ZShfLCB0cikgewogICAgY29uc3QgYnVpbGRlciA9IG5ldyBSYW5nZVNldEJ1aWxkZXIoKTsKICAgIGxldCBjdXJzb3IgPSB0ci5zdGF0ZS5zZWxlY3Rpb24ubWFpbi5oZWFkOwogICAgc3ludGF4VHJlZSh0ci5zdGF0ZSkuaXRlcmF0ZSh7CiAgICAgIGVudGVyOiAobm9kZSkgPT4gewogICAgICAgIGlmICgoY3Vyc29yIDwgbm9kZS5mcm9tIHx8IGN1cnNvciA+IG5vZGUudG8pICYmIG5vZGUubmFtZSA9PSAiTGluayIpIHsKICAgICAgICAgIGxldCBtYXJrcyA9IG5vZGUubm9kZS5nZXRDaGlsZHJlbigiTGlua01hcmsiKTsKICAgICAgICAgIGxldCB0ZXh0ID0gbWFya3MubGVuZ3RoID49IDIgPyB0ci5zdGF0ZS5zbGljZURvYyhtYXJrc1swXS50bywgbWFya3NbMV0uZnJvbSkgOiAiIgoKICAgICAgICAgIGxldCB1cmxOb2RlID0gbm9kZS5ub2RlLmdldENoaWxkKCJVUkwiKTsKICAgICAgICAgIGxldCB1cmwgPSB1cmxOb2RlID8gdHIuc3RhdGUuc2xpY2VEb2ModXJsTm9kZS5mcm9tLCB1cmxOb2RlLnRvKSA6ICIiCiAgICAgICAgICBidWlsZGVyLmFkZChub2RlLmZyb20sIG5vZGUudG8sIERlY29yYXRpb24ucmVwbGFjZSh7CiAgICAgICAgICAgIHdpZGdldDogbmV3IExpbmsodGV4dCwgdXJsKSwKICAgICAgICAgIH0pLAogICAgICAgICAgICAgICAgICAgICApOwogICAgICAgICAgcmV0dXJuIGZhbHNlOwogICAgICAgIH0KICAgICAgICByZXR1cm4gdHJ1ZTsKICAgICAgfSwKICAgIH0pOwogICAgcmV0dXJuIGJ1aWxkZXIuZmluaXNoKCk7CiAgfSwKICBwcm92aWRlOiAoZikgPT4gRWRpdG9yVmlldy5kZWNvcmF0aW9ucy5mcm9tKGYpLAp9KTsKCmxldCB2aWV3ID0gbmV3IEVkaXRvclZpZXcoewogIGRvYzogIiMgSGVsbG8gV29ybGRcblxuW1Rlc3RdKGh0dHBzOi8vZXhhbXBsZS5jb20pXG5cblxuIiwKICBleHRlbnNpb25zOiBbZGVjb3JhdGlvbnNGaWVsZCwgbWFya2Rvd24oKV0sCiAgcGFyZW50OiBkb2N1bWVudC5ib2R5LAp9KTsKCnZpZXcuZm9jdXMoKTs=
 // https://discuss.codemirror.net/t/link-widget-is-clicked-only-if-editor-is-out-of-focus/7433
 
-// TODO(burdon): Adapt to make all markdown editable?
+export type LinkOptions = {
+  link?: boolean;
+  onRender?: (el: Element, url: string) => void;
+};
 
-// TODO(burdon): Research overlays.
-//  https://stackoverflow.com/questions/26933344/codemirror-detect-and-create-links-inside-editor
-//  https://codemirror.net/5/doc/manual.html#addOverlay
-//  https://codemirror.net/5/demo/simplemode.html
-//  https://codemirror.net/5/demo/search.html (Search dialog).
+/**
+ * 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 => {
+  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),
+  });
+};
 
 class LinkButton extends WidgetType {
   constructor(
@@ -77,20 +86,28 @@ class LinkText extends WidgetType {
   }
 }
 
+/**
+ * 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 (cursor < node.from || cursor > node.to) {
+        if (state.readOnly || cursor < node.from || cursor > node.to) {
           builder.add(
             node.from,
             node.to,
@@ -109,28 +126,11 @@ const update = (state: EditorState, options: LinkOptions) => {
             }),
           );
         }
-      }
 
-      return true;
+        return false;
+      }
     },
   });
 
   return builder.finish();
 };
-
-export type LinkOptions = {
-  link?: boolean;
-  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 => {
-  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),
-  });
-};

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

@@ -4,13 +4,13 @@
 
 import { StateField } from '@codemirror/state';
 
-export type TextListener = (text: string) => void;
+export type ListenerOptions = { onChange: (text: string) => void };
 
 /**
  * Based on https://github.com/codemirror/dev/issues/44#issuecomment-789093799
  */
-export const listener = (onChange: TextListener) =>
-  StateField.define({
+export const listener = ({ onChange }: ListenerOptions) => {
+  return StateField.define({
     create: () => null,
     update: (_value, transaction) => {
       if (transaction.docChanged && onChange) {
@@ -20,3 +20,4 @@ export const listener = (onChange: TextListener) =>
       return null;
     },
   });
+};

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

@@ -3,18 +3,11 @@
 //
 
 import { closeBrackets, closeBracketsKeymap } from '@codemirror/autocomplete';
-import { defaultKeymap, history, historyKeymap, indentWithTab } from '@codemirror/commands';
+import { history, historyKeymap, indentWithTab, standardKeymap } from '@codemirror/commands';
 import { markdownLanguage, markdown } from '@codemirror/lang-markdown';
-import {
-  bracketMatching,
-  defaultHighlightStyle,
-  foldKeymap,
-  indentOnInput,
-  syntaxHighlighting,
-} from '@codemirror/language';
+import { bracketMatching, defaultHighlightStyle, indentOnInput, syntaxHighlighting } from '@codemirror/language';
 import { languages } from '@codemirror/language-data';
-import { lintKeymap } from '@codemirror/lint';
-import { highlightSelectionMatches, searchKeymap } from '@codemirror/search';
+import { searchKeymap } from '@codemirror/search';
 import { EditorState, type Extension } from '@codemirror/state';
 import { oneDarkHighlightStyle } from '@codemirror/theme-one-dark';
 import {
@@ -23,55 +16,50 @@ import {
   dropCursor,
   EditorView,
   highlightActiveLine,
-  highlightActiveLineGutter,
-  highlightSpecialChars,
   keymap,
   placeholder,
-  rectangularSelection,
 } from '@codemirror/view';
 
 import type { ThemeMode } from '@dxos/react-ui';
 
-import { markdownHighlightStyle, markdownTagsExtension } from './highlight';
+import { markdownHighlightStyle, markdownTagsExtensions } from './highlight';
 
 export type MarkdownBundleOptions = {
+  readonly?: boolean;
   themeMode?: ThemeMode;
   placeholder?: string;
 };
 
-export const markdownBundle = ({ themeMode, placeholder: _placeholder }: MarkdownBundleOptions): Extension[] => {
-  // All of https://github.com/codemirror/basic-setup minus line numbers and fold gutter.
-  // https://codemirror.net/docs/ref/#codemirror.basicSetup
+/**
+ * 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 [
-    bracketMatching(),
-    closeBrackets(),
-    _placeholder && placeholder(_placeholder),
-
     EditorState.allowMultipleSelections.of(true),
+    EditorState.tabSize.of(2),
     EditorView.lineWrapping,
 
-    // autocompletion(),
+    customKeymap(),
+
+    bracketMatching(),
+    closeBrackets(),
     crosshairCursor(),
     dropCursor(),
     drawSelection(),
     highlightActiveLine(),
-    highlightActiveLineGutter(),
-    highlightSelectionMatches(),
-    highlightSpecialChars(),
     history(),
     indentOnInput(),
-    rectangularSelection(),
-
-    keymap.of([
-      ...closeBracketsKeymap,
-      // ...completionKeymap,
-      ...defaultKeymap,
-      ...foldKeymap,
-      ...historyKeymap,
-      ...lintKeymap,
-      ...searchKeymap,
-      indentWithTab,
-    ]),
+    _placeholder && placeholder(_placeholder),
 
     // Main extension.
     // https://github.com/codemirror/lang-markdown
@@ -89,15 +77,30 @@ export const markdownBundle = ({ themeMode, placeholder: _placeholder }: Markdow
 
       // Parser extensions.
       extensions: [
-        // GFM, // TODO(burdon): Provided by default?
-        markdownTagsExtension,
+        // GFM provided by default.
+        markdownTagsExtensions,
       ],
     }),
 
-    // Custom styles.
-    syntaxHighlighting(markdownHighlightStyle),
-
-    // TODO(thure): All but one rule here apply to both themes; rename or refactor.
+    // 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/components/TextEditor/extensions/markdown/highlight.ts

@@ -5,9 +5,11 @@
 import { markdownLanguage } from '@codemirror/lang-markdown';
 import { HighlightStyle } from '@codemirror/language';
 import { tags, styleTags, Tag } from '@lezer/highlight';
-import { type MarkdownConfig } from '@lezer/markdown';
+import { type MarkdownConfig, Table } from '@lezer/markdown';
 import get from 'lodash.get';
 
+import { mx } from '@dxos/react-ui-theme';
+
 import {
   blockquote,
   bold,
@@ -40,127 +42,166 @@ export const markdownTags = {
   ListMark: Tag.define(),
   QuoteMark: Tag.define(),
   URL: Tag.define(),
-};
 
-export const markdownTagsExtension: MarkdownConfig = {
-  props: [styleTags(markdownTags)],
+  // 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://lezer.codemirror.net/docs/ref/#highlight (list of tags)
+ * 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 = 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',
-    },
+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.CodeMark,
-        markdownTags.EmphasisMark,
-        markdownTags.HeaderMark,
-        markdownTags.LinkLabel,
-        markdownTags.LinkReference,
-        markdownTags.ListMark,
-        markdownTags.QuoteMark,
-      ],
-      class: mark,
-    },
+      // Markdown marks.
+      {
+        tag: [
+          tags.meta,
+          tags.processingInstruction,
+          markdownTags.LinkLabel,
+          markdownTags.LinkReference,
+          markdownTags.ListMark,
+        ],
+        class: mark,
+      },
 
-    // Headings.
-    { tag: tags.heading1, class: heading[1] },
-    { tag: tags.heading2, class: heading[2] },
-    { tag: tags.heading3, class: heading[3] },
-    { tag: tags.heading4, class: heading[4] },
-    { tag: tags.heading5, class: heading[5] },
-    { tag: tags.heading6, class: heading[6] },
+      // Markdown marks.
+      {
+        tag: [markdownTags.CodeMark, markdownTags.HeaderMark, markdownTags.QuoteMark, markdownTags.EmphasisMark],
+        class: readonly ? 'hidden' : mark,
+      },
 
-    // Emphasis.
-    { tag: tags.emphasis, class: italic },
-    { tag: tags.strong, class: bold },
-    { tag: tags.strikethrough, class: strikethrough },
+      // E.g., code block language (after ```).
+      {
+        tag: [tags.function(tags.variableName), tags.labelName],
+        class: readonly ? 'hidden' : codeMark,
+      },
 
-    // Naked URLs.
-    {
-      tag: [markdownTags.URL],
-      class: inlineUrl,
-    },
+      {
+        tag: [tags.monospace],
+        class: 'font-mono',
+      },
 
-    // E.g., code block language (after ```).
-    {
-      tag: [tags.function(tags.variableName), tags.labelName],
-      class: codeMark,
-    },
+      // 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) },
 
-    // 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.
-    {
-      tag: [markdownTags.CodeText, markdownTags.InlineCode],
-      class: code,
-    },
+      // Emphasis.
+      { tag: tags.emphasis, class: italic },
+      { tag: tags.strong, class: bold },
+      { tag: tags.strikethrough, class: strikethrough },
 
-    {
-      tag: [markdownTags.QuoteMark],
-      class: blockquote,
-    },
+      // 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(','),
+      // },
+    ],
     {
-      tag: [markdownTags.HorizontalRule],
-      class: horizontalRule,
+      scope: markdownLanguage,
+      all: { fontFamily: get(tokens, 'fontFamily.body', []).join(',') },
     },
-
-    // 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/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}` })),
+        };
+      },
+    ],
+  });
+};