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

package/src/components/MarkdownSettings/MarkdownSettings.tsx

@@ -5,133 +5,30 @@
 import React from 'react';
 
 import { type AppSurface } from '@dxos/app-toolkit/ui';
-import { Input, Select, useTranslation } from '@dxos/react-ui';
-import { Settings as SettingsForm } from '@dxos/react-ui-form';
-import { type EditorInputMode, EditorInputModes, type EditorViewMode, EditorViewModes } from '@dxos/ui-editor';
+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 { Markdown } from '#types';
 
 export type MarkdownSettingsProps = AppSurface.SettingsArticleProps<Markdown.Settings>;
 
-export const MarkdownSettings = ({ settings, onSettingsChange }: MarkdownSettingsProps) => {
-  const { t } = useTranslation(meta.id);
+const SnippetsField = ({ value, onChange, readonly }: SettingsFieldProps<string | undefined>) => (
+  <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 (
     <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>
-
-        <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')}
-            />
-            <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>
-
-        <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>
-
-        <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>
-
-        <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>
-
-        <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>
-
-        <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 title={meta.name ?? 'Editor'}>
+        <SettingsForm.FieldSet
+          readonly={!onSettingsChange}
+          schema={Markdown.Settings}
+          visible={(path, values) => path !== 'snippets' || !!values.debug}
+          fieldMap={{ snippets: SnippetsField }}
+          values={settings}
+          onValuesChanged={(values) => onSettingsChange?.(() => values)}
+        />
       </SettingsForm.Section>
     </SettingsForm.Viewport>
   );

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

@@ -15,7 +15,8 @@ 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 { translations } from '#translations';
+
 import { MarkdownCard, type MarkdownCardProps } from './MarkdownCard';
 
 random.seed(1234);
@@ -25,7 +26,7 @@ const MarkdownCardStory = ({ ...args }: Omit<MarkdownCardProps, 'subject'>) => {
     () =>
       Markdown.make({
         name: random.lorem.words(3),
-        content: random.lorem.paragraphs(5),
+        content: '# Title\n' + random.lorem.paragraphs(5),
       }),
     [],
   );

package/src/containers/MarkdownCard/MarkdownCard.tsx

@@ -8,6 +8,7 @@ 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';
@@ -21,13 +22,13 @@ 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: 240, scale: 0.8 })], []);
+  const extensions = useMemo(() => [snippetExtension({ height: 300, scale: 0.8 })], []);
   const info = getInfo(subject);
 
   return (
     <Card.Content>
       {snippet && (
-        <Card.Section className='px-1'>
+        <Card.Section className='relative px-1'>
           <MarkdownEditorProvider id={subject.id} viewMode='readonly' extensions={extensions}>
             {(editorRootProps) => (
               <Editor.Root {...editorRootProps}>
@@ -35,6 +36,13 @@ export const MarkdownCard = ({ subject }: MarkdownCardProps) => {
               </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>
@@ -46,13 +54,11 @@ export const MarkdownCard = ({ subject }: MarkdownCardProps) => {
   );
 };
 
-const MAX_LINES = 5;
-
-const getSnippet = (subject: Markdown.Document | Text.Text, fallback?: string) => {
+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, MAX_LINES);
+    return Obj.getDescription(subject) || getContentSnippet(subject.content?.target?.content ?? fallback, maxLines);
   } else if (Obj.instanceOf(Text.Text, subject)) {
-    return getContentSnippet(subject.content ?? fallback, MAX_LINES);
+    return getContentSnippet(subject.content ?? fallback, maxLines);
   }
 };
 

package/src/containers/MarkdownCard/MarkdownEditableCard.tsx

@@ -0,0 +1,42 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import React from 'react';
+
+import { Obj } from '@dxos/echo';
+import { useObject } from '@dxos/react-client/echo';
+import { Card } from '@dxos/react-ui';
+import { Editor } from '@dxos/react-ui-editor';
+import { Text } from '@dxos/schema';
+
+import { MarkdownEditor, MarkdownEditorProvider } from '#components';
+import { Markdown } from '#types';
+
+export type MarkdownEditableCardProps = { subject: Markdown.Document | Text.Text };
+
+/**
+ * Full-bleed editable variant of {@link MarkdownCard}. Activated by the host
+ * passing `editable: true` on the card surface data (e.g. plugin-board cells).
+ * Renders a plain editor (no app-graph toolbar / file upload / link queries)
+ * so it stays self-contained inside the card; the regular MarkdownContainer
+ * remains the canonical surface for full article views.
+ */
+export const MarkdownEditableCard = ({ subject }: MarkdownEditableCardProps) => {
+  const id = Obj.getDXN(subject).toString();
+  const [docContent] = useObject(Obj.instanceOf(Markdown.Document, subject) ? subject.content : undefined, 'content');
+  const [textContent] = useObject(Obj.instanceOf(Text.Text, subject) ? subject : undefined, 'content');
+  const initialValue = docContent ?? textContent;
+
+  return (
+    <Card.Section classNames='col-span-3 min-h-0'>
+      <MarkdownEditorProvider id={id} object={subject} viewMode='source'>
+        {(editorRootProps) => (
+          <Editor.Root {...editorRootProps}>
+            <MarkdownEditor.Content initialValue={initialValue} />
+          </Editor.Root>
+        )}
+      </MarkdownEditorProvider>
+    </Card.Section>
+  );
+};

package/src/containers/MarkdownCard/index.ts

@@ -3,3 +3,4 @@
 //
 
 export { MarkdownCard as default } from './MarkdownCard';
+export { MarkdownEditableCard } from './MarkdownEditableCard';

package/src/containers/MarkdownCard/snippet.ts

@@ -2,10 +2,11 @@
 // Copyright 2025 DXOS.org
 //
 
-import { type PluginValue, EditorView, ViewPlugin, type ViewUpdate } from '@codemirror/view';
+import { EditorState } from '@codemirror/state';
+import { EditorView } from '@codemirror/view';
 
 export type SnippetOptions = {
-  /** Maximum height of the editor in pixels. Content is clipped to whole lines within this height. */
+  /** 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;
@@ -13,66 +14,41 @@ export type SnippetOptions = {
 
 /**
  * CodeMirror extension for rendering a non-scrollable snippet of editor content.
- * Constrains the editor to the given height, clips to whole line boundaries,
- * and disables scrolling entirely.
- * Uses requestMeasure to read post-layout heights and lineBlockAtHeight to handle
- * varying line heights from headings and other decorated blocks.
+ * 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) => {
-  // Internal height is divided by scale so the visible area matches the requested height.
-  const internalHeight = Math.round(height / scale);
-
-  const clipPlugin = ViewPlugin.fromClass(
-    class SnippetPlugin implements PluginValue {
-      private clipHeight = 0;
-
-      update(update: ViewUpdate) {
-        update.view.requestMeasure({
-          // key deduplicates concurrent requests within the same animation frame.
-          key: this,
-          read: (view) => {
-            const containerHeight = view.dom.clientHeight;
-            if (containerHeight === 0) {
-              return 0;
-            }
-            // With CSS zoom, clientHeight can be in visual pixels while line positions use
-            // layout pixels (same space as internalHeight / theme maxHeight).
-            const clipLimit = scale === 1 ? containerHeight : Math.min(internalHeight, containerHeight / scale);
-            // Find the block (line) at the very bottom of the visible area.
-            const block = view.lineBlockAtHeight(clipLimit - 1);
-            // If the block overflows the container, clip at the block's top edge.
-            return block.top + block.height > clipLimit ? block.top : clipLimit;
-          },
-          write: (clipHeight, view) => {
-            if (clipHeight > 0 && clipHeight !== this.clipHeight) {
-              this.clipHeight = clipHeight;
-              view.dom.style.maxHeight = `${clipHeight}px`;
-            }
-          },
-        });
-      }
-    },
-  );
-
   return [
-    clipPlugin,
+    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: `${internalHeight}px`,
+        maxHeight: `${height}px`,
         overflow: 'hidden',
-        ...(scale !== 1 && { zoom: `${scale}` }),
       },
-      '.cm-content': {
-        whiteSpace: 'pre',
-        margin: '0',
+      '.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-line': {
+      '.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',
       },
-      '.cm-scroller': {
-        overflow: 'hidden !important',
-      },
     }),
   ];
 };

package/src/containers/MarkdownContainer/MarkdownContainer.stories.tsx

@@ -10,6 +10,7 @@ import { Capability, Plugin } from '@dxos/app-framework';
 import { withPluginManager } from '@dxos/app-framework/testing';
 import { Surface, useOperationInvoker } from '@dxos/app-framework/ui';
 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';
@@ -24,10 +25,10 @@ import { Text } from '@dxos/schema';
 import { type ValueGenerator, createObjectFactory } from '@dxos/schema/testing';
 import { Organization, Person } from '@dxos/types';
 
+import { translations } from '#translations';
 import { Markdown, MarkdownCapabilities, MarkdownEvents } from '#types';
 
 import { MarkdownPlugin } from '../../MarkdownPlugin';
-import { translations } from '../../translations';
 
 random.seed(1);
 
@@ -47,8 +48,8 @@ const DefaultStory = () => {
   const { invokePromise } = useOperationInvoker();
   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 () => {
@@ -59,7 +60,7 @@ 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>
   );
 };

package/src/containers/MarkdownContainer/MarkdownContainer.tsx

@@ -39,7 +39,7 @@ export type MarkdownContainerProps = AppSurface.ObjectArticleProps<
 
 export const MarkdownContainer = forwardRef<HTMLDivElement, MarkdownContainerProps>(
   (
-    { role, subject: object, id, attendableId, settings, extensionProviders, onSelectObject, ...props },
+    { role, subject: object, id, attendableId, settings, extensionProviders, onSelectObject, viewMode, ...props },
     forwardedRef,
   ) => {
     const db = Obj.isObject(object) ? Obj.getDatabase(object) : undefined;
@@ -54,18 +54,18 @@ export const MarkdownContainer = forwardRef<HTMLDivElement, MarkdownContainerPro
         return [];
       }
 
+      const document = Obj.instanceOf(Markdown.Document, object) ? object : undefined;
       return [...(otherExtensionProviders ?? []), ...(extensionProviders ?? [])]
         .flat()
         .reduce((acc: Extension[], provider) => {
-          const extension =
-            typeof provider === 'function' ? provider({ document: object as Markdown.Document }) : provider;
+          const extension = typeof provider === 'function' ? provider({ document, viewMode }) : provider;
           if (extension) {
             acc.push(extension);
           }
 
           return acc;
         }, []);
-    }, [extensionProviders, otherExtensionProviders, object]);
+    }, [extensionProviders, otherExtensionProviders, object, viewMode]);
 
     // Toolbar actions from app graph.
     const { graph } = useAppGraph();
@@ -118,6 +118,7 @@ export const MarkdownContainer = forwardRef<HTMLDivElement, MarkdownContainerPro
         compact={role !== 'article'}
         extensions={extensions}
         settings={settings}
+        viewMode={viewMode}
         onAction={runAction}
         onFileUpload={handleFileUpload}
         onLinkQuery={handleLinkQuery}

package/src/containers/index.ts

@@ -7,4 +7,7 @@ import { type ComponentType, lazy } from 'react';
 export type { MarkdownContainerProps } from './MarkdownContainer';
 
 export const MarkdownCard: ComponentType<any> = lazy(() => import('./MarkdownCard'));
+export const MarkdownEditableCard: ComponentType<any> = lazy(() =>
+  import('./MarkdownCard').then((m) => ({ default: m.MarkdownEditableCard })),
+);
 export const MarkdownContainer: ComponentType<any> = lazy(() => import('./MarkdownContainer'));

package/src/hooks/useExtensions.tsx

@@ -20,11 +20,9 @@ import {
   Cursor,
   type EditorStateStore,
   EditorView,
-  type EditorViewMode,
   type Extension,
   InputModeExtensions,
   type PreviewOptions,
-  type RenderCallback,
   createDataExtensions,
   decorateMarkdown,
   documentId,
@@ -35,8 +33,9 @@ import {
   preview,
   replacer,
   selectionState,
-  typewriter,
+  snippets,
 } from '@dxos/ui-editor';
+import { type EditorViewMode, type RenderCallback } from '@dxos/ui-editor/types';
 import { isTruthy, safeUrl } from '@dxos/util';
 
 import { Markdown } from '#types';
@@ -51,6 +50,7 @@ export type ExtensionsOptions = {
   settings?: Markdown.Settings;
   compact?: boolean;
   viewMode?: EditorViewMode;
+  editable?: boolean;
   selectionManager?: SelectionManager;
   editorStateStore?: EditorStateStore;
   previewOptions?: PreviewOptions;
@@ -97,8 +97,8 @@ export const useExtensions = ({
         viewMode,
         selectionManager,
         previewOptions,
-        onSelectObject,
         platform,
+        onSelectObject,
       }),
     [
       id,
@@ -107,14 +107,13 @@ export const useExtensions = ({
       viewMode,
       selectionManager,
       previewOptions,
-      onSelectObject,
       settings,
       settings?.debug,
       settings?.editorInputMode,
       settings?.folding,
       settings?.numberedHeadings,
       platform,
-      settings?.typewriter,
+      onSelectObject,
     ],
   );
 
@@ -187,9 +186,9 @@ const createBaseExtensions = ({
   }
 
   if (settings?.debug) {
-    const items = settings.typewriter?.split(/[,\n]/) ?? '';
+    const items = settings.snippets?.split(/[,\n]/) ?? '';
     if (items) {
-      extensions.push(typewriter({ items }));
+      extensions.push(snippets({ items }));
     }
   }
 

package/src/index.ts

@@ -2,13 +2,14 @@
 // Copyright 2023 DXOS.org
 //
 
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from './meta';
+
 export { MarkdownCapabilities, MarkdownEvents } from './types';
 
 export * from './meta';
 export * from './types';
 export * from './util';
 
-export * from './MarkdownPlugin';
-
-export { MarkdownEditor, MarkdownEditorProvider } from './components';
-export type { MarkdownEditorEditorRootProps } from './components';
+export const MarkdownPlugin = Plugin.lazy(meta, () => import('#plugin'));

package/src/operations/create-markdown.ts

@@ -4,7 +4,7 @@
 
 import * as Effect from 'effect/Effect';
 
-import { Operation } from '@dxos/operation';
+import { Operation } from '@dxos/compute';
 
 import { Markdown } from '../types';
 import { CreateMarkdown } from './definitions';