@dxos/react-ui-editor 0.3.9 → 0.3.10-main.3c0616c

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

@@ -0,0 +1,72 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+// TODO(burdon): Automcomplete: https://codemirror.net/5/doc/manual.html#addon_runmode
+// TODO(burdon): Modes: parallel parsing and decoration (e.g., associated with language).
+// TODO(burdon): Add-on: runmode: run lexer over content (with rendering codemirror).
+//  https://codemirror.net/5/doc/manual.html#addon_runmode
+// TODO(burdon): Add-on: dialog.
+// TODO(burdon): Comments: https://codemirror.net/5/doc/manual.html#setBookmark
+// TODO(burdon): Split view: https://codemirror.net/examples/split
+
+// https://codemirror.net/examples/autocompletion
+// https://codemirror.net/docs/ref/#autocomplete.autocompletion
+// https://codemirror.net/docs/ref/#autocomplete.Completion
+
+import {
+  autocompletion,
+  type Completion,
+  type CompletionContext,
+  completionKeymap,
+  type CompletionResult,
+} from '@codemirror/autocomplete';
+import { keymap } from '@codemirror/view';
+
+export type AutocompleteOptions = {
+  getOptions: (text: string) => Completion[];
+};
+
+/**
+ * Autocomplete extension.
+ */
+export const autocomplete = ({ getOptions }: AutocompleteOptions) => {
+  return [
+    // https://codemirror.net/docs/ref/#view.keymap
+    // https://discuss.codemirror.net/t/how-can-i-replace-the-default-autocompletion-keymap-v6/3322
+    keymap.of(completionKeymap),
+
+    // https://codemirror.net/examples/autocompletion
+    // https://codemirror.net/docs/ref/#autocomplete.autocompletion
+    autocompletion({
+      // TODO(burdon): Set custom keymap.
+      // defaultKeymap: false,
+
+      // Don't start unless key press.
+      activateOnTyping: false,
+
+      // TODO(burdon): Option to create new page?
+      // TODO(burdon): Optional decoration via addToOptions
+      override: [
+        (context: CompletionContext): CompletionResult | null => {
+          const word = context.matchBefore(/\w*/);
+          if (!word || (word.from === word.to && !context.explicit)) {
+            return null;
+          }
+
+          // TODO(burdon): Option to convert to links?
+          return {
+            from: word.from,
+            options: getOptions(word.text.toLowerCase()),
+            // options: [
+            //   { label: 'apple', type: 'keyword' },
+            //   { label: 'amazon', type: 'keyword' },
+            //   { label: 'hello', type: 'variable', info: '(World)' },
+            //   { label: 'magic', type: 'text', apply: '⠁⭒*.✩.*⭒⠁', detail: 'macro' },
+            // ],
+          };
+        },
+      ],
+    }),
+  ];
+};

package/src/components/TextEditor/extensions/{basic/bundle.ts → basic.ts}

@@ -17,12 +17,14 @@ export type BasicBundleOptions = {
 
 export const basicBundle = ({ themeMode, placeholder: _placeholder }: BasicBundleOptions): Extension[] =>
   [
+    // TODO(burdon): Compare with minimalSetup.
+    // https://codemirror.net/docs/ref/#codemirror.minimalSetup
     bracketMatching(),
     closeBrackets(),
-    _placeholder && placeholder(_placeholder),
-
     EditorView.lineWrapping,
 
+    _placeholder && placeholder(_placeholder),
+
     // TODO(burdon): Is this required?
     themeMode === 'dark' ? syntaxHighlighting(oneDarkHighlightStyle) : syntaxHighlighting(defaultHighlightStyle),
   ].filter(Boolean) as Extension[];

package/src/components/TextEditor/extensions/{hyperlink/hyperlinkWidget.tsx → experimental.tsx}

@@ -13,12 +13,27 @@ import {
   type ViewUpdate,
 } from '@codemirror/view';
 
+// TODO(burdon): Modes: parallel parsing and decoration (e.g., associated with language).
+// TODO(burdon): Add-on: runmode: run lexer over content (with rendering codemirror).
+//  https://codemirror.net/5/doc/manual.html#addon_runmode
+// TODO(burdon): Add-on: dialog.
+// TODO(burdon): Comments: https://codemirror.net/5/doc/manual.html#setBookmark
+// TODO(burdon): Split view: https://codemirror.net/examples/split
+
+// https://codemirror.net/examples/autocompletion
+// https://codemirror.net/docs/ref/#autocomplete.autocompletion
+// https://codemirror.net/docs/ref/#autocomplete.Completion
+
+// TODO(burdon): Hint to customize?
+// https://codemirror.net/examples/autocompletion
+
 // Notes: Can't edit widget content (or cursor nav through them).
 // - https://discuss.codemirror.net/t/focusing-inputs-within-widgets/5178/7
 //   Widgets intentionally always get set to contenteditable=false,
 //   or they would become part of CodeMirror’s editable content element.
 //   You should be able to introduce new contenteditable=true child elements inside of them.
 
+// TODO(burdon): URL match?
 const markdownLinkRegexp = /\[([^\]]+)]\(([^)]+)\)(!?)/gi;
 
 /**
@@ -102,7 +117,7 @@ export function hyperLinkExtension() {
   );
 }
 
-export const hyperlinkStyle = EditorView.baseTheme({
+export const styles = EditorView.baseTheme({
   '.cm-hyperlink-label': {
     cursor: 'pointer',
     textDecoration: 'underline',
@@ -116,4 +131,4 @@ export const hyperlinkStyle = EditorView.baseTheme({
   },
 });
 
-export const hyperlinkWidget: Extension = [hyperLinkExtension(), hyperlinkStyle];
+export const hyperlinkWidget: Extension = [hyperLinkExtension(), styles];

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

@@ -2,7 +2,10 @@
 // Copyright 2023 DXOS.org
 //
 
+export * from './autocomplete';
 export * from './basic';
-export * from './change';
-export * from './hyperlink';
+export * from './link';
+export * from './listener';
 export * from './markdown';
+export * from './tasklist';
+export * from './tooltip';

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,45 +77,37 @@ 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
- */
-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 (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),
+            }),
+          );
         }
       }
 
@@ -97,3 +117,20 @@ const update = (state: EditorState, link?: boolean) => {
 
   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,12 @@
 
 import { StateField } from '@codemirror/state';
 
+export type TextListener = (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) =>
+export const listener = (onChange: TextListener) =>
   StateField.define({
     create: () => null,
     update: (_value, transaction) => {

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

@@ -29,12 +29,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;
@@ -77,23 +75,29 @@ export const markdownBundle = ({ themeMode, placeholder: _placeholder }: Markdow
 
     // 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,166 @@
+//
+// 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,
+    },
+
+    // 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,
+    },
+
+    {
+      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,113 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { syntaxTree } from '@codemirror/language';
+import {
+  type EditorState,
+  type Extension,
+  type RangeSet,
+  RangeSetBuilder,
+  StateField,
+  type Transaction,
+} from '@codemirror/state';
+import { EditorView, Decoration, WidgetType } from '@codemirror/view';
+
+class CheckboxWidget extends WidgetType {
+  constructor(private readonly _pos: number, private readonly _getCursor: () => number, private _checked: boolean) {
+    super();
+  }
+
+  override eq(other: CheckboxWidget) {
+    // Uniqueness based on position; also checks state.
+    // TODO(burdon): Is this efficient? Check life-cycle.
+    return this._pos === other._pos && this._checked === other._checked;
+  }
+
+  toDOM(view: EditorView) {
+    // console.log('toDom', this._pos);
+    const wrap = document.createElement('span');
+    wrap.setAttribute('aria-hidden', 'true');
+    wrap.className = 'cm-task-item';
+
+    const box = wrap.appendChild(document.createElement('input'));
+    box.type = 'checkbox';
+    box.checked = this._checked;
+    box.onclick = (event) => {
+      this._checked = !isChecked(view.state, this._pos);
+      view.dispatch({
+        changes: {
+          from: this._pos + 1,
+          to: this._pos + 2,
+          insert: this._checked ? 'x' : ' ',
+        },
+        // TODO(burdon): Restore cursor position? More useful to move to end of line (can indent).
+        selection: {
+          anchor: this._pos + 4,
+          // anchor: this._getCursor(),
+        },
+      });
+      return true;
+    };
+
+    return wrap;
+  }
+
+  // TODO(burdon): Remove listener?
+  // override destroy() {
+  // console.log('destroy', this._pos);
+  // }
+
+  override ignoreEvent() {
+    return false;
+  }
+}
+
+const isChecked = (state: EditorState, pos: number) => {
+  return state.sliceDoc(pos, pos + 3).toLowerCase() === '[x]';
+};
+
+export const statefield = (): Extension => {
+  let lastPosition: number = 0;
+  const listener = EditorView.updateListener.of((update) => {
+    lastPosition = update.startState.selection.main.head;
+  });
+
+  const checkbox = (state: EditorState) => {
+    const builder = new RangeSetBuilder();
+    syntaxTree(state).iterate({
+      enter: (node) => {
+        // console.log(node.name, node.from, node.to);
+        if (node.name === 'TaskMarker') {
+          builder.add(
+            node.from,
+            node.to,
+            Decoration.replace({
+              widget: new CheckboxWidget(node.from, () => lastPosition, isChecked(state, node.from)),
+            }),
+          );
+        }
+      },
+    });
+
+    return builder.finish();
+  };
+
+  return [
+    listener,
+    StateField.define<RangeSet<any>>({
+      create: (state) => checkbox(state),
+      update: (_: RangeSet<any>, tr: Transaction) => checkbox(tr.state),
+      provide: (field) => EditorView.decorations.from(field),
+    }),
+  ];
+};
+
+// TODO(burdon): Reconcile with theme.
+export const styles = EditorView.baseTheme({
+  '& .cm-task-item': {
+    padding: '0 4px',
+  },
+});
+
+export const tasklist = () => [statefield(), styles];