@dxos/plugin-markdown 0.8.4-main.bc674ce → 0.8.4-main.bcb3aa67d6

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,34 +19,35 @@ 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'>;
@@ -55,14 +57,15 @@ export const MarkdownEditorContent = forwardRef<EditorView | null, MarkdownEdito
     {
       classNames,
       id,
+      attendableId,
       role,
+      compact,
       viewMode,
       initialValue,
       editorStateStore,
       toolbarState,
       extensions,
-      scrollPastEnd,
-      slots = editorSlots,
+      slots,
       onFileUpload,
     },
     forwardedRef,
@@ -94,21 +97,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 +134,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 { 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} />}
-    </>
-  );
-};
+import { composable, composableProps } from '@dxos/ui-theme';
+
+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,40 @@
+//
+// 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,
+    },
+  },
+};

package/src/components/MarkdownSettings/MarkdownSettings.tsx

@@ -4,119 +4,135 @@
 
 import React from 'react';
 
+import { type SettingsSurfaceProps } from '@dxos/app-toolkit/ui';
 import { Input, Select, useTranslation } from '@dxos/react-ui';
-import { ControlGroup, ControlItemInput, ControlPage, ControlSection } from '@dxos/react-ui-form';
+import { Settings as SettingsForm } from '@dxos/react-ui-form';
 import { type EditorInputMode, EditorInputModes, type EditorViewMode, EditorViewModes } from '@dxos/ui-editor';
 
-import { meta } from '../../meta';
-import { type Markdown } from '../../types';
+import { meta } from '#meta';
+import { type Markdown } from '#types';
 
-export type MarkdownSettingsComponentProps = {
-  settings: Markdown.Settings;
-  onSettingsChange: (fn: (current: Markdown.Settings) => Markdown.Settings) => void;
-};
+export type MarkdownSettingsProps = SettingsSurfaceProps<Markdown.Settings>;
 
-export const MarkdownSettings = ({ settings, onSettingsChange }: MarkdownSettingsComponentProps) => {
+export const MarkdownSettings = ({ settings, onSettingsChange }: MarkdownSettingsProps) => {
   const { t } = useTranslation(meta.id);
 
   // TODO(wittjosiah): Add skill test confirmation for entering vim mode.
   return (
-    <ControlPage>
-      <ControlSection title={t('settings title', { ns: meta.id })}>
-        <ControlGroup>
-          <ControlItemInput title={t('default view mode label')}>
-            <Select.Root
-              value={settings.defaultViewMode}
-              onValueChange={(value) => {
-                onSettingsChange((s) => ({ ...s, defaultViewMode: value as EditorViewMode }));
-              }}
-            >
-              <Select.TriggerButton />
-              <Select.Portal>
-                <Select.Content>
-                  <Select.Viewport>
-                    {EditorViewModes.map((mode) => (
-                      <Select.Option key={mode} value={mode}>
-                        {t(`${mode} mode label`, { ns: 'react-ui-editor' })}
-                      </Select.Option>
-                    ))}
-                  </Select.Viewport>
-                  <Select.Arrow />
-                </Select.Content>
-              </Select.Portal>
-            </Select.Root>
-          </ControlItemInput>
-
-          <ControlItemInput title={t('editor input mode label')}>
-            <Select.Root
-              value={settings.editorInputMode ?? 'default'}
-              onValueChange={(value) => {
-                onSettingsChange((s) => ({ ...s, editorInputMode: value as EditorInputMode }));
-              }}
-            >
-              <Select.TriggerButton placeholder={t('select editor input mode placeholder')} />
-              <Select.Portal>
-                <Select.Content>
-                  <Select.Viewport>
-                    {EditorInputModes.map((mode) => (
-                      <Select.Option key={mode} value={mode}>
-                        {t(`settings editor input mode ${mode} label`)}
-                      </Select.Option>
-                    ))}
-                  </Select.Viewport>
-                  <Select.Arrow />
-                </Select.Content>
-              </Select.Portal>
-            </Select.Root>
-          </ControlItemInput>
+    <SettingsForm.Viewport>
+      <SettingsForm.Section title={t('settings.title', { ns: meta.id })}>
+        <SettingsForm.Item title={t('default-view-mode.label')} description={t('default-view-mode.description')}>
+          <Select.Root
+            disabled={!onSettingsChange}
+            value={settings.defaultViewMode}
+            onValueChange={(value) => {
+              onSettingsChange?.((s) => ({ ...s, defaultViewMode: value as EditorViewMode }));
+            }}
+          >
+            <Select.TriggerButton disabled={!onSettingsChange} />
+            <Select.Portal>
+              <Select.Content>
+                <Select.Viewport>
+                  {EditorViewModes.map((mode) => (
+                    <Select.Option key={mode} value={mode}>
+                      {t(`view-mode.${mode}.label`, { ns: '@dxos/react-ui-editor' })}
+                    </Select.Option>
+                  ))}
+                </Select.Viewport>
+                <Select.Arrow />
+              </Select.Content>
+            </Select.Portal>
+          </Select.Root>
+        </SettingsForm.Item>
 
-          <ControlItemInput title={t('settings toolbar label')}>
-            <Input.Switch
-              checked={settings.toolbar}
-              onCheckedChange={(checked) => onSettingsChange((s) => ({ ...s, toolbar: !!checked }))}
+        <SettingsForm.Item title={t('editor-input-mode.label')} description={t('editor-input-mode.description')}>
+          <Select.Root
+            disabled={!onSettingsChange}
+            value={settings.editorInputMode ?? 'default'}
+            onValueChange={(value) => {
+              onSettingsChange?.((s) => ({ ...s, editorInputMode: value as EditorInputMode }));
+            }}
+          >
+            <Select.TriggerButton
+              disabled={!onSettingsChange}
+              placeholder={t('select-editor-input-mode.placeholder')}
             />
-          </ControlItemInput>
+            <Select.Portal>
+              <Select.Content>
+                <Select.Viewport>
+                  {EditorInputModes.map((mode) => (
+                    <Select.Option key={mode} value={mode}>
+                      {t(`settings.editor-input-mode.${mode}.label`)}
+                    </Select.Option>
+                  ))}
+                </Select.Viewport>
+                <Select.Arrow />
+              </Select.Content>
+            </Select.Portal>
+          </Select.Root>
+        </SettingsForm.Item>
 
-          <ControlItemInput title={t('settings numbered headings label')}>
-            <Input.Switch
-              checked={settings.numberedHeadings}
-              onCheckedChange={(checked) => onSettingsChange((s) => ({ ...s, numberedHeadings: !!checked }))}
-            />
-          </ControlItemInput>
+        <SettingsForm.Item title={t('settings.toolbar.label')} description={t('settings.toolbar.description')}>
+          <Input.Switch
+            disabled={!onSettingsChange}
+            checked={settings.toolbar}
+            onCheckedChange={(checked) => onSettingsChange?.((s) => ({ ...s, toolbar: !!checked }))}
+          />
+        </SettingsForm.Item>
 
-          <ControlItemInput title={t('settings folding label')}>
-            <Input.Switch
-              checked={settings.folding}
-              onCheckedChange={(checked) => onSettingsChange((s) => ({ ...s, folding: !!checked }))}
-            />
-          </ControlItemInput>
+        <SettingsForm.Item
+          title={t('settings.numbered-headings.label')}
+          description={t('settings.numbered-headings.description')}
+        >
+          <Input.Switch
+            disabled={!onSettingsChange}
+            checked={settings.numberedHeadings}
+            onCheckedChange={(checked) => onSettingsChange?.((s) => ({ ...s, numberedHeadings: !!checked }))}
+          />
+        </SettingsForm.Item>
 
-          <ControlItemInput title={t('settings experimental label')}>
-            <Input.Switch
-              checked={settings.experimental}
-              onCheckedChange={(checked) => onSettingsChange((s) => ({ ...s, experimental: !!checked }))}
-            />
-          </ControlItemInput>
+        <SettingsForm.Item title={t('settings.folding.label')} description={t('settings.folding.description')}>
+          <Input.Switch
+            disabled={!onSettingsChange}
+            checked={settings.folding}
+            onCheckedChange={(checked) => onSettingsChange?.((s) => ({ ...s, folding: !!checked }))}
+          />
+        </SettingsForm.Item>
 
-          <ControlItemInput title={t('settings debug label')}>
-            <Input.Switch
-              checked={settings.debug}
-              onCheckedChange={(checked) => onSettingsChange((s) => ({ ...s, debug: !!checked }))}
-            />
-          </ControlItemInput>
+        <SettingsForm.Item
+          title={t('settings.experimental.label')}
+          description={t('settings.experimental.description')}
+        >
+          <Input.Switch
+            disabled={!onSettingsChange}
+            checked={settings.experimental}
+            onCheckedChange={(checked) => onSettingsChange?.((s) => ({ ...s, experimental: !!checked }))}
+          />
+        </SettingsForm.Item>
 
-          {settings.debug && (
-            <ControlItemInput title={t('settings debug textarea label', { ns: meta.id })}>
-              <Input.TextArea
-                rows={5}
-                value={settings.typewriter}
-                onChange={({ target: { value } }) => onSettingsChange((s) => ({ ...s, typewriter: value }))}
-                placeholder={t('settings debug placeholder')}
-              />
-            </ControlItemInput>
-          )}
-        </ControlGroup>
-      </ControlSection>
-    </ControlPage>
+        <SettingsForm.Item title={t('settings.debug.label')} description={t('settings.debug.description')}>
+          <Input.Switch
+            disabled={!onSettingsChange}
+            checked={settings.debug}
+            onCheckedChange={(checked) => onSettingsChange?.((s) => ({ ...s, debug: !!checked }))}
+          />
+        </SettingsForm.Item>
+
+        {settings.debug && (
+          <SettingsForm.Item
+            title={t('settings.debug-typewriter.label', { ns: meta.id })}
+            description={t('settings.debug-typewriter.description')}
+          >
+            <Input.TextArea
+              disabled={!onSettingsChange}
+              rows={5}
+              value={settings.typewriter}
+              onChange={({ target: { value } }) => onSettingsChange?.((s) => ({ ...s, typewriter: value }))}
+              placeholder={t('settings.debug-typewriter.placeholder')}
+            />
+          </SettingsForm.Item>
+        )}
+      </SettingsForm.Section>
+    </SettingsForm.Viewport>
   );
 };

package/src/components/MarkdownSettings/index.ts

@@ -2,4 +2,6 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './MarkdownSettings';
+import { MarkdownSettings } from './MarkdownSettings';
+
+export default MarkdownSettings;

package/src/components/index.ts

@@ -1,17 +1,9 @@
 //
-// Copyright 2023 DXOS.org
+// Copyright 2025 DXOS.org
 //
 
-import { type LazyExoticComponent, lazy } from 'react';
+import { type ComponentType, lazy } from 'react';
 
-import { type MarkdownCard as MarkdownCardType } from './MarkdownCard';
-import { type MarkdownContainer as MarkdownContainerType } from './MarkdownContainer';
+export * from './MarkdownEditor';
 
-export * from './MarkdownCard';
-export * from './MarkdownContainer';
-export * from './MarkdownSettings';
-
-export const MarkdownCard: LazyExoticComponent<typeof MarkdownCardType> = lazy(() => import('./MarkdownCard'));
-export const MarkdownContainer: LazyExoticComponent<typeof MarkdownContainerType> = lazy(
-  () => import('./MarkdownContainer'),
-);
+export const MarkdownSettings: ComponentType<any> = lazy(() => import('./MarkdownSettings'));

package/src/{components → containers}/MarkdownCard/MarkdownCard.stories.tsx

@@ -5,10 +5,13 @@
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useMemo } from 'react';
 
-import { OperationPlugin } from '@dxos/app-framework';
+import { OperationPlugin, RuntimePlugin } from '@dxos/app-framework';
 import { withPluginManager } from '@dxos/app-framework/testing';
+import { Obj } from '@dxos/echo';
+import { ClientPlugin } from '@dxos/plugin-client';
 import { Markdown } from '@dxos/plugin-markdown/types';
 import { faker } from '@dxos/random';
+import { Card } from '@dxos/react-ui';
 import { withTheme } from '@dxos/react-ui/testing';
 import { CardContainer } from '@dxos/react-ui-mosaic/testing';
 
@@ -18,30 +21,37 @@ import { MarkdownCard, type MarkdownCardProps } from './MarkdownCard';
 
 faker.seed(1234);
 
-// TODO(wittjosiah): ECHO objects don't work when passed via Storybook args.
 const MarkdownCardStory = ({ ...args }: Omit<MarkdownCardProps, 'subject'>) => {
   const subject = useMemo(
     () =>
       Markdown.make({
         name: faker.lorem.words(3),
-        content: faker.lorem.paragraphs(3),
+        content: faker.lorem.paragraphs(5),
       }),
     [],
   );
+
   return (
     <CardContainer icon='ph--text-aa--regular'>
-      <MarkdownCard subject={subject} {...args} />
+      <Card.Root border={false}>
+        <Card.Toolbar>
+          <Card.DragHandle />
+          <Card.Title>{Obj.getLabel(subject)}</Card.Title>
+          <Card.Menu />
+        </Card.Toolbar>
+        <MarkdownCard subject={subject} {...args} />
+      </Card.Root>
     </CardContainer>
   );
 };
 
 const meta: Meta<typeof MarkdownCardStory> = {
-  title: 'plugins/plugin-markdown/Card',
+  title: 'plugins/plugin-markdown/containers/MarkdownCard',
   component: MarkdownCardStory,
   decorators: [
-    withTheme,
+    withTheme(),
     withPluginManager({
-      plugins: [OperationPlugin()],
+      plugins: [OperationPlugin(), RuntimePlugin(), ClientPlugin({})],
     }),
   ],
   parameters: {