@dxos/plugin-markdown 0.8.4-main.3eb6e50203 → 0.8.4-main.422d1c7879

package/src/components/MarkdownEditor/MarkdownEditorToolbar.tsx

@@ -6,61 +6,42 @@ import { type EditorView } from '@codemirror/view';
 import React, { useCallback, useState } from 'react';
 
 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 { Editor, type EditorToolbarProps } from '@dxos/react-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<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' | '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,119 +4,32 @@
 
 import React from 'react';
 
-import { Input, Select, useTranslation } from '@dxos/react-ui';
-import { Settings } from '@dxos/react-ui-form';
-import { type EditorInputMode, EditorInputModes, type EditorViewMode, EditorViewModes } from '@dxos/ui-editor';
+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 { meta } from '../../meta';
-import { type Markdown } from '../../types';
+import { meta } from '#meta';
+import { Markdown } from '#types';
 
-export type MarkdownSettingsComponentProps = {
-  settings: Markdown.Settings;
-  onSettingsChange: (fn: (current: Markdown.Settings) => Markdown.Settings) => void;
-};
+export type MarkdownSettingsProps = AppSurface.SettingsArticleProps<Markdown.Settings>;
 
-export const MarkdownSettings = ({ settings, onSettingsChange }: MarkdownSettingsComponentProps) => {
-  const { t } = useTranslation(meta.id);
+const TypewriterField = ({ value, onChange, readonly }: SettingsFieldProps<string>) => (
+  <Input.TextArea disabled={readonly} rows={5} value={value ?? ''} onChange={(event) => onChange(event.target.value)} />
+);
 
-  // TODO(wittjosiah): Add skill test confirmation for entering vim mode.
+export const MarkdownSettings = ({ settings, onSettingsChange }: MarkdownSettingsProps) => {
   return (
-    <Settings.Root>
-      <Settings.Section title={t('settings title', { ns: meta.id })}>
-        <Settings.Group>
-          <Settings.ItemInput 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: '@dxos/react-ui-editor' })}
-                      </Select.Option>
-                    ))}
-                  </Select.Viewport>
-                  <Select.Arrow />
-                </Select.Content>
-              </Select.Portal>
-            </Select.Root>
-          </Settings.ItemInput>
-
-          <Settings.ItemInput 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>
-          </Settings.ItemInput>
-
-          <Settings.ItemInput title={t('settings toolbar label')}>
-            <Input.Switch
-              checked={settings.toolbar}
-              onCheckedChange={(checked) => onSettingsChange((s) => ({ ...s, toolbar: !!checked }))}
-            />
-          </Settings.ItemInput>
-
-          <Settings.ItemInput title={t('settings numbered headings label')}>
-            <Input.Switch
-              checked={settings.numberedHeadings}
-              onCheckedChange={(checked) => onSettingsChange((s) => ({ ...s, numberedHeadings: !!checked }))}
-            />
-          </Settings.ItemInput>
-
-          <Settings.ItemInput title={t('settings folding label')}>
-            <Input.Switch
-              checked={settings.folding}
-              onCheckedChange={(checked) => onSettingsChange((s) => ({ ...s, folding: !!checked }))}
-            />
-          </Settings.ItemInput>
-
-          <Settings.ItemInput title={t('settings experimental label')}>
-            <Input.Switch
-              checked={settings.experimental}
-              onCheckedChange={(checked) => onSettingsChange((s) => ({ ...s, experimental: !!checked }))}
-            />
-          </Settings.ItemInput>
-
-          <Settings.ItemInput title={t('settings debug label')}>
-            <Input.Switch
-              checked={settings.debug}
-              onCheckedChange={(checked) => onSettingsChange((s) => ({ ...s, debug: !!checked }))}
-            />
-          </Settings.ItemInput>
-
-          {settings.debug && (
-            <Settings.ItemInput 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')}
-              />
-            </Settings.ItemInput>
-          )}
-        </Settings.Group>
-      </Settings.Section>
-    </Settings.Root>
+    <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)}
+        />
+      </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,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,43 +5,52 @@
 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 { withTheme } from '@dxos/react-ui/testing';
+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';
 
-faker.seed(1234);
+random.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),
+        name: random.lorem.words(3),
+        content: '# Title\n' + random.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(),
     withPluginManager({
-      plugins: [OperationPlugin()],
+      plugins: [OperationPlugin(), RuntimePlugin(), ClientPlugin({})],
     }),
   ],
   parameters: {

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',
+      },
+    }),
+  ];
+};

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

@@ -6,36 +6,50 @@ import { type Meta, type StoryObj } from '@storybook/react-vite';
 import * as Effect from 'effect/Effect';
 import React, { useMemo } from 'react';
 
+import { Capability, Plugin } from '@dxos/app-framework';
 import { withPluginManager } from '@dxos/app-framework/testing';
 import { Surface, useOperationInvoker } from '@dxos/app-framework/ui';
-import { LayoutOperation } from '@dxos/app-toolkit';
+import { AppActivationEvents, LayoutOperation } from '@dxos/app-toolkit';
+import { AppSurface } from '@dxos/app-toolkit/ui';
 import { Obj, Query } from '@dxos/echo';
 import { ClientPlugin } from '@dxos/plugin-client';
+import { initializeIdentity } from '@dxos/plugin-client/testing';
 import { PreviewPlugin } from '@dxos/plugin-preview';
 import { StorybookPlugin, corePlugins } from '@dxos/plugin-testing';
-import { faker } from '@dxos/random';
-import { useQuery, useSpace } from '@dxos/react-client/echo';
+import { random } from '@dxos/random';
+import { useQuery, useSpaces } from '@dxos/react-client/echo';
 import { useAsyncEffect } from '@dxos/react-ui';
-import { withLayout, withTheme } from '@dxos/react-ui/testing';
 import { useAttentionAttributes } from '@dxos/react-ui-attention';
+import { withLayout } from '@dxos/react-ui/testing';
 import { Text } from '@dxos/schema';
 import { type ValueGenerator, createObjectFactory } from '@dxos/schema/testing';
 import { Organization, Person } from '@dxos/types';
 
-import { MarkdownPlugin } from '../MarkdownPlugin';
-import { translations } from '../translations';
-import { Markdown } from '../types';
+import { Markdown, MarkdownCapabilities, MarkdownEvents } from '#types';
 
-faker.seed(1);
+import { MarkdownPlugin } from '../../MarkdownPlugin';
+import { translations } from '../../translations';
 
-const generator: ValueGenerator = faker as any;
+random.seed(1);
+
+const generator: ValueGenerator = random as any;
+
+/** Minimal plugin that contributes an empty Extensions capability for stories. */
+const MarkdownExtensionsPlugin = Plugin.define({ id: 'story-markdown-extensions', name: 'Story Extensions' }).pipe(
+  Plugin.addModule({
+    id: 'extensions',
+    activatesOn: MarkdownEvents.SetupExtensions,
+    activate: () => Effect.succeed(Capability.contributes(MarkdownCapabilities.Extensions, [])),
+  }),
+  Plugin.make,
+);
 
 const DefaultStory = () => {
   const { invokePromise } = useOperationInvoker();
-  const space = useSpace();
+  const [space] = useSpaces();
   const [doc] = useQuery(space?.db, Query.type(Markdown.Document));
-  const data = useMemo(() => ({ subject: doc }), [doc]);
   const id = doc && Obj.getDXN(doc).toString();
+  const data = useMemo(() => ({ subject: doc, attendableId: id ?? 'story' }), [doc, id]);
   const attentionAttrs = useAttentionAttributes(id);
 
   useAsyncEffect(async () => {
@@ -46,39 +60,37 @@ const DefaultStory = () => {
 
   return (
     <div className='contents' {...attentionAttrs}>
-      <Surface.Surface role='article' data={data} limit={1} />
+      <Surface.Surface type={AppSurface.Article} data={data} limit={1} />
     </div>
   );
 };
 
 const meta = {
-  title: 'plugins/plugin-markdown/MarkdownContainer',
+  title: 'plugins/plugin-markdown/containers/MarkdownContainer',
   render: DefaultStory,
   decorators: [
-    withTheme(),
     withLayout({ layout: 'column' }),
     withPluginManager<{ title?: string; content?: string }>((context) => ({
+      setupEvents: [AppActivationEvents.SetupSettings, MarkdownEvents.SetupExtensions],
       plugins: [
         ...corePlugins(),
         StorybookPlugin({}),
+        MarkdownExtensionsPlugin(),
         ClientPlugin({
           types: [Markdown.Document, Text.Text, Person.Person, Organization.Organization],
           onClientInitialized: ({ client }) =>
             Effect.gen(function* () {
-              yield* Effect.promise(() => client.halo.createIdentity());
-              yield* Effect.promise(() => client.spaces.waitUntilReady());
-              yield* Effect.promise(() => client.spaces.default.waitUntilReady());
+              const { personalSpace } = yield* initializeIdentity(client);
 
-              const space = client.spaces.default;
-              const createObjects = createObjectFactory(space.db, generator);
+              const createObjects = createObjectFactory(personalSpace.db, generator);
               yield* Effect.promise(() => createObjects([{ type: Organization.Organization, count: 10 }]));
 
-              const queue = space.queues.create();
+              const queue = personalSpace.queues.create();
               const kai = Obj.make(Person.Person, { fullName: 'Kai' });
               const dxos = Obj.make(Organization.Organization, { name: 'DXOS' });
               yield* Effect.promise(() => queue.append([kai, dxos]));
 
-              space.db.add(
+              personalSpace.db.add(
                 Markdown.make({
                   name: context.args.title ?? 'Testing',
                   content: [
@@ -95,7 +107,7 @@ const meta = {
                 }),
               );
 
-              yield* Effect.promise(() => space.db.flush({ indexes: true }));
+              yield* Effect.promise(() => personalSpace.db.flush({ indexes: true }));
             }),
         }),