@dxos/react-ui-editor 0.8.4-main.c4373fc → 0.8.4-main.cb12b3f963

package/src/stories/CommandMenu.stories.tsx

@@ -1,158 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type EditorView } from '@codemirror/view';
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React, { useCallback, useRef } from 'react';
-
-import { Obj, Query } from '@dxos/echo';
-import { faker } from '@dxos/random';
-import { useClientProvider, withClientProvider } from '@dxos/react-client/testing';
-import { Domino } from '@dxos/react-ui';
-import { withTheme } from '@dxos/react-ui/testing';
-import { Testing, type ValueGenerator, createObjectFactory } from '@dxos/schema/testing';
-
-import {
-  type CommandMenuGroup,
-  type CommandMenuItem,
-  CommandMenuProvider,
-  coreSlashCommands,
-  filterItems,
-  insertAtCursor,
-  insertAtLineStart,
-  linkSlashCommands,
-} from '../components';
-import { type UseCommandMenuOptions, useCommandMenu } from '../extensions';
-import { str } from '../testing';
-
-import { EditorStory, names } from './components';
-
-const generator: ValueGenerator = faker as any;
-
-type StoryProps = Omit<UseCommandMenuOptions, 'viewRef'> & { text: string };
-
-const DefaultStory = ({ text, ...options }: StoryProps) => {
-  const viewRef = useRef<EditorView>(null);
-  const { groupsRef, commandMenu, ...commandMenuProps } = useCommandMenu({ viewRef, ...options });
-
-  return (
-    <CommandMenuProvider groups={groupsRef.current} {...commandMenuProps}>
-      <EditorStory ref={viewRef} text={text} placeholder={''} extensions={commandMenu} />
-    </CommandMenuProvider>
-  );
-};
-
-const groups: CommandMenuGroup[] = [
-  coreSlashCommands,
-  linkSlashCommands,
-  {
-    id: 'custom',
-    label: 'Custom',
-    items: [
-      {
-        id: 'custom-1',
-        label: 'Log',
-        icon: 'ph--log--regular',
-        onSelect: console.log,
-      },
-    ],
-  },
-];
-
-const meta = {
-  title: 'ui/react-ui-editor/CommandMenu',
-  render: DefaultStory,
-  decorators: [withTheme],
-  parameters: {
-    layout: 'fullscreen',
-  },
-} satisfies Meta<typeof DefaultStory>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-// TODO(burdon): Not working.
-export const Slash: Story = {
-  args: {
-    text: str('# Slash', '', names.join(' '), ''),
-    trigger: '/',
-    placeholder: {
-      content: () =>
-        Domino.of('div')
-          .children(
-            Domino.of('span').text('Press'),
-            Domino.of('span').text('/').classNames('border border-separator rounded-sm mx-1 px-1'),
-            Domino.of('span').text('for commands'),
-          )
-          .build(),
-    },
-    getMenu: (text) => {
-      return filterItems(groups, (item) =>
-        text ? (item.label as string).toLowerCase().includes(text.toLowerCase()) : true,
-      );
-    },
-  },
-};
-
-export const Link: Story = {
-  render: (args: StoryProps) => {
-    const { space } = useClientProvider();
-    const getMenu = useCallback(
-      async (trigger: string, query?: string): Promise<CommandMenuGroup[]> => {
-        if (trigger === '/') {
-          return filterItems(groups, (item) =>
-            query ? (item.label as string).toLowerCase().includes(query.toLowerCase()) : true,
-          );
-        }
-
-        if (!space) {
-          return [];
-        }
-
-        const name = query?.startsWith('@') ? query.slice(1).toLowerCase() : (query?.toLowerCase() ?? '');
-        const result = await space?.db.query(Query.type(Testing.Contact)).run();
-        const items = result.objects
-          .filter((object) => object.name.toLowerCase().includes(name))
-          .map(
-            (object): CommandMenuItem => ({
-              id: object.id,
-              label: object.name,
-              icon: 'ph--user--regular',
-              onSelect: (view, head) => {
-                const link = `[${object.name}](${Obj.getDXN(object)})`;
-                if (query?.startsWith('@')) {
-                  insertAtLineStart(view, head, `!${link}\n`);
-                } else {
-                  insertAtCursor(view, head, `${link} `);
-                }
-              },
-            }),
-          );
-        return [{ id: 'echo', items }];
-      },
-      [space],
-    );
-
-    return <DefaultStory {...args} getMenu={getMenu} />;
-  },
-  decorators: [
-    withClientProvider({
-      createSpace: true,
-      onInitialized: async (client) => {
-        client.addTypes([Testing.Contact]);
-      },
-      onCreateSpace: async ({ space }) => {
-        const createObjects = createObjectFactory(space.db, generator);
-        await createObjects([{ type: Testing.Contact, count: 10 }]);
-        await space.db.flush({ indexes: true });
-      },
-    }),
-  ],
-  args: {
-    text: str('# Link', '', names.join(' '), ''),
-    trigger: ['/', '@'],
-    getMenu: () => [],
-  },
-};

package/src/styles/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-export * from './markdown';
-export * from './theme';
-export * from './tokens';

package/src/styles/markdown.ts

@@ -1,26 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { mx } from '@dxos/react-ui-theme';
-
-export type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
-
-// https://tailwindcss.com/docs/font-weight
-const headings: Record<HeadingLevel, string> = {
-  1: 'text-4xl',
-  2: 'text-3xl',
-  3: 'text-2xl',
-  4: 'text-xl',
-  5: 'text-lg',
-  6: '', // TODO(burdon): Should be text-base, but that's a color in our system.
-};
-
-export const theme = {
-  code: 'font-mono !no-underline text-neutral-700 dark:text-neutral-300',
-  codeMark: 'font-mono text-primary-500',
-  mark: 'opacity-50',
-  heading: (level: HeadingLevel) => {
-    return mx(headings[level], 'dark:text-primary-400');
-  },
-};

package/src/styles/theme.ts

@@ -1,268 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type StyleSpec } from 'style-mod';
-
-import { fontBody } from './tokens';
-
-export type ThemeStyles = Record<string, StyleSpec>;
-
-/**
- * Minimal styles.
- * https://codemirror.net/examples/styling
- *
- * Examples:
- * - https://github.com/codemirror/view/blob/main/src/theme.ts
- * - https://github.com/codemirror/theme-one-dark/blob/main/src/one-dark.ts
- *
- * Main layout:
- * https://codemirror.net/examples/styling
- * https://codemirror.net/docs/guide (DOM Structure).
- *
- * <div class="cm-editor [cm-focused] [generated classes]">
- *   <div class="cm-scroller">
- *     <div class="cm-gutters">
- *       <div class="cm-gutter [...]">
- *         <div class="cm-gutterElement">...</div>
- *       </div>
- *     </div>
- *     <div class="cm-content" role="textbox" contenteditable="true">
- *       <div class="cm-line"></div>
- *     </div>
- *     <div class="cm-selectionLayer">
- *       <div class="cm-selectionBackground"></div>
- *     </div>
- *     <div class="cm-cursorLayer">
- *       <div class="cm-cursor"></div>
- *     </div>
- *   </div>
- * </div>
- *
- * NOTE: `light` and `dark` selectors are preprocessed by CodeMirror and can only be in the base theme.
- * NOTE: Use 'unset' to remove default CM style.
- */
-export const defaultTheme: ThemeStyles = {
-  '&': {},
-  '&.cm-focused': {
-    outline: 'none',
-  },
-
-  /**
-   * Scroller
-   */
-  '.cm-scroller': {
-    overflowY: 'auto',
-  },
-
-  /**
-   * Content
-   * NOTE: Apply margins to content so that scrollbar is at the edge of the container.
-   */
-  '.cm-content': {
-    padding: 'unset',
-    fontFamily: fontBody,
-    // NOTE: Base font size (otherwise defined by HTML tag, which might be different for storybook).
-    fontSize: '16px',
-    lineHeight: '24px',
-    color: 'unset',
-  },
-
-  /**
-   * Gutters
-   * NOTE: Gutters should have the same top margin as the content.
-   */
-  '.cm-gutters': {
-    borderRight: 'none',
-    // background: 'transparent',
-  },
-  '.cm-gutter': {},
-  '.cm-gutter.cm-lineNumbers': {
-    paddingRight: '4px',
-    borderRight: '1px solid var(--dx-subduedSeparator)',
-  },
-  '.cm-gutter.cm-lineNumbers .cm-gutterElement': {
-    minWidth: '40px',
-  },
-  /**
-   * Height is set to match the corresponding line (which may have wrapped).
-   */
-  '.cm-gutterElement': {
-    lineHeight: '24px',
-    fontSize: '12px',
-  },
-
-  /**
-   * Line.
-   */
-  '.cm-line': {
-    lineHeight: '24px',
-    paddingInline: 0,
-  },
-  '.cm-activeLine': {
-    background: 'var(--dx-cmActiveLine)',
-  },
-
-  /**
-   * Cursor (layer).
-   */
-  '.cm-cursor, .cm-dropCursor': {
-    borderLeft: '2px solid var(--dx-cmCursor)',
-  },
-  '.cm-placeholder': {
-    color: 'var(--dx-placeholder)',
-  },
-
-  /**
-   * Selection (layer).
-   */
-  '.cm-selectionBackground': {
-    background: 'var(--dx-cmSelection)',
-  },
-  '&.cm-focused > .cm-scroller > .cm-selectionLayer .cm-selectionBackground': {
-    background: 'var(--dx-cmFocusedSelection)',
-  },
-
-  /**
-   * Search.
-   * NOTE: Matches comment.
-   */
-  '.cm-searchMatch': {
-    margin: '0 -3px',
-    padding: '3px',
-    borderRadius: '3px',
-    background: 'var(--dx-cmHighlightSurface)',
-    color: 'var(--dx-cmHighlight)',
-  },
-  '.cm-searchMatch-selected': {
-    textDecoration: 'underline',
-  },
-
-  /**
-   * Link.
-   */
-  '.cm-link': {
-    textDecorationLine: 'underline',
-    textDecorationThickness: '1px',
-    textDecorationColor: 'var(--dx-separator)',
-    textUnderlineOffset: '2px',
-    borderRadius: '.125rem',
-  },
-  '.cm-link > span': {
-    color: 'var(--dx-accentText)',
-  },
-
-  /**
-   * Tooltip.
-   */
-  '.cm-tooltip': {
-    background: 'var(--dx-baseSurface)',
-  },
-  '.cm-tooltip-below': {},
-
-  /**
-   * Autocomplete.
-   * https://github.com/codemirror/autocomplete/blob/main/src/completion.ts
-   */
-  '.cm-tooltip.cm-tooltip-autocomplete': {
-    marginTop: '6px',
-    marginLeft: '-10px',
-    border: '2px solid var(--dx-separator)',
-    borderRadius: '4px',
-  },
-  '.cm-tooltip.cm-tooltip-autocomplete > ul': {
-    maxHeight: '20em',
-  },
-  '.cm-tooltip.cm-tooltip-autocomplete > ul > li': {
-    padding: '4px',
-  },
-  '.cm-tooltip.cm-tooltip-autocomplete > ul > li[aria-selected]': {
-    background: 'var(--dx-activeSurface)',
-    color: 'var(--dx-activeSurfaceText)',
-  },
-  '.cm-tooltip.cm-tooltip-autocomplete > ul > completion-section': {
-    paddingLeft: '4px !important',
-    color: 'var(--dx-hoverSurfaceText)',
-  },
-
-  '.cm-completionInfo': {
-    width: '360px !important',
-    margin: '-10px 1px 0 1px',
-    padding: '8px !important',
-    borderColor: 'var(--dx-separator)',
-  },
-  '.cm-completionIcon': {
-    display: 'none',
-  },
-  '.cm-completionLabel': {
-    fontFamily: fontBody,
-    color: 'var(--dx-description)',
-    padding: '0 4px',
-  },
-  '.cm-completionMatchedText': {
-    textDecoration: 'none !important',
-    color: 'var(--dx-baseText)',
-  },
-
-  /**
-   * Panels
-   * https://github.com/codemirror/search/blob/main/src/search.ts#L745
-   *
-   * Find/replace panel.
-   * <div class="cm-announced">...</div>
-   * <div class="cm-scroller">...</div>
-   * <div class="cm-panels cm-panels-bottom">
-   *   <div class="cm-search cm-panel">
-   *     <input class="cm-textfield" />
-   *     <button class="cm-button">...</button>
-   *     <label><input type="checkbox" />...</label>
-   *   </div>
-   * </div
-   */
-  // TODO(burdon): Implement custom panel (with icon buttons).
-  '.cm-panels': {},
-  '.cm-panel': {
-    fontFamily: fontBody,
-    backgroundColor: 'var(--surface-bg)',
-  },
-  '.cm-panel input, .cm-panel button, .cm-panel label': {
-    color: 'var(--dx-subdued)',
-    fontFamily: fontBody,
-    fontSize: '14px',
-    all: 'unset',
-    margin: '3px !important',
-    padding: '2px 6px !important',
-    outline: '1px solid transparent',
-  },
-  '.cm-panel input, .cm-panel button': {
-    backgroundColor: 'var(--dx-inputSurface)',
-  },
-  '.cm-panel input:focus, .cm-panel button:focus': {
-    outline: '1px solid var(--dx-neutralFocusIndicator)',
-  },
-  '.cm-panel label': {
-    display: 'inline-flex',
-    alignItems: 'center',
-    cursor: 'pointer',
-  },
-  '.cm-panel input.cm-textfield': {},
-  '.cm-panel input[type=checkbox]': {
-    width: '8px',
-    height: '8px',
-    marginRight: '6px !important',
-    padding: '2px !important',
-    color: 'var(--dx-neutralFocusIndicator)',
-  },
-  '.cm-panel button': {
-    '&:hover': {
-      backgroundColor: 'var(--dx-accentSurfaceHover) !important',
-    },
-    '&:active': {
-      backgroundColor: 'var(--dx-accentSurfaceHover)',
-    },
-  },
-  '.cm-panel.cm-search': {
-    padding: '4px',
-    borderTop: '1px solid var(--dx-separator)',
-  },
-};

package/src/styles/tokens.ts

@@ -1,17 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { tokens } from '@dxos/react-ui-theme';
-import { get } from '@dxos/util';
-
-/**
- * Returns the tailwind token value.
- */
-const getToken = (path: string, defaultValue?: string | string[]): string => {
-  const value = get(tokens, path, defaultValue);
-  return value?.toString() ?? '';
-};
-
-export const fontBody = getToken('fontFamily.body');
-export const fontMono = getToken('fontFamily.mono');

package/src/testing/PreviewPopover.tsx

@@ -1,78 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { createContext } from '@radix-ui/react-context';
-import React, { type PropsWithChildren, type RefObject, useCallback, useEffect, useRef, useState } from 'react';
-
-import { addEventListener } from '@dxos/async';
-import { type DxAnchorActivate, Popover } from '@dxos/react-ui';
-
-import { type PreviewLinkRef, type PreviewLinkTarget } from '../extensions';
-
-type PreviewLookup = (link: PreviewLinkRef) => Promise<PreviewLinkTarget | null | undefined>;
-
-type PreviewPopoverValue = Partial<{
-  link: PreviewLinkRef;
-  target: PreviewLinkTarget;
-  pending: boolean;
-}>;
-
-const [PreviewPopoverContextProvider, usePreviewPopover] = createContext<PreviewPopoverValue>('PreviewPopover', {});
-
-type PopoverLookupProviderProps = PropsWithChildren<{
-  onLookup?: PreviewLookup;
-}>;
-
-const PreviewPopoverProvider = ({ children, onLookup }: PopoverLookupProviderProps) => {
-  const trigger = useRef<HTMLElement | null>(null);
-  const [value, setValue] = useState<PreviewPopoverValue>({});
-  const [open, setOpen] = useState(false);
-
-  const handleDxAnchorActivate = useCallback(
-    (event: DxAnchorActivate) => {
-      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],
-  );
-
-  const [rootRef, setRootRef] = useState<HTMLDivElement | null>(null);
-  useEffect(() => {
-    if (!rootRef || !handleDxAnchorActivate) {
-      return;
-    }
-
-    return addEventListener(rootRef, 'dx-anchor-activate' as any, handleDxAnchorActivate, {
-      capture: true,
-      passive: false,
-    });
-  }, [rootRef, handleDxAnchorActivate]);
-
-  return (
-    <PreviewPopoverContextProvider pending={value.pending} link={value.link} target={value.target}>
-      <Popover.Root open={open} onOpenChange={setOpen}>
-        <Popover.VirtualTrigger virtualRef={trigger as unknown as RefObject<HTMLButtonElement>} />
-        <div role='none' className='contents' ref={setRootRef}>
-          {children}
-        </div>
-      </Popover.Root>
-    </PreviewPopoverContextProvider>
-  );
-};
-export { PreviewPopoverProvider, usePreviewPopover };
-
-export type { PopoverLookupProviderProps, PreviewPopoverValue };

package/src/testing/index.ts

@@ -1,6 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-export * from './util';
-export * from './PreviewPopover';

package/src/testing/util.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-/** deprecated Replace with @dxos/util trim */
-// TODO(burdon): Remove
-export const str = (...lines: string[]) => lines.join('\n');

package/src/types/index.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export * from './types';

package/src/types/types.ts

@@ -1,32 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type EditorView } from '@codemirror/view';
-import * as Schema from 'effect/Schema';
-
-// Runtime data structure.
-export type Range = {
-  from: number;
-  to: number;
-};
-
-// Persistent data structure.
-// TODO(burdon): Rename annotation?
-export type Comment = {
-  id: string;
-  cursor?: string;
-};
-
-/**
- * Callback that renders into a DOM element within the editor.
- */
-export type RenderCallback<Props extends object> = (el: HTMLElement, props: Props, view: EditorView) => void;
-
-export const EditorViewModes = ['preview', 'readonly', 'source'] as const;
-export const EditorViewMode = Schema.Union(...EditorViewModes.map((mode) => Schema.Literal(mode)));
-export type EditorViewMode = Schema.Schema.Type<typeof EditorViewMode>;
-
-export const EditorInputModes = ['default', 'vim', 'vscode'] as const;
-export const EditorInputMode = Schema.Union(...EditorInputModes.map((mode) => Schema.Literal(mode)));
-export type EditorInputMode = Schema.Schema.Type<typeof EditorInputMode>;

package/src/util/cursor.ts

@@ -1,56 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type EditorState } from '@codemirror/state';
-
-import { type Range } from '../types';
-
-import { singleValueFacet } from './facet';
-
-/**
- * Determines if two ranges overlap.
- * A range is considered to overlap if there is any intersection
- * between the two ranges, inclusive of their boundaries.
- */
-export const overlap = (a: Range, b: Range): boolean => a.from <= b.to && a.to >= b.from;
-
-/**
- * Converts indexes into the text document into stable peer-independent cursors.
- *
- * See:
- *  - https://automerge.org/automerge/api-docs/js/functions/next.getCursor.html
- *  - https://github.com/yjs/yjs?tab=readme-ov-file#relative-positions
- *
- * @param {assoc} number Negative values will associate the cursor with the previous character
- *  while positive - with the next one.
- */
-export interface CursorConverter {
-  toCursor(position: number, assoc?: -1 | 1 | undefined): string;
-  fromCursor(cursor: string): number;
-}
-
-const defaultCursorConverter: CursorConverter = {
-  toCursor: (position) => position.toString(),
-  fromCursor: (cursor) => parseInt(cursor),
-};
-
-export class Cursor {
-  static readonly converter = singleValueFacet(defaultCursorConverter);
-
-  static readonly getCursorFromRange = (state: EditorState, range: Range) => {
-    const cursorConverter = state.facet(Cursor.converter);
-    const from = cursorConverter.toCursor(range.from);
-    const to = cursorConverter.toCursor(range.to, -1);
-    return [from, to].join(':');
-  };
-
-  static readonly getRangeFromCursor = (state: EditorState, cursor: string) => {
-    const cursorConverter = state.facet(Cursor.converter);
-
-    const parts = cursor.split(':');
-    const from = cursorConverter.fromCursor(parts[0]);
-    const to = cursorConverter.fromCursor(parts[1]);
-    return from !== undefined && to !== undefined ? { from, to } : undefined;
-  };
-}