@dxos/plugin-markdown 0.8.4-main.9735255 → 0.8.4-main.9be5663bfe

package/src/components/MarkdownEditor/MarkdownEditor.tsx

@@ -6,20 +6,22 @@ import { type Extension } from '@codemirror/state';
 import { type EditorView } from '@codemirror/view';
 import { type Atom } from '@effect-atom/atom-react';
 import { createContext } from '@radix-ui/react-context';
-import React, { type PropsWithChildren, useMemo, useState } from 'react';
+import React, { type ReactNode, useCallback, useMemo, useState } from 'react';
 import { createPortal } from 'react-dom';
 
-import { Surface } from '@dxos/app-framework/react';
+import { Surface } from '@dxos/app-framework/ui';
+import { Obj } from '@dxos/echo';
 import { DXN } from '@dxos/keys';
 import { useClient } from '@dxos/react-client';
+import { type ThemedClassName } from '@dxos/react-ui';
 import {
-  EditorMenuProvider,
+  type EditorRootProps,
   type EditorToolbarState,
-  type UseEditorMenu,
-  useEditorMenu,
-  useEditorToolbar,
+  createEditorController,
+  useEditorContext,
 } from '@dxos/react-ui-editor';
 import { type PreviewBlock, type PreviewOptions } from '@dxos/ui-editor';
+import { composable, composableProps } from '@dxos/ui-theme';
 import { isNonNullable } from '@dxos/util';
 
 import {
@@ -28,7 +30,7 @@ import {
   type UseEditorMenuOptionsProps,
   useEditorMenuOptions,
   useExtensions,
-} from '../../hooks';
+} from '#hooks';
 
 import {
   MarkdownEditorContent as NaturalMarkdownEditorContent,
@@ -45,198 +47,233 @@ import {
 
 type MarkdownEditorContextValue = {
   id: string;
-  setEditorView: (view: EditorView) => void;
-  extensions: Extension[];
+  attendableId?: string;
   previewBlocks: PreviewBlock[];
-  toolbarState: Atom.Writable<EditorToolbarState>;
-  popoverMenu: Omit<UseEditorMenu, 'extension'>;
-} & (Pick<ExtensionsOptions, 'viewMode'> &
-  Pick<NaturalMarkdownToolbarProps, 'editorView' | 'onAction' | 'onFileUpload' | 'onViewModeChange'>);
+} & Pick<ExtensionsOptions, 'compact' | 'viewMode'> &
+  Pick<NaturalMarkdownToolbarProps, 'onAction' | 'onFileUpload' | 'onViewModeChange'>;
 
 const [MarkdownEditorContextProvider, useMarkdownEditorContext] =
   createContext<MarkdownEditorContextValue>('MarkdownEditor.Context');
 
+/**
+ * Props to spread onto `Editor.Root` from `MarkdownEditorProvider`'s render callback.
+ */
+export type MarkdownEditorEditorRootProps = Omit<EditorRootProps, 'children'>;
+
 //
-// MarkdownEditor.Root
+// MarkdownEditorProvider
 //
 
-type MarkdownEditorRootProps = PropsWithChildren<
-  {
-    object?: DocumentType;
-    extensions?: Extension[];
-  } & Pick<MarkdownEditorContextValue, 'id' | 'onAction' | 'onFileUpload' | 'onViewModeChange' | 'viewMode'> &
-    Pick<UseEditorMenuOptionsProps, 'slashCommandGroups' | 'onLinkQuery'> &
-    Pick<ExtensionsOptions, 'editorStateStore' | 'selectionManager' | 'settings'>
->;
-
-const MarkdownEditorRoot = ({
+export type MarkdownEditorProviderProps = {
+  object?: DocumentType;
+  extensions?: Extension[];
+  children: (editorRootProps: MarkdownEditorEditorRootProps) => ReactNode;
+} & Pick<
+  MarkdownEditorContextValue,
+  'id' | 'attendableId' | 'viewMode' | 'compact' | 'onAction' | 'onFileUpload' | 'onViewModeChange'
+> &
+  Pick<UseEditorMenuOptionsProps, 'slashCommandGroups' | 'onLinkQuery'> &
+  Pick<ExtensionsOptions, 'editorStateStore' | 'selectionManager' | 'settings' | 'onSelectObject'>;
+
+export const MarkdownEditorProvider = ({
   children,
   id,
+  attendableId,
   object,
-  editorStateStore,
-  selectionManager,
   settings,
+  compact,
   viewMode,
+  selectionManager,
+  editorStateStore,
   extensions: extensionsProp,
   slashCommandGroups,
   onLinkQuery,
-  ...props
-}: MarkdownEditorRootProps) => {
-  const [editorView, setEditorView] = useState<EditorView>();
-
+  onSelectObject,
+  onAction,
+  onFileUpload,
+  onViewModeChange,
+}: MarkdownEditorProviderProps) => {
   // Preview blocks.
   const [previewBlocks, setPreviewBlocks] = useState<PreviewBlock[]>([]);
   const previewOptions = useMemo<PreviewOptions>(
     () => ({
+      db: Obj.isObject(object) ? Obj.getDatabase(object) : undefined,
       addBlockContainer: (block) => {
         setPreviewBlocks((prev) => [...prev, block]);
       },
       removeBlockContainer: ({ link }) => {
-        setPreviewBlocks((prev) => prev.filter(({ link: prevLink }) => prevLink.ref !== link.ref));
+        setPreviewBlocks((prev) => prev.filter(({ link: prevLink }) => prevLink.dxn !== link.dxn));
       },
     }),
-    [],
+    [object],
   );
 
-  // Toolbar state.
-  const toolbarState = useEditorToolbar({ viewMode });
+  // Context menu options (Editor.Root calls useEditorMenu with these props).
+  const menuOptions = useEditorMenuOptions({ slashCommandGroups, onLinkQuery });
 
-  // Context menu.
-  const menuOptions = useEditorMenuOptions({
-    editorView,
-    slashCommandGroups,
-    onLinkQuery,
-  });
-  const { extension: menuExtension, ...menuProps } = useEditorMenu(menuOptions);
-
-  // Extensions.
+  // Core markdown extensions (popover/menu extension is added by Editor.Root).
   const coreExtensions = useExtensions({
     id,
     object,
+    compact,
+    viewMode,
+    selectionManager,
     editorStateStore,
     previewOptions,
-    selectionManager,
     settings,
-    viewMode,
+    onSelectObject,
   });
 
   const extensions = useMemo(
-    () => [coreExtensions, menuExtension, extensionsProp].filter(isNonNullable),
-    [coreExtensions, menuExtension, extensionsProp],
+    () => [coreExtensions, extensionsProp].filter(isNonNullable).flat(),
+    [coreExtensions, extensionsProp],
+  );
+
+  const editorRootProps = useMemo<MarkdownEditorEditorRootProps>(
+    () => ({
+      extensions,
+      viewMode,
+      getMenu: menuOptions.getMenu,
+      trigger: menuOptions.trigger,
+      placeholder: menuOptions.placeholder,
+      ...(menuOptions.filter !== undefined ? { filter: menuOptions.filter } : {}),
+      ...(menuOptions.triggerKey !== undefined ? { triggerKey: menuOptions.triggerKey } : {}),
+    }),
+    [extensions, viewMode, menuOptions],
+  );
+
+  const markdownContextValue = useMemo<MarkdownEditorContextValue>(
+    () => ({
+      id,
+      attendableId,
+      compact,
+      viewMode,
+      previewBlocks,
+      onAction,
+      onFileUpload,
+      onViewModeChange,
+    }),
+    [id, attendableId, compact, viewMode, previewBlocks, onAction, onFileUpload, onViewModeChange],
   );
 
   return (
-    <MarkdownEditorContextProvider
-      id={id}
-      editorView={editorView}
-      setEditorView={setEditorView}
-      extensions={extensions}
-      previewBlocks={previewBlocks}
-      toolbarState={toolbarState}
-      popoverMenu={menuProps}
-      viewMode={viewMode}
-      {...props}
-    >
-      {children}
-    </MarkdownEditorContextProvider>
+    <MarkdownEditorContextProvider {...markdownContextValue}>{children(editorRootProps)}</MarkdownEditorContextProvider>
   );
 };
 
-MarkdownEditorRoot.displayName = 'MarkdownEditor.Root';
+MarkdownEditorProvider.displayName = 'MarkdownEditor.Provider';
 
 //
-// MarkdownEditor.Main
+// MarkdownEditor.Content
 //
 
+const MARKDOWN_EDITOR_CONTENT_NAME = 'MarkdownEditor.Content';
+
 type MarkdownEditorContentProps = Omit<NaturalMarkdownEditorContentProps, 'id' | 'extensions' | 'toolbarState'>;
 
-const MarkdownEditorContent = (props: MarkdownEditorContentProps) => {
-  const {
-    id,
-    editorView,
-    setEditorView,
-    viewMode,
-    toolbarState,
-    extensions,
-    popoverMenu: { groupsRef, ...menuProps },
-  } = useMarkdownEditorContext(MarkdownEditorContent.displayName);
+const MarkdownEditorContent = composable<HTMLDivElement, MarkdownEditorContentProps>(({ ...props }, _forwardedRef) => {
+  const { id, attendableId, compact, viewMode, onFileUpload } = useMarkdownEditorContext(MARKDOWN_EDITOR_CONTENT_NAME);
+
+  const { extensions, setController, state } = useEditorContext(MARKDOWN_EDITOR_CONTENT_NAME);
+
+  const handleRef = useCallback(
+    (view: EditorView | null) => {
+      setController(createEditorController(view));
+    },
+    [setController],
+  );
 
   return (
-    <EditorMenuProvider view={editorView} groups={groupsRef.current} {...menuProps}>
-      <NaturalMarkdownEditorContent
-        {...props}
-        id={id}
-        viewMode={viewMode}
-        toolbarState={toolbarState}
-        extensions={extensions}
-        ref={setEditorView}
-      />
-    </EditorMenuProvider>
+    <NaturalMarkdownEditorContent
+      {...composableProps(props)}
+      id={id}
+      attendableId={attendableId}
+      compact={compact}
+      viewMode={viewMode}
+      toolbarState={state as Atom.Writable<EditorToolbarState>}
+      extensions={extensions}
+      onFileUpload={onFileUpload}
+      ref={handleRef}
+    />
   );
-};
+});
 
-MarkdownEditorContent.displayName = 'MarkdownEditor.Content';
+MarkdownEditorContent.displayName = MARKDOWN_EDITOR_CONTENT_NAME;
 
 //
 // MarkdownEditor.Toolbar
 //
 
-type MarkdownEditorToolbarProps = Omit<
-  NaturalMarkdownToolbarProps,
-  'state' | 'editorView' | 'onAction' | 'onFileUpload' | 'onViewModeChange'
+const MARKDOWN_EDITOR_TOOLBAR_NAME = 'MarkdownEditor.Toolbar';
+
+type MarkdownEditorToolbarProps = ThemedClassName<
+  Omit<NaturalMarkdownToolbarProps, 'state' | 'editorView' | 'onAction' | 'onFileUpload' | 'onViewModeChange' | 'id'>
 >;
 
 const MarkdownEditorToolbar = (props: MarkdownEditorToolbarProps) => {
-  const { toolbarState, ...rootProps } = useMarkdownEditorContext(MarkdownEditorToolbar.displayName);
+  const { id, attendableId, onAction, onFileUpload, onViewModeChange } =
+    useMarkdownEditorContext(MARKDOWN_EDITOR_TOOLBAR_NAME);
+
+  const { controller, state } = useEditorContext(MARKDOWN_EDITOR_TOOLBAR_NAME);
 
-  return <NaturalMarkdownToolbar {...props} {...rootProps} state={toolbarState} />;
+  return (
+    <NaturalMarkdownToolbar
+      {...props}
+      id={attendableId ?? id}
+      editorView={controller?.view ?? undefined}
+      state={state}
+      onAction={onAction}
+      onFileUpload={onFileUpload}
+      onViewModeChange={onViewModeChange}
+    />
+  );
 };
 
-MarkdownEditorToolbar.displayName = 'MarkdownEditor.Toolbar';
+MarkdownEditorToolbar.displayName = MARKDOWN_EDITOR_TOOLBAR_NAME;
 
 //
 // MarkdownEditor.Blocks (embedded objects)
 //
 
+const MARKDOWN_EDITOR_BLOCKS_NAME = 'MarkdownEditor.Blocks';
+
 type MarkdownEditorBlocksProps = {};
 
 const MarkdownEditorBlocks = (_props: MarkdownEditorBlocksProps) => {
-  const { previewBlocks } = useMarkdownEditorContext(MarkdownEditorBlocks.displayName);
+  const { previewBlocks } = useMarkdownEditorContext(MARKDOWN_EDITOR_BLOCKS_NAME);
 
   return (
     <>
       {previewBlocks.map(({ link, el }) => (
-        <PreviewBlock key={link.ref} link={link} el={el} />
+        <PreviewBlock key={link.dxn} link={link} el={el} />
       ))}
     </>
   );
 };
 
-MarkdownEditorBlocks.displayName = 'MarkdownEditor.Blocks';
+MarkdownEditorBlocks.displayName = MARKDOWN_EDITOR_BLOCKS_NAME;
 
 const PreviewBlock = ({ el, link }: PreviewBlock) => {
   const client = useClient();
-  const dxn = DXN.parse(link.ref);
+  const dxn = DXN.parse(link.dxn);
   const subject = client.graph.makeRef(dxn).target;
   const data = useMemo(() => ({ subject }), [subject]);
 
-  return createPortal(<Surface role='card--transclusion' data={data} limit={1} />, el);
+  return createPortal(<Surface.Surface role='card--content' data={data} limit={1} />, el);
 };
 
 //
 // MarkdownEditor
 //
 
+/** @private */
 export const MarkdownEditor = {
-  Root: MarkdownEditorRoot,
   Content: MarkdownEditorContent,
   Toolbar: MarkdownEditorToolbar,
   Blocks: MarkdownEditorBlocks,
 };
 
-export type {
-  MarkdownEditorRootProps,
-  MarkdownEditorContentProps,
-  MarkdownEditorToolbarProps,
-  MarkdownEditorBlocksProps,
-};
+export type { MarkdownEditorContentProps, MarkdownEditorToolbarProps, MarkdownEditorBlocksProps };
+
+/** @deprecated Use `MarkdownEditorProviderProps`. */
+export type MarkdownEditorRootProps = MarkdownEditorProviderProps;

package/src/components/MarkdownEditor/MarkdownEditorContent.tsx

@@ -6,6 +6,7 @@ import { type EditorView } from '@codemirror/view';
 import { type Atom, RegistryContext } from '@effect-atom/atom-react';
 import React, { forwardRef, useCallback, useContext, useEffect, useImperativeHandle, useMemo } from 'react';
 
+import { useCapabilities } from '@dxos/app-framework/ui';
 import { type ThemedClassName, useThemeContext, useTranslation } from '@dxos/react-ui';
 import {
   type EditorMenuGroup,
@@ -18,51 +19,54 @@ import {
   type EditorStateStore,
   type EditorViewMode,
   type ThemeExtensionsOptions,
+  compactSlots,
   createBasicExtensions,
   createMarkdownExtensions,
   createThemeExtensions,
   dropFile,
-  editorSlots,
+  documentSlots,
   formattingListener,
   processEditorPayload,
-  stackItemContentEditorClassNames,
+  editorClassNames,
 } from '@dxos/ui-editor';
 import { mx } from '@dxos/ui-theme';
 import { isTruthy } from '@dxos/util';
 
-import { useSelectCurrentThread } from '../../hooks';
-import { meta } from '../../meta';
+import { meta } from '#meta';
+import { MarkdownCapabilities } from '#types';
 
 import { type MarkdownEditorToolbarProps } from './MarkdownEditorToolbar';
 
 export type MarkdownEditorContentProps = ThemedClassName<{
   id: string;
+  attendableId?: string;
   role?: string;
+  compact?: boolean;
   viewMode?: EditorViewMode;
-  scrollPastEnd?: boolean;
   slashCommandGroups?: EditorMenuGroup[];
   editorStateStore?: EditorStateStore;
   toolbarState?: Atom.Writable<EditorToolbarState>;
   onLinkQuery?: (query?: string) => Promise<EditorMenuGroup[]>;
 }> &
-  // prettier-ignore
   Pick<UseTextEditorProps, 'initialValue' | 'extensions'> &
   Pick<MarkdownEditorToolbarProps, 'onFileUpload'> &
   Pick<ThemeExtensionsOptions, 'slots'>;
 
+// TODO(burdon): Move controller to Root.
 export const MarkdownEditorContent = forwardRef<EditorView | null, MarkdownEditorContentProps>(
   (
     {
       classNames,
       id,
+      attendableId,
       role,
+      compact,
       viewMode,
       initialValue,
       editorStateStore,
       toolbarState,
       extensions,
-      scrollPastEnd,
-      slots = editorSlots,
+      slots,
       onFileUpload,
     },
     forwardedRef,
@@ -94,21 +98,19 @@ export const MarkdownEditorContent = forwardRef<EditorView | null, MarkdownEdito
           id,
           scrollTo,
           selection,
-          // TODO(wittjosiah): Autofocus based on layout is racy.
-          // autoFocus: layoutPlugin?.provides.layout ? layoutPlugin?.provides.layout.scrollIntoView === id : true,
           selectionEnd: true,
         }),
         initialValue,
         extensions: [
           createBasicExtensions({
             readOnly: viewMode === 'readonly',
-            placeholder: t('editor placeholder'),
-            scrollPastEnd: scrollPastEnd && role !== 'section',
+            placeholder: t('editor.placeholder'),
+            scrollPastEnd: !compact,
             search: true,
           }),
           createThemeExtensions({
             themeMode,
-            slots,
+            slots: slots ?? (compact ? compactSlots : documentSlots),
             syntaxHighlighting: true,
           }),
           createMarkdownExtensions(),
@@ -133,18 +135,24 @@ export const MarkdownEditorContent = forwardRef<EditorView | null, MarkdownEdito
 
     useImperativeHandle<EditorView | null, EditorView | null>(forwardedRef, () => editorView, [editorView]);
 
-    useSelectCurrentThread(editorView, id);
+    const [editorViewRegistry] = useCapabilities(MarkdownCapabilities.EditorViews);
+    useEffect(() => {
+      if (editorView && editorViewRegistry) {
+        editorViewRegistry.register(attendableId ?? id, editorView, id);
+        return () => editorViewRegistry.unregister(attendableId ?? id);
+      }
+    }, [editorView, editorViewRegistry, attendableId, id]);
 
     useTest(editorView);
 
     return (
       <div
+        {...focusAttributes}
+        className={mx(editorClassNames(role), classNames)}
         role='none'
-        ref={parentRef}
         data-testid='composer.markdownRoot'
-        className={mx(stackItemContentEditorClassNames(role), classNames)}
         data-popover-collision-boundary={true}
-        {...focusAttributes}
+        ref={parentRef}
       />
     );
   },

package/src/components/MarkdownEditor/MarkdownEditorToolbar.tsx

@@ -5,62 +5,54 @@
 import { type EditorView } from '@codemirror/view';
 import React, { useCallback, useState } from 'react';
 
-import { type Common } from '@dxos/app-framework';
+import { type FileInfo } from '@dxos/app-toolkit';
 import { invariant } from '@dxos/invariant';
-import { type ThemedClassName } from '@dxos/react-ui';
 import { EditorToolbar, type EditorToolbarProps } from '@dxos/react-ui-editor';
-import { type EditorViewMode } from '@dxos/ui-editor';
+import { composable, composableProps } from '@dxos/ui-theme';
 
 import { FileUpload, type FileUploadAction } from './FileUpload';
 
-export type MarkdownEditorToolbarProps = ThemedClassName<
-  {
-    id: string;
-    editorView?: EditorView;
-    onFileUpload?: (file: File) => Promise<Common.FileInfo | undefined>;
-  } & Pick<EditorToolbarProps, 'role' | 'state' | 'customActions' | 'onAction' | 'onViewModeChange'>
->;
-
-export const MarkdownEditorToolbar = ({
-  classNames,
-  id,
-  role,
-  state,
-  editorView,
-  customActions,
-  onAction,
-  onFileUpload,
-  onViewModeChange,
-}: MarkdownEditorToolbarProps) => {
-  const [upload, setUpload] = useState<FileUploadAction | null>(null);
-  const uploadRef = useCallback((next: FileUploadAction) => setUpload(() => next), []);
-
-  const handleViewModeChange = useCallback((mode: EditorViewMode) => onViewModeChange?.(mode), [onViewModeChange]);
-
-  const getView = useCallback(() => {
-    invariant(editorView);
-    return editorView;
-  }, [editorView]);
-
-  if (!editorView) {
-    return <div />;
-  }
-
-  return (
-    <>
-      <EditorToolbar
-        classNames={classNames}
-        attendableId={id}
-        role={role}
-        state={state}
-        customActions={customActions}
-        getView={getView}
-        onAction={onAction}
-        onImageUpload={upload ?? undefined}
-        onViewModeChange={handleViewModeChange}
-      />
-
-      {onFileUpload && <FileUpload ref={uploadRef} editorView={editorView} onFileUpload={onFileUpload} />}
-    </>
-  );
-};
+export type MarkdownEditorToolbarProps = {
+  id: string;
+  editorView?: EditorView;
+  onFileUpload?: (file: File) => Promise<FileInfo | undefined>;
+} & Pick<EditorToolbarProps, 'role' | 'state' | 'customActions' | 'onAction' | 'onViewModeChange'>;
+
+export const MarkdownEditorToolbar = composable<HTMLDivElement, MarkdownEditorToolbarProps>(
+  (
+    { id, role, state, editorView, customActions, onAction, onFileUpload, onViewModeChange, ...props },
+    forwardedRef,
+  ) => {
+    const { className, ...rest } = composableProps(props);
+    const [upload, setUpload] = useState<FileUploadAction | null>(null);
+    const uploadRef = useCallback((next: FileUploadAction) => setUpload(() => next), []);
+
+    const getView = useCallback(() => {
+      invariant(editorView);
+      return editorView;
+    }, [editorView]);
+
+    if (!editorView) {
+      return <div className={className} {...rest} ref={forwardedRef} />;
+    }
+
+    return (
+      <div role='none' className='contents' ref={forwardedRef}>
+        <EditorToolbar
+          {...rest}
+          classNames={className}
+          attendableId={id}
+          role={role}
+          state={state}
+          customActions={customActions}
+          getView={getView}
+          onAction={onAction}
+          onImageUpload={upload ?? undefined}
+          onViewModeChange={onViewModeChange}
+        />
+
+        {onFileUpload && <FileUpload ref={uploadRef} editorView={editorView} onFileUpload={onFileUpload} />}
+      </div>
+    );
+  },
+);

package/src/components/MarkdownSettings/MarkdownSettings.stories.tsx

@@ -0,0 +1,39 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+
+import { translations } from '../../translations';
+import { MarkdownSettings } from './MarkdownSettings';
+
+const meta = {
+  title: 'plugins/plugin-markdown/components/MarkdownSettings',
+  tags: ['settings'],
+  component: MarkdownSettings,
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof MarkdownSettings>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    settings: {
+      defaultViewMode: 'preview',
+      editorInputMode: 'default',
+      toolbar: true,
+      numberedHeadings: false,
+      folding: false,
+      experimental: false,
+      debug: false,
+    },
+  },
+};