@dxos/react-ui-editor 0.8.3 → 0.8.4-main.1068cf700f

package/src/components/Popover/CommandMenu.tsx

@@ -1,279 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type EditorView } from '@codemirror/view';
-import React, { useCallback, useEffect, useRef } from 'react';
-
-import { Icon, type Label, Popover, toLocalizedString, useThemeContext, useTranslation } from '@dxos/react-ui';
-import { type MaybePromise } from '@dxos/util';
-
-import { commandRangeEffect } from '../../extensions';
-
-export type CommandMenuGroup = {
-  id: string;
-  label?: Label;
-  items: CommandMenuItem[];
-};
-
-export type CommandMenuItem = {
-  id: string;
-  label: Label;
-  icon?: string;
-  onSelect?: (view: EditorView, head: number) => MaybePromise<void>;
-};
-
-export type CommandMenuProps = {
-  groups: CommandMenuGroup[];
-  currentItem?: string;
-  onSelect: (item: CommandMenuItem) => void;
-};
-
-// NOTE: Not using DropdownMenu because the command menu needs to manage focus explicitly.
-export const CommandMenu = ({ groups, currentItem, onSelect }: CommandMenuProps) => {
-  const { tx } = useThemeContext();
-  const groupsWithItems = groups.filter((group) => group.items.length > 0);
-  return (
-    <Popover.Portal>
-      <Popover.Content
-        align='start'
-        onOpenAutoFocus={(event) => event.preventDefault()}
-        classNames={tx('menu.content', 'menu--exotic-unfocusable', { elevation: 'positioned' }, [
-          'max-h-[300px] overflow-y-auto',
-        ])}
-      >
-        <Popover.Viewport classNames={tx('menu.viewport', 'menu__viewport--exotic-unfocusable', {})}>
-          <ul>
-            {groupsWithItems.map((group, index) => (
-              <React.Fragment key={group.id}>
-                <CommandGroup group={group} currentItem={currentItem} onSelect={onSelect} />
-                {index < groupsWithItems.length - 1 && <div className={tx('menu.separator', 'menu__item', {})} />}
-              </React.Fragment>
-            ))}
-          </ul>
-        </Popover.Viewport>
-      </Popover.Content>
-    </Popover.Portal>
-  );
-};
-
-const CommandGroup = ({
-  group,
-  currentItem,
-  onSelect,
-}: {
-  group: CommandMenuGroup;
-  currentItem?: string;
-  onSelect: (item: CommandMenuItem) => void;
-}) => {
-  const { tx } = useThemeContext();
-  const { t } = useTranslation();
-  return (
-    <>
-      {group.label && (
-        <div className={tx('menu.groupLabel', 'menu__group__label', {})}>
-          <span>{toLocalizedString(group.label, t)}</span>
-        </div>
-      )}
-      {group.items.map((item) => (
-        <CommandItem key={item.id} item={item} current={currentItem === item.id} onSelect={onSelect} />
-      ))}
-    </>
-  );
-};
-
-const CommandItem = ({
-  item,
-  current,
-  onSelect,
-}: {
-  item: CommandMenuItem;
-  current: boolean;
-  onSelect: (item: CommandMenuItem) => void;
-}) => {
-  const ref = useRef<HTMLLIElement>(null);
-  const { tx } = useThemeContext();
-  const { t } = useTranslation();
-  const handleSelect = useCallback(() => onSelect(item), [item, onSelect]);
-
-  useEffect(() => {
-    if (current && ref.current) {
-      ref.current.scrollIntoView({ behavior: 'smooth', block: 'nearest' });
-    }
-  }, [current]);
-
-  return (
-    <li
-      ref={ref}
-      className={tx('menu.item', 'menu__item--exotic-unfocusable', {}, [current && 'bg-hoverSurface'])}
-      onClick={handleSelect}
-    >
-      {item.icon && <Icon icon={item.icon} size={5} />}
-      <span className='grow truncate'>{toLocalizedString(item.label, t)}</span>
-    </li>
-  );
-};
-
-// TODO(wittjosiah): Factor out into a separate file.
-
-//
-// Helpers
-//
-
-export const getItem = (groups: CommandMenuGroup[], id?: string): CommandMenuItem | undefined => {
-  return groups.flatMap((group) => group.items).find((item) => item.id === id);
-};
-
-export const getNextItem = (groups: CommandMenuGroup[], id?: string): CommandMenuItem => {
-  const items = groups.flatMap((group) => group.items);
-  const index = items.findIndex((item) => item.id === id);
-  return items[(index + 1) % items.length];
-};
-
-export const getPreviousItem = (groups: CommandMenuGroup[], id?: string): CommandMenuItem => {
-  const items = groups.flatMap((group) => group.items);
-  const index = items.findIndex((item) => item.id === id);
-  return items[(index - 1 + items.length) % items.length];
-};
-
-export const filterItems = (
-  groups: CommandMenuGroup[],
-  filter: (item: CommandMenuItem) => boolean,
-): CommandMenuGroup[] => {
-  return groups.map((group) => ({
-    ...group,
-    items: group.items.filter(filter),
-  }));
-};
-
-export const insertAtCursor = (view: EditorView, head: number, insert: string) => {
-  view.dispatch({
-    changes: { from: head, to: head, insert },
-    selection: { anchor: head + insert.length, head: head + insert.length },
-  });
-};
-
-/**
- * If the cursor is at the start of a line, insert the text at the cursor.
- * Otherwise, insert the text on a new line.
- */
-export const insertAtLineStart = (view: EditorView, head: number, insert: string) => {
-  const line = view.state.doc.lineAt(head);
-  if (line.from === head) {
-    insertAtCursor(view, head, insert);
-  } else {
-    insert = '\n' + insert;
-    view.dispatch({
-      changes: { from: line.to, to: line.to, insert },
-      selection: { anchor: line.to + insert.length, head: line.to + insert.length },
-    });
-  }
-};
-
-export const coreSlashCommands: CommandMenuGroup = {
-  id: 'markdown',
-  label: 'Markdown',
-  items: [
-    {
-      id: 'heading-1',
-      label: 'Heading 1',
-      icon: 'ph--text-h-one--regular',
-      onSelect: (view, head) => insertAtLineStart(view, head, '# '),
-    },
-    {
-      id: 'heading-2',
-      label: 'Heading 2',
-      icon: 'ph--text-h-two--regular',
-      onSelect: (view, head) => insertAtLineStart(view, head, '## '),
-    },
-    {
-      id: 'heading-3',
-      label: 'Heading 3',
-      icon: 'ph--text-h-three--regular',
-      onSelect: (view, head) => insertAtLineStart(view, head, '### '),
-    },
-    {
-      id: 'heading-4',
-      label: 'Heading 4',
-      icon: 'ph--text-h-four--regular',
-      onSelect: (view, head) => insertAtLineStart(view, head, '#### '),
-    },
-    {
-      id: 'heading-5',
-      label: 'Heading 5',
-      icon: 'ph--text-h-five--regular',
-      onSelect: (view, head) => insertAtLineStart(view, head, '##### '),
-    },
-    {
-      id: 'heading-6',
-      label: 'Heading 6',
-      icon: 'ph--text-h-six--regular',
-      onSelect: (view, head) => insertAtLineStart(view, head, '###### '),
-    },
-    {
-      id: 'bullet-list',
-      label: 'Bullet List',
-      icon: 'ph--list-bullets--regular',
-      onSelect: (view, head) => insertAtLineStart(view, head, '- '),
-    },
-    {
-      id: 'numbered-list',
-      label: 'Numbered List',
-      icon: 'ph--list-numbers--regular',
-      onSelect: (view, head) => insertAtLineStart(view, head, '1. '),
-    },
-    {
-      id: 'task-list',
-      label: 'Task List',
-      icon: 'ph--list-checks--regular',
-      onSelect: (view, head) => insertAtLineStart(view, head, '- [ ] '),
-    },
-    {
-      id: 'quote',
-      label: 'Quote',
-      icon: 'ph--quotes--regular',
-      onSelect: (view, head) => insertAtLineStart(view, head, '> '),
-    },
-    {
-      id: 'code-block',
-      label: 'Code Block',
-      icon: 'ph--code-block--regular',
-      onSelect: (view, head) => insertAtLineStart(view, head, '```\n\n```'),
-    },
-    {
-      id: 'table',
-      label: 'Table',
-      icon: 'ph--table--regular',
-      onSelect: (view, head) => insertAtLineStart(view, head, '| | | |\n|---|---|---|\n| | | |'),
-    },
-  ],
-};
-
-export const linkSlashCommands: CommandMenuGroup = {
-  id: 'link',
-  label: 'Link',
-  items: [
-    {
-      id: 'inline-link',
-      label: 'Inline link',
-      icon: 'ph--link--regular',
-      onSelect: (view, head) =>
-        view.dispatch({
-          changes: { from: head, insert: '@' },
-          selection: { anchor: head + 1, head: head + 1 },
-          effects: commandRangeEffect.of({ trigger: '@', range: { from: head, to: head + 1 } }),
-        }),
-    },
-    {
-      id: 'block-embed',
-      label: 'Block embed',
-      icon: 'ph--lego--regular',
-      onSelect: (view, head) =>
-        view.dispatch({
-          changes: { from: head, insert: '@@' },
-          selection: { anchor: head + 2, head: head + 2 },
-          effects: commandRangeEffect.of({ trigger: '@', range: { from: head, to: head + 2 } }),
-        }),
-    },
-  ],
-};

package/src/components/Popover/RefDropdownMenu.tsx

@@ -1,79 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { createContext } from '@radix-ui/react-context';
-import React, { type PropsWithChildren, useRef, useState, useEffect, useCallback, type RefObject } from 'react';
-
-import { addEventListener } from '@dxos/async';
-import { type DxRefTag, type DxRefTagActivate } from '@dxos/lit-ui';
-import { DropdownMenu } from '@dxos/react-ui';
-
-import { type PreviewLinkRef, type PreviewLinkTarget, type PreviewLookup } from '../../extensions';
-
-// TODO(burdon): Reconcile with RefPopover?
-
-const customEventOptions = { capture: true, passive: false };
-
-// Create a context for the dxn value.
-type RefDropdownMenuValue = Partial<{ link: PreviewLinkRef; target: PreviewLinkTarget; pending: boolean }>;
-
-const REF_DROPDOWN_MENU = 'RefDropdownMenu';
-const [RefDropdownMenuContextProvider, useRefDropdownMenu] = createContext<RefDropdownMenuValue>(REF_DROPDOWN_MENU, {});
-
-type RefDropdownMenuProviderProps = PropsWithChildren<{ onLookup?: PreviewLookup }>;
-
-const RefDropdownMenuProvider = ({ children, onLookup }: RefDropdownMenuProviderProps) => {
-  const trigger = useRef<DxRefTag | null>(null);
-  const [value, setValue] = useState<RefDropdownMenuValue>({});
-  const [rootRef, setRootRef] = useState<HTMLDivElement | null>(null);
-  const [open, setOpen] = useState(false);
-
-  const handleDxRefTagActivate = useCallback(
-    (event: DxRefTagActivate) => {
-      const { refId, label, trigger: dxTrigger } = event;
-      setValue((value) => ({
-        ...value,
-        link: { label, ref: refId },
-        pending: true,
-      }));
-      trigger.current = dxTrigger;
-      queueMicrotask(() => setOpen(true));
-      void onLookup?.({ label, ref: refId }).then((target) =>
-        setValue((value) => ({
-          ...value,
-          target: target ?? undefined,
-          pending: false,
-        })),
-      );
-    },
-    [onLookup],
-  );
-
-  useEffect(() => {
-    if (!rootRef) {
-      return;
-    }
-
-    return addEventListener(rootRef, 'dx-ref-tag-activate' as any, handleDxRefTagActivate, customEventOptions);
-  }, [rootRef]);
-
-  return (
-    <RefDropdownMenuContextProvider pending={value.pending} link={value.link} target={value.target}>
-      <DropdownMenu.Root open={open} onOpenChange={setOpen}>
-        <DropdownMenu.VirtualTrigger virtualRef={trigger as unknown as RefObject<HTMLButtonElement>} />
-        <div role='none' className='contents' ref={setRootRef}>
-          {children}
-        </div>
-      </DropdownMenu.Root>
-    </RefDropdownMenuContextProvider>
-  );
-};
-
-export const RefDropdownMenu = {
-  Provider: RefDropdownMenuProvider,
-};
-
-export { useRefDropdownMenu };
-
-export type { RefDropdownMenuProviderProps, RefDropdownMenuValue };

package/src/components/Popover/RefPopover.tsx

@@ -1,99 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { createContext } from '@radix-ui/react-context';
-import React, {
-  type PropsWithChildren,
-  useRef,
-  useState,
-  useEffect,
-  useCallback,
-  type RefObject,
-  forwardRef,
-} from 'react';
-
-import { addEventListener } from '@dxos/async';
-import { type DxRefTag, type DxRefTagActivate } from '@dxos/lit-ui';
-import { Popover } from '@dxos/react-ui';
-
-import { type PreviewLinkRef, type PreviewLinkTarget, type PreviewLookup } from '../../extensions';
-
-const customEventOptions = { capture: true, passive: false };
-
-export type RefPopoverProps = PropsWithChildren<{
-  modal?: boolean;
-  open?: boolean;
-  onOpenChange?: (open: boolean) => void;
-  onActivate?: (event: DxRefTagActivate) => void;
-}>;
-
-export const RefPopover = forwardRef<DxRefTag | null, RefPopoverProps>(
-  ({ children, open, onOpenChange, modal, onActivate }, ref) => {
-    const [rootRef, setRootRef] = useState<HTMLDivElement | null>(null);
-
-    useEffect(() => {
-      if (!rootRef || !onActivate) {
-        return;
-      }
-
-      return addEventListener(rootRef, 'dx-ref-tag-activate' as any, onActivate, customEventOptions);
-    }, [rootRef, onActivate]);
-
-    return (
-      <Popover.Root open={open} onOpenChange={onOpenChange} modal={modal}>
-        <Popover.VirtualTrigger virtualRef={ref as unknown as RefObject<HTMLButtonElement>} />
-        <div role='none' className='contents' ref={setRootRef}>
-          {children}
-        </div>
-      </Popover.Root>
-    );
-  },
-);
-
-// Create a context for the dxn value.
-type RefPopoverValue = Partial<{ link: PreviewLinkRef; target: PreviewLinkTarget; pending: boolean }>;
-
-const REF_POPOVER = 'RefPopover';
-const [RefPopoverContextProvider, useRefPopover] = createContext<RefPopoverValue>(REF_POPOVER, {});
-
-type PreviewProviderProps = PropsWithChildren<{ onLookup?: PreviewLookup }>;
-
-const PreviewProvider = ({ children, onLookup }: PreviewProviderProps) => {
-  const trigger = useRef<DxRefTag | null>(null);
-  const [value, setValue] = useState<RefPopoverValue>({});
-  const [open, setOpen] = useState(false);
-
-  const handleDxRefTagActivate = useCallback(
-    (event: DxRefTagActivate) => {
-      const { refId, label, trigger: dxTrigger } = event;
-      setValue((value) => ({
-        ...value,
-        link: { label, ref: refId },
-        pending: true,
-      }));
-      trigger.current = dxTrigger;
-      queueMicrotask(() => setOpen(true));
-      void onLookup?.({ label, ref: refId }).then((target) =>
-        setValue((value) => ({
-          ...value,
-          target: target ?? undefined,
-          pending: false,
-        })),
-      );
-    },
-    [onLookup],
-  );
-
-  return (
-    <RefPopoverContextProvider pending={value.pending} link={value.link} target={value.target}>
-      <RefPopover ref={trigger} open={open} onOpenChange={setOpen} onActivate={handleDxRefTagActivate}>
-        {children}
-      </RefPopover>
-    </RefPopoverContextProvider>
-  );
-};
-
-export { PreviewProvider, useRefPopover };
-
-export type { PreviewProviderProps, RefPopoverValue };

package/src/components/Popover/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-export * from './CommandMenu';
-export * from './RefPopover';
-export * from './RefDropdownMenu';

package/src/defaults.ts

@@ -1,49 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { EditorView } from '@codemirror/view';
-
-import { mx } from '@dxos/react-ui-theme';
-
-import { type ThemeExtensionsOptions } from './extensions';
-import { fontMono } from './styles';
-
-/**
- * CodeMirror content width.
- * 40rem = 640px. Corresponds to initial plank width (Google docs, Stashpad, etc.)
- * 50rem = 800px. Maximum content width for solo mode.
- * NOTE: Max width - 4rem = 2rem left/right margin (or 2rem gutter plus 1rem left/right margin).
- */
-export const editorWidth = '!mli-auto is-full max-is-[min(50rem,100%-4rem)]';
-
-export const editorSlots: ThemeExtensionsOptions['slots'] = {
-  scroll: {
-    className: 'pbs-2',
-  },
-  content: {
-    className: editorWidth,
-  },
-};
-
-export const editorGutter = EditorView.theme({
-  '.cm-gutters': {
-    background: 'var(--dx-baseSurface)',
-    paddingRight: '1rem',
-  },
-});
-
-export const editorMonospace = EditorView.theme({
-  '.cm-content': {
-    fontFamily: fontMono,
-  },
-});
-
-export const editorWithToolbarLayout =
-  'grid grid-cols-1 grid-rows-[min-content_1fr] data-[toolbar=disabled]:grid-rows-[1fr] justify-center content-start overflow-hidden';
-
-export const stackItemContentEditorClassNames = (role?: string) =>
-  mx(
-    'attention-surface dx-focus-ring-inset data-[toolbar=disabled]:pbs-2',
-    role === 'section' ? '[&_.cm-scroller]:overflow-hidden [&_.cm-scroller]:min-bs-24' : 'min-bs-0',
-  );

package/src/extensions/annotations.ts

@@ -1,55 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type Extension, RangeSetBuilder } from '@codemirror/state';
-import { Decoration, type DecorationSet, EditorView, ViewPlugin, type ViewUpdate } from '@codemirror/view';
-
-const annotationMark = Decoration.mark({ class: 'cm-annotation' });
-
-export type AnnotationOptions = {
-  match?: RegExp; // TODO(burdon): Update via hook (e.g., for search).
-};
-
-/**
- *
- */
-export const annotations = ({ match }: AnnotationOptions = {}): Extension => {
-  return [
-    ViewPlugin.fromClass(
-      class {
-        decorations: DecorationSet = Decoration.none;
-        update(update: ViewUpdate) {
-          const builder = new RangeSetBuilder<Decoration>();
-          if (match) {
-            // Only process visible lines.
-            const { from, to } = update.view.viewport;
-            const text = update.state.doc.sliceString(from, to);
-            const matches = text.matchAll(match);
-            for (const m of matches) {
-              if (m.index !== undefined) {
-                // Adjust match position relative to viewport.
-                const start = from + m.index;
-                const end = start + m[0].length;
-                builder.add(start, end, annotationMark);
-              }
-            }
-          }
-
-          this.decorations = builder.finish();
-        }
-      },
-      {
-        decorations: (v) => v.decorations,
-      },
-    ),
-
-    EditorView.theme({
-      '.cm-annotation': {
-        textDecoration: 'underline',
-        textDecorationStyle: 'wavy',
-        textDecorationColor: 'var(--dx-errorText)',
-      },
-    }),
-  ];
-};

package/src/extensions/autocomplete.ts

@@ -1,69 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import {
-  autocompletion,
-  completionKeymap,
-  type CompletionSource,
-  type Completion,
-  type CompletionContext,
-  type CompletionResult,
-} from '@codemirror/autocomplete';
-import { markdownLanguage } from '@codemirror/lang-markdown';
-import { type Extension } from '@codemirror/state';
-import { keymap } from '@codemirror/view';
-
-export type AutocompleteResult = Completion;
-
-export type AutocompleteOptions = {
-  activateOnTyping?: boolean;
-  override?: CompletionSource[];
-  onSearch?: (text: string) => Completion[];
-};
-
-// https://codemirror.net/examples/autocompletion
-// https://codemirror.net/docs/ref/#autocomplete.autocompletion
-// https://codemirror.net/docs/ref/#autocomplete.Completion
-
-/**
- * Autocomplete extension.
- */
-export const autocomplete = ({ activateOnTyping, override, onSearch }: AutocompleteOptions = {}): Extension => {
-  const extensions: Extension[] = [
-    // https://codemirror.net/docs/ref/#view.keymap
-    // https://discuss.codemirror.net/t/how-can-i-replace-the-default-autocompletion-keymap-v6/3322
-    // TODO(burdon): Set custom keymap.
-    keymap.of(completionKeymap),
-
-    // https://codemirror.net/examples/autocompletion
-    // https://codemirror.net/docs/ref/#autocomplete.autocompletion
-    autocompletion({
-      override,
-      activateOnTyping,
-      // closeOnBlur: false,
-      // tooltipClass: () => 'rounded-be pbe-1 border-separator',
-    }),
-  ];
-
-  if (onSearch) {
-    extensions.push(
-      // TODO(burdon): Optional decoration via addToOptions.
-      markdownLanguage.data.of({
-        autocomplete: (context: CompletionContext): CompletionResult | null => {
-          const match = context.matchBefore(/\w*/);
-          if (!match || (match.from === match.to && !context.explicit)) {
-            return null;
-          }
-
-          return {
-            from: match.from,
-            options: onSearch(match.text.toLowerCase()),
-          };
-        },
-      }),
-    );
-  }
-
-  return extensions;
-};