@dxos/plugin-markdown 0.8.4-main.f9ba587 → 0.8.4-main.fcfe5033a5

package/src/components/MarkdownEditor/MarkdownEditorContent.tsx

@@ -0,0 +1,170 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+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,
+  type EditorToolbarState,
+  type UseTextEditorProps,
+  useTextEditor,
+} from '@dxos/react-ui-editor';
+import {
+  type EditorSelectionState,
+  type EditorStateStore,
+  type EditorViewMode,
+  type ThemeExtensionsOptions,
+  mobileSlots,
+  createBasicExtensions,
+  createMarkdownExtensions,
+  createThemeExtensions,
+  dropFile,
+  documentSlots,
+  formattingListener,
+  processEditorPayload,
+  editorClassNames,
+} from '@dxos/ui-editor';
+import { mx } from '@dxos/ui-theme';
+import { isTruthy } from '@dxos/util';
+
+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;
+  slashCommandGroups?: EditorMenuGroup[];
+  editorStateStore?: EditorStateStore;
+  toolbarState?: Atom.Writable<EditorToolbarState>;
+  onLinkQuery?: (query?: string) => Promise<EditorMenuGroup[]>;
+}> &
+  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,
+      slots,
+      onFileUpload,
+    },
+    forwardedRef,
+  ) => {
+    const { t } = useTranslation(meta.id);
+    const { themeMode } = useThemeContext();
+    const registry = useContext(RegistryContext);
+
+    // Callback to update toolbar state atom.
+    const updateToolbarState = useCallback(
+      (formatting: EditorToolbarState) => {
+        if (toolbarState) {
+          registry.set(toolbarState, { ...registry.get(toolbarState), ...formatting });
+        }
+      },
+      [registry, toolbarState],
+    );
+
+    // Restore last selection and scroll point.
+    const { scrollTo, selection } = useMemo<EditorSelectionState>(() => editorStateStore?.getState(id) ?? {}, [id]);
+
+    const {
+      parentRef,
+      view: editorView,
+      focusAttributes,
+    } = useTextEditor(
+      () => ({
+        ...(role !== 'section' && {
+          id,
+          scrollTo,
+          selection,
+          selectionEnd: true,
+        }),
+        initialValue,
+        extensions: [
+          createBasicExtensions({
+            readOnly: viewMode === 'readonly',
+            placeholder: t('editor.placeholder'),
+            scrollPastEnd: !compact,
+            search: true,
+          }),
+          createThemeExtensions({
+            themeMode,
+            slots: slots ?? (compact ? mobileSlots : documentSlots),
+            syntaxHighlighting: true,
+          }),
+          createMarkdownExtensions(),
+          toolbarState && formattingListener(updateToolbarState),
+          role !== 'section' &&
+            onFileUpload &&
+            dropFile({
+              // TODO(wittjosiah): Factor out to file uploader plugin.
+              onDrop: async (view, { files }) => {
+                const file = files[0];
+                const info = file && onFileUpload ? await onFileUpload(file) : undefined;
+                if (info) {
+                  processEditorPayload(view, { type: 'image', data: info.url });
+                }
+              },
+            }),
+          extensions,
+        ].filter(isTruthy),
+      }),
+      [id, viewMode, themeMode, extensions],
+    );
+
+    useImperativeHandle<EditorView | null, EditorView | null>(forwardedRef, () => editorView, [editorView]);
+
+    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'
+        data-testid='composer.markdownRoot'
+        data-popover-collision-boundary={true}
+        ref={parentRef}
+      />
+    );
+  },
+);
+
+// Expose editor view for playwright tests.
+// TODO(wittjosiah): Find a better way to expose this or find a way to limit it to test runs.
+const useTest = (view: EditorView | null) => {
+  useEffect(() => {
+    const composer = (window as any).composer;
+    if (composer) {
+      composer.editorView = view;
+    }
+  }, [view]);
+};

package/src/components/MarkdownEditor/MarkdownEditorToolbar.tsx

@@ -0,0 +1,47 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type EditorView } from '@codemirror/view';
+import React, { useCallback, useState } from 'react';
+
+import { type FileInfo } from '@dxos/app-toolkit';
+import { Editor, type EditorToolbarProps } from '@dxos/react-ui-editor';
+import { composable, composableProps } from '@dxos/ui-theme';
+
+import { FileUpload, type FileUploadAction } from './FileUpload';
+
+export type MarkdownEditorToolbarProps = {
+  id: string;
+  editorView?: EditorView;
+  onFileUpload?: (file: File) => Promise<FileInfo | undefined>;
+} & Pick<EditorToolbarProps, 'role' | 'customActions' | 'onAction' | 'onViewModeChange'>;
+
+export const MarkdownEditorToolbar = composable<HTMLDivElement, MarkdownEditorToolbarProps>(
+  ({ id, role, 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), []);
+
+    if (!editorView) {
+      return <div className={className} {...rest} ref={forwardedRef} />;
+    }
+
+    return (
+      <div role='none' className='contents' ref={forwardedRef}>
+        <Editor.Toolbar
+          {...rest}
+          classNames={className}
+          attendableId={id}
+          role={role}
+          customActions={customActions}
+          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,
+    },
+  },
+};

package/src/components/MarkdownSettings/MarkdownSettings.tsx

@@ -4,102 +4,32 @@
 
 import React from 'react';
 
-import { Input, Select, useTranslation } from '@dxos/react-ui';
-import { type EditorInputMode, EditorInputModes, type EditorViewMode, EditorViewModes } from '@dxos/react-ui-editor';
-import { DeprecatedFormContainer, DeprecatedFormInput } from '@dxos/react-ui-form';
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { Input } from '@dxos/react-ui';
+import { Settings as SettingsForm, type SettingsFieldProps } from '@dxos/react-ui-form';
 
-import { MARKDOWN_PLUGIN } from '../../meta';
-import { type MarkdownSettingsProps } from '../../types';
+import { meta } from '#meta';
+import { Markdown } from '#types';
 
-export const MarkdownSettings = ({ settings }: { settings: MarkdownSettingsProps }) => {
-  const { t } = useTranslation(MARKDOWN_PLUGIN);
+export type MarkdownSettingsProps = AppSurface.SettingsArticleProps<Markdown.Settings>;
 
-  // TODO(wittjosiah): Add skill test confirmation for entering vim mode.
-  return (
-    <DeprecatedFormContainer>
-      <DeprecatedFormInput label={t('default view mode label')}>
-        <Select.Root
-          value={settings.defaultViewMode}
-          onValueChange={(value) => {
-            settings.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.Content>
-          </Select.Portal>
-        </Select.Root>
-      </DeprecatedFormInput>
-
-      <DeprecatedFormInput label={t('editor input mode label')}>
-        <Select.Root
-          value={settings.editorInputMode ?? 'default'}
-          onValueChange={(value) => {
-            settings.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.Content>
-          </Select.Portal>
-        </Select.Root>
-      </DeprecatedFormInput>
-
-      <DeprecatedFormInput label={t('settings toolbar label')}>
-        <Input.Switch checked={settings.toolbar} onCheckedChange={(checked) => (settings.toolbar = !!checked)} />
-      </DeprecatedFormInput>
-
-      <DeprecatedFormInput label={t('settings numbered headings label')}>
-        <Input.Switch
-          checked={settings.numberedHeadings}
-          onCheckedChange={(checked) => (settings.numberedHeadings = !!checked)}
-        />
-      </DeprecatedFormInput>
-
-      <DeprecatedFormInput label={t('settings folding label')}>
-        <Input.Switch checked={settings.folding} onCheckedChange={(checked) => (settings.folding = !!checked)} />
-      </DeprecatedFormInput>
+const TypewriterField = ({ value, onChange, readonly }: SettingsFieldProps<string>) => (
+  <Input.TextArea disabled={readonly} rows={5} value={value ?? ''} onChange={(event) => onChange(event.target.value)} />
+);
 
-      <DeprecatedFormInput label={t('settings experimental label')}>
-        <Input.Switch
-          checked={settings.experimental}
-          onCheckedChange={(checked) => (settings.experimental = !!checked)}
+export const MarkdownSettings = ({ settings, onSettingsChange }: MarkdownSettingsProps) => {
+  return (
+    <SettingsForm.Viewport>
+      <SettingsForm.Section title={meta.name ?? 'Editor'}>
+        <SettingsForm.FieldSet
+          readonly={!onSettingsChange}
+          schema={Markdown.Settings}
+          visible={(path, values) => path !== 'typewriter' || !!values.debug}
+          fieldMap={{ typewriter: TypewriterField }}
+          values={settings}
+          onValuesChanged={(values) => onSettingsChange?.(() => values)}
         />
-      </DeprecatedFormInput>
-
-      <DeprecatedFormInput
-        label={t('settings debug label')}
-        secondary={
-          settings.debug ? (
-            <Input.Root>
-              <Input.TextArea
-                rows={5}
-                value={settings.typewriter}
-                onChange={({ target: { value } }) => (settings.typewriter = value)}
-                placeholder={t('settings debug placeholder')}
-              />
-            </Input.Root>
-          ) : undefined
-        }
-      >
-        <Input.Switch checked={settings.debug} onCheckedChange={(checked) => (settings.debug = !!checked)} />
-      </DeprecatedFormInput>
-    </DeprecatedFormContainer>
+      </SettingsForm.Section>
+    </SettingsForm.Viewport>
   );
 };

package/src/components/MarkdownSettings/index.ts

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

package/src/components/index.ts

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

package/src/containers/MarkdownCard/MarkdownCard.stories.tsx

@@ -0,0 +1,67 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useMemo } from 'react';
+
+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 { random } from '@dxos/random';
+import { Card } from '@dxos/react-ui';
+import { CardContainer } from '@dxos/react-ui-mosaic/testing';
+import { withTheme } from '@dxos/react-ui/testing';
+
+import { translations } from '../../translations';
+import { MarkdownCard, type MarkdownCardProps } from './MarkdownCard';
+
+random.seed(1234);
+
+const MarkdownCardStory = ({ ...args }: Omit<MarkdownCardProps, 'subject'>) => {
+  const subject = useMemo(
+    () =>
+      Markdown.make({
+        name: random.lorem.words(3),
+        content: '# Title\n' + random.lorem.paragraphs(5),
+      }),
+    [],
+  );
+
+  return (
+    <CardContainer icon='ph--text-aa--regular'>
+      <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/containers/MarkdownCard',
+  component: MarkdownCardStory,
+  decorators: [
+    withTheme(),
+    withPluginManager({
+      plugins: [OperationPlugin(), RuntimePlugin(), ClientPlugin({})],
+    }),
+  ],
+  parameters: {
+    layout: 'centered',
+    translations,
+  },
+  tags: ['cards'],
+};
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};

package/src/containers/MarkdownCard/MarkdownCard.tsx

@@ -0,0 +1,68 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { useMemo } from 'react';
+
+import { Obj } from '@dxos/echo';
+import { Card, useTranslation } from '@dxos/react-ui';
+import { Editor } from '@dxos/react-ui-editor';
+import { Text } from '@dxos/schema';
+import { mx } from '@dxos/ui-theme';
+
+import { MarkdownEditor, MarkdownEditorProvider } from '#components';
+import { meta } from '#meta';
+import { Markdown } from '#types';
+
+import { getContentSnippet } from '../../util';
+import { snippet as snippetExtension } from './snippet';
+
+export type MarkdownCardProps = { subject: Markdown.Document | Text.Text };
+
+export const MarkdownCard = ({ subject }: MarkdownCardProps) => {
+  const { t } = useTranslation(meta.id);
+  const snippet = useMemo(() => getSnippet(subject), [subject]);
+  const extensions = useMemo(() => [snippetExtension({ height: 300, scale: 0.8 })], []);
+  const info = getInfo(subject);
+
+  return (
+    <Card.Content>
+      {snippet && (
+        <Card.Section className='relative px-1'>
+          <MarkdownEditorProvider id={subject.id} viewMode='readonly' extensions={extensions}>
+            {(editorRootProps) => (
+              <Editor.Root {...editorRootProps}>
+                <MarkdownEditor.Content initialValue={snippet} slots={{ content: { className: 'm-0' } }} />
+              </Editor.Root>
+            )}
+          </MarkdownEditorProvider>
+          <div
+            role='none'
+            className={mx(
+              'z-10 absolute bottom-0 inset-x-0 h-12 w-full',
+              'bg-gradient-to-b from-transparent to-(--surface-bg) pointer-events-none',
+            )}
+          />
+        </Card.Section>
+      )}
+      <Card.Section>
+        <Card.Text classNames='px-1.5 text-xs text-description'>
+          {info.words} {t('words.label', { count: info.words })}
+        </Card.Text>
+      </Card.Section>
+    </Card.Content>
+  );
+};
+
+const getSnippet = (subject: Markdown.Document | Text.Text, fallback?: string, maxLines = 16) => {
+  if (Obj.instanceOf(Markdown.Document, subject)) {
+    return Obj.getDescription(subject) || getContentSnippet(subject.content?.target?.content ?? fallback, maxLines);
+  } else if (Obj.instanceOf(Text.Text, subject)) {
+    return getContentSnippet(subject.content ?? fallback, maxLines);
+  }
+};
+
+const getInfo = (subject: Markdown.Document | Text.Text) => {
+  const text = (Obj.instanceOf(Markdown.Document, subject) ? subject.content?.target?.content : subject.content) ?? '';
+  return { words: text.split(' ').length };
+};

package/src/containers/MarkdownCard/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { MarkdownCard as default } from './MarkdownCard';

package/src/containers/MarkdownCard/snippet.ts

@@ -0,0 +1,52 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { EditorState } from '@codemirror/state';
+import { EditorView } from '@codemirror/view';
+
+export type SnippetOptions = {
+  /** Maximum height of the editor in pixels. Overflowing content is hidden. */
+  height: number;
+  /** Zoom factor applied to the editor (e.g. 0.5 renders at 50%). @default 1 */
+  scale?: number;
+};
+
+/**
+ * CodeMirror extension for rendering a non-scrollable snippet of editor content.
+ * Constrains the editor to the given height via CSS `max-height`, wraps long
+ * lines (`pre-wrap`), and disables scrolling entirely.
+ *
+ * NOTE: Uses CSS `zoom` rather than `transform: scale` because `zoom` affects
+ * layout, so line wrapping fills the full visual width of the container.
+ * `transform: scale` only scales paint output, leaving empty space on the right.
+ */
+export const snippet = ({ height, scale = 1 }: SnippetOptions) => {
+  return [
+    EditorState.readOnly.of(true),
+    EditorView.editable.of(false),
+    EditorState.transactionFilter.of((tr) => {
+      if (tr.selection) return []; // Drop any selection changes.
+      return tr;
+    }),
+    EditorView.theme({
+      // Outer editor element: clip to the caller-specified height.
+      '&': {
+        maxHeight: `${height}px`,
+        overflow: 'hidden',
+      },
+      '.cm-scroller': {
+        // Prevent scroll; scale up the inner clip so the final pixel height matches `height`.
+        maxHeight: `${height / scale}px`,
+        overflow: 'hidden !important',
+        padding: '0',
+      },
+      '.cm-content': {
+        // zoom (unlike transform: scale) affects layout, so line-wrapping fills the full visual width of the container.
+        zoom: scale,
+        margin: '0',
+        padding: '0',
+      },
+    }),
+  ];
+};