@dxos/react-ui-editor 0.3.9 → 0.3.10-main.04816d3

package/src/components/TextEditor/extensions/{hyperlink/hyperlinkDecoration.ts → link.ts}

@@ -4,7 +4,14 @@
 //
 
 import { syntaxTree } from '@codemirror/language';
-import { type EditorState, type RangeSet, RangeSetBuilder, StateField, type Transaction } from '@codemirror/state';
+import {
+  type EditorState,
+  type Extension,
+  type RangeSet,
+  RangeSetBuilder,
+  StateField,
+  type Transaction,
+} from '@codemirror/state';
 import { Decoration, EditorView, WidgetType } from '@codemirror/view';
 
 // Adapted from:
@@ -19,13 +26,33 @@ import { Decoration, EditorView, WidgetType } from '@codemirror/view';
 //  https://codemirror.net/5/demo/simplemode.html
 //  https://codemirror.net/5/demo/search.html (Search dialog).
 
-class Link extends WidgetType {
-  constructor(private readonly _anchor: number, private readonly _text: string, private readonly _url?: string) {
+class LinkButton extends WidgetType {
+  constructor(
+    private readonly _pos: number,
+    private readonly _url: string,
+    private readonly _onAttach: LinkOptions['onRender'],
+  ) {
     super();
   }
 
-  override eq(other: any) {
-    return this._text === other.text && this._url === other.url;
+  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 _pos: number, private readonly _text: string, private readonly _url?: string) {
+    super();
+  }
+
+  override eq(other: LinkText) {
+    return this._pos === other._pos && this._url === other._url;
   }
 
   toDOM(view: EditorView) {
@@ -33,13 +60,14 @@ class Link extends WidgetType {
     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: this._anchor,
+            anchor: this._pos,
           },
         });
       };
@@ -49,51 +77,68 @@ class Link extends WidgetType {
   }
 }
 
-type HyperlinkDecorationConfig = {
-  link?: boolean;
-};
-
 /**
- * Creates a state field to replace AST elements with a hyperlink widget.
- * https://codemirror.net/docs/ref/#state.StateField
+ * 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
  */
-export const hyperlinkDecoration = ({ link }: HyperlinkDecorationConfig = {}) => {
-  return StateField.define<RangeSet<any>>({
-    create: (state) => update(state, link),
-    update: (_: RangeSet<any>, tr: Transaction) => update(tr.state, link),
-    provide: (field) => EditorView.decorations.from(field),
-  });
-};
-
-const update = (state: EditorState, link?: boolean) => {
+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 (cursor < node.from || cursor > node.to) {
-        if (node.name === 'Link') {
-          const marks = node.node.getChildren('LinkMark');
-          const text = marks.length >= 2 ? state.sliceDoc(marks[0].to, marks[1].from) : '';
+      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) : '';
+        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) {
           builder.add(
             node.from,
             node.to,
             Decoration.replace({
-              widget: new Link(node.from, text, link ? url : undefined),
+              widget: new LinkText(node.from, text, options.link ? url : undefined),
             }),
           );
+        }
 
-          return false;
+        if (options.onRender) {
+          builder.add(
+            node.to,
+            node.to,
+            Decoration.replace({
+              widget: new LinkButton(node.from, url, options.onRender),
+            }),
+          );
         }
-      }
 
-      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/{change.ts → listener.ts}

@@ -4,12 +4,13 @@
 
 import { StateField } from '@codemirror/state';
 
+export type ListenerOptions = { onChange: (text: string) => void };
+
 /**
  * Based on https://github.com/codemirror/dev/issues/44#issuecomment-789093799
- * @param onChange
  */
-// TODO(burdon): Name?
-export const onChangeExtension = (onChange: (text: string) => void) =>
+// TODO(burdon): Expose options.
+export const listener = ({ onChange }: ListenerOptions) =>
   StateField.define({
     create: () => null,
     update: (_value, transaction) => {

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

@@ -3,17 +3,10 @@
 //
 
 import { closeBrackets, closeBracketsKeymap } from '@codemirror/autocomplete';
-import { defaultKeymap, history, historyKeymap, indentWithTab } from '@codemirror/commands';
+import { defaultKeymap, history, indentWithTab } 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 { EditorState, type Extension } from '@codemirror/state';
 import { oneDarkHighlightStyle } from '@codemirror/theme-one-dark';
@@ -29,12 +22,10 @@ import {
   placeholder,
   rectangularSelection,
 } from '@codemirror/view';
-// import { GFM } from '@lezer/markdown';
 
 import type { ThemeMode } from '@dxos/react-ui';
 
-import { markdownTagsExtension } from './tags';
-import { markdownHighlightStyle } from './theme';
+import { markdownHighlightStyle, markdownTagsExtension } from './highlight';
 
 export type MarkdownBundleOptions = {
   themeMode?: ThemeMode;
@@ -52,7 +43,6 @@ export const markdownBundle = ({ themeMode, placeholder: _placeholder }: Markdow
     EditorState.allowMultipleSelections.of(true),
     EditorView.lineWrapping,
 
-    // autocompletion(),
     crosshairCursor(),
     dropCursor(),
     drawSelection(),
@@ -64,36 +54,42 @@ export const markdownBundle = ({ themeMode, placeholder: _placeholder }: Markdow
     indentOnInput(),
     rectangularSelection(),
 
+    // TODO(burdon): Review.
     keymap.of([
       ...closeBracketsKeymap,
-      // ...completionKeymap,
       ...defaultKeymap,
-      ...foldKeymap,
-      ...historyKeymap,
-      ...lintKeymap,
+      // ...foldKeymap,
+      // ...historyKeymap,
+      // ...lintKeymap,
       ...searchKeymap,
       indentWithTab,
     ]),
 
     // 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,
-      extensions: [
-        // TODO(burdon): This seems to upgrade the parser.
-        // GitHub flavored markdown bundle: Table, TaskList, Strikethrough, and Autolink.
-        // https://github.com/lezer-parser/markdown?tab=readme-ov-file#github-flavored-markdown
-        // https://github.github.com/gfm
-        // GFM,
 
-        // Custom styling.
+      // Parser extensions.
+      extensions: [
+        // GFM, // TODO(burdon): Provided by default?
         markdownTagsExtension,
       ],
     }),
 
-    // TODO(thure): All but one rule here apply to both themes; rename or refactor.
+    // Custom styles.
     syntaxHighlighting(markdownHighlightStyle),
+
+    // TODO(thure): All but one rule here apply to both themes; rename or refactor.
     themeMode === 'dark' ? syntaxHighlighting(oneDarkHighlightStyle) : syntaxHighlighting(defaultHighlightStyle),
   ].filter(Boolean) as Extension[];
 };

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

@@ -0,0 +1,167 @@
+//
+// 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 } from '@lezer/markdown';
+import get from 'lodash.get';
+
+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(),
+};
+
+export const markdownTagsExtension: MarkdownConfig = {
+  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)
+ */
+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',
+    },
+
+    // Markdown marks.
+    {
+      tag: [
+        tags.meta,
+        tags.processingInstruction,
+        markdownTags.CodeMark,
+        markdownTags.EmphasisMark,
+        markdownTags.HeaderMark,
+        markdownTags.LinkLabel,
+        markdownTags.LinkReference,
+        markdownTags.ListMark,
+        markdownTags.QuoteMark,
+      ],
+      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] },
+
+    // Emphasis.
+    { tag: tags.emphasis, class: italic },
+    { tag: tags.strong, class: bold },
+    { tag: tags.strikethrough, class: strikethrough },
+
+    // Naked URLs.
+    {
+      tag: [markdownTags.URL],
+      class: inlineUrl,
+    },
+
+    // E.g., code block language (after ```).
+    {
+      tag: [tags.function(tags.variableName), tags.labelName],
+      class: codeMark,
+    },
+
+    // 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,
+    },
+
+    {
+      tag: [markdownTags.HorizontalRule],
+      class: horizontalRule,
+    },
+
+    // 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/tasklist.ts

@@ -0,0 +1,107 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import {
+  EditorView,
+  Decoration,
+  WidgetType,
+  MatchDecorator,
+  ViewPlugin,
+  type DecorationSet,
+  type ViewUpdate,
+} from '@codemirror/view';
+
+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;
+    input.onchange = (event: Event) => {
+      this._onCheck((event.target as any).checked);
+      return true;
+    };
+
+    return wrap;
+  }
+
+  override ignoreEvent() {
+    return false;
+  }
+}
+
+// TODO(burdon): Reconcile with theme.
+const styles = EditorView.baseTheme({
+  '& .cm-task-item': {
+    paddingLeft: '4px',
+    paddingRight: '8px',
+  },
+});
+
+export const tasklist = () => {
+  // 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, (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: (instance) => instance.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';