@dxos/react-ui-form 0.8.4-main.d05673bc65 → 0.8.4-main.dfabb4ec29

package/src/components/Form/fields/MarkdownField.stories.tsx

@@ -0,0 +1,206 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Schema from 'effect/Schema';
+import React, { useMemo } from 'react';
+import { expect, userEvent } from 'storybook/test';
+
+import { Filter, Format, Obj, Ref } from '@dxos/echo';
+import { useQuery } from '@dxos/react-client/echo';
+import { useClientStory, withClientProvider } from '@dxos/react-client/testing';
+import { Panel } from '@dxos/react-ui';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { Text } from '@dxos/schema';
+
+import { translations } from '#translations';
+
+import { TestLayout } from '../../testing';
+import { Form } from '../Form';
+
+//
+// String-backed markdown.
+//
+
+const StringSchema = Schema.Struct({
+  notes: Schema.String.pipe(Format.FormatAnnotation.set(Format.TypeFormat.Markdown)).annotations({ title: 'Notes' }),
+});
+
+const StringStory = () => (
+  <TestLayout>
+    <Form.Root schema={StringSchema} defaultValues={{ notes: '# Hello\n\nMarkdown text *here*.' }}>
+      <Form.Viewport>
+        <Form.Content>
+          <Form.FieldSet />
+        </Form.Content>
+      </Form.Viewport>
+    </Form.Root>
+  </TestLayout>
+);
+
+//
+// Ref<Text>-backed markdown.
+//
+
+const TextNoteHolder = Schema.Struct({
+  instructions: Ref.Ref(Text.Text)
+    .pipe(Format.FormatAnnotation.set(Format.TypeFormat.Markdown))
+    .annotations({ title: 'Instructions' }),
+});
+
+const RefStory = () => {
+  const { space } = useClientStory();
+  const [text] = useQuery(space?.db, Filter.type(Text.Text));
+  const values = useMemo(() => (text ? { instructions: Ref.make(text) } : undefined), [text]);
+
+  if (!space || !values) {
+    return null;
+  }
+
+  return (
+    <TestLayout>
+      <Panel.Root>
+        <Panel.Content asChild>
+          <Form.Root schema={TextNoteHolder} values={values as any} db={space.db}>
+            <Form.Viewport>
+              <Form.Content>
+                <Form.FieldSet />
+              </Form.Content>
+            </Form.Viewport>
+          </Form.Root>
+        </Panel.Content>
+      </Panel.Root>
+    </TestLayout>
+  );
+};
+
+//
+// Ref<Text> empty — shows the create button.
+//
+
+const EmptyRefSchema = Schema.Struct({
+  instructions: Schema.optional(
+    Ref.Ref(Text.Text)
+      .pipe(Format.FormatAnnotation.set(Format.TypeFormat.Markdown))
+      .annotations({ title: 'Instructions' }),
+  ),
+});
+
+const EmptyRefStory = () => {
+  const { space } = useClientStory();
+  if (!space) {
+    return null;
+  }
+
+  return (
+    <TestLayout>
+      <Panel.Root>
+        <Panel.Content asChild>
+          <Form.Root schema={EmptyRefSchema} defaultValues={{}} db={space.db}>
+            <Form.Viewport>
+              <Form.Content>
+                <Form.FieldSet />
+              </Form.Content>
+            </Form.Viewport>
+          </Form.Root>
+        </Panel.Content>
+      </Panel.Root>
+    </TestLayout>
+  );
+};
+
+const meta = {
+  title: 'ui/react-ui-form/MarkdownField',
+  decorators: [withTheme(), withLayout({ layout: 'column' })],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const StringBacked: Story = {
+  render: () => <StringStory />,
+};
+
+// Regression test: keystrokes into a string-backed markdown field must not
+// blur the editor. Previously the EditorView was destroyed and recreated on
+// every change because `onChange` was a useTextEditor dep and form callbacks
+// are unstable across renders.
+export const StringBackedKeepsFocus: Story = {
+  render: () => (
+    <TestLayout>
+      <Form.Root schema={StringSchema} defaultValues={{ notes: '' }}>
+        <Form.Viewport>
+          <Form.Content>
+            <Form.FieldSet />
+          </Form.Content>
+        </Form.Viewport>
+      </Form.Root>
+    </TestLayout>
+  ),
+  play: async ({ canvasElement }) => {
+    const waitFor = async <T,>(predicate: () => T | null | undefined, message: string): Promise<T> => {
+      for (let attempt = 0; attempt < 50; attempt++) {
+        const value = predicate();
+        if (value) {
+          return value;
+        }
+        await new Promise((resolve) => setTimeout(resolve, 100));
+      }
+      throw new Error(message);
+    };
+
+    const editorRoot = await waitFor(
+      () => canvasElement.querySelector<HTMLElement>('.cm-editor'),
+      'CodeMirror editor root (.cm-editor) not found',
+    );
+    const editorContent = editorRoot.querySelector<HTMLElement>('.cm-content')!;
+    await expect(editorContent).toBeVisible();
+
+    // Focus editor and wait for focus to settle inside the editor root.
+    editorContent.focus();
+    await waitFor(() => (editorRoot.contains(document.activeElement) ? true : null), 'Editor did not receive focus');
+
+    // Type several characters; focus must be preserved inside the editor root
+    // after every keystroke. Regression: previously the EditorView was
+    // destroyed and recreated on every change, which detached the focused
+    // contentDOM and blurred the input.
+    const phrase = 'hello world';
+    for (const ch of phrase) {
+      await userEvent.keyboard(ch);
+      await expect(editorRoot.contains(document.activeElement)).toBe(true);
+    }
+
+    await expect(editorContent).toHaveTextContent(phrase);
+  },
+};
+
+export const RefPopulated: Story = {
+  render: () => <RefStory />,
+  decorators: [
+    withClientProvider({
+      createIdentity: true,
+      createSpace: true,
+      types: [Text.Text],
+      onCreateSpace: async ({ space }) => {
+        space.db.add(Obj.make(Text.Text, { content: '# Magazine brief\n\nLong-form text describing what to gather.' }));
+      },
+    }),
+  ],
+};
+
+export const RefEmpty: Story = {
+  render: () => <EmptyRefStory />,
+  decorators: [
+    withClientProvider({
+      createIdentity: true,
+      createSpace: true,
+      types: [Text.Text],
+    }),
+  ],
+};

package/src/components/Form/fields/MarkdownField.tsx

@@ -2,77 +2,167 @@
 // Copyright 2024 DXOS.org
 //
 
-import React, { useCallback, useEffect, useRef } from 'react';
+import { useAtomValue } from '@effect-atom/atom-react';
+import React, { useCallback, useMemo } from 'react';
 
-import { Input, type TextAreaProps } from '@dxos/react-ui';
+import { type Database, Obj, Ref } from '@dxos/echo';
+import { AtomRef } from '@dxos/echo-atom';
+import { createDocAccessor } from '@dxos/echo-db';
+import { Button, Icon, Input, useTranslation } from '@dxos/react-ui';
+import { Editor, useBasicMarkdownExtensions } from '@dxos/react-ui-editor';
+import { Text } from '@dxos/schema';
+import { createDataExtensions } from '@dxos/ui-editor';
+
+import { translationKey } from '#translations';
 
 import { type FormFieldComponentProps, FormFieldLabel } from '../FormFieldComponent';
 
+const editorClassNames =
+  'transition-colors bg-input-surface focus-within:bg-focus-surface border border-separator rounded-xs p-1 px-2';
+
+/**
+ * Form field that edits a markdown value in a CodeMirror editor.
+ * Supports two backings:
+ * - `Schema.String` annotated with `Format.TypeFormat.Markdown`: edited as plain text via `getValue`/`onValueChange`.
+ * - `Ref<Text>` annotated with `Format.TypeFormat.Markdown`: edited in-place via an Automerge doc accessor.
+ *   When the ref is empty and a database is available, a create button is shown to allocate a new Text.
+ */
 export const MarkdownField = ({
   type,
   readonly,
   label,
   placeholder,
   layout,
+  db,
   getStatus,
   getValue,
   onValueChange,
-  onBlur,
 }: FormFieldComponentProps) => {
   const { status, error } = getStatus();
-  const textareaRef = useRef<HTMLTextAreaElement>(null);
+  const isRef = Ref.isRefType(type);
+  const value = getValue();
 
-  // TODO(ZaymonFC): If we start using `Enter` for form submission, we should prevent default behavior here
-  //  since we're using a textarea element and the user needs to be able to enter new lines.
+  if ((readonly || layout === 'static') && value == null) {
+    return null;
+  }
 
-  const adjustHeight = useCallback(() => {
-    const textarea = textareaRef.current;
-    if (textarea) {
-      textarea.style.blockSize = 'auto'; // For measurement.
-      textarea.style.blockSize = `${textarea.scrollHeight + 2}px`;
-    }
-  }, []);
+  const renderEditor = () => {
+    if (isRef) {
+      const reference = value as Ref.Ref<any> | undefined;
+      if (reference) {
+        return <RefMarkdownEditor reference={reference} placeholder={placeholder} />;
+      }
 
-  // Adjust height on initial render.
-  useEffect(() => {
-    adjustHeight();
-  }, [adjustHeight]);
+      if (readonly) {
+        return null;
+      }
 
-  // Adjust height when the content changes.
-  useEffect(() => {
-    adjustHeight();
-  }, [getValue(), adjustHeight]);
+      return <CreateTextButton db={db} disabled={!db} onCreate={(ref) => onValueChange(type, ref)} />;
+    }
 
-  const handleChange = useCallback<NonNullable<TextAreaProps['onChange']>>(
-    (event) => onValueChange(type, event.target.value),
-    [type, onValueChange],
-  );
+    return (
+      <StringMarkdownEditor
+        value={(value as string | undefined) ?? ''}
+        placeholder={placeholder}
+        readonly={!!readonly}
+        onChange={(next) => onValueChange(type, next)}
+      />
+    );
+  };
 
-  const value = getValue();
-  if ((readonly || layout === 'static') && !value) {
-    return null;
-  }
+  const renderStatic = () => {
+    if (isRef) {
+      const reference = value as Ref.Ref<any> | undefined;
+      return reference ? <RefStaticText reference={reference} /> : null;
+    }
+    return <p className='whitespace-pre-wrap'>{(value as string | undefined) ?? ''}</p>;
+  };
 
-  // TODO(burdon): Use Markdown Editor.
   return (
     <Input.Root validationValence={status}>
       {layout !== 'inline' && <FormFieldLabel error={error} readonly={readonly} label={label} />}
-      {layout === 'static' ? (
-        <p>{value}</p>
-      ) : (
-        <Input.TextArea
-          ref={textareaRef}
-          disabled={!!readonly}
-          placeholder={placeholder}
-          value={value ?? ''}
-          classNames={'min-h-auto max-h-40 overflow-auto'}
-          onChange={handleChange}
-          onBlur={onBlur}
-          style={{ resize: 'none' }}
-          spellCheck={false}
-        />
-      )}
+      {layout === 'static' ? renderStatic() : renderEditor()}
       {layout === 'full' && <Input.Validation>{error}</Input.Validation>}
     </Input.Root>
   );
 };
+
+/** Read-only static rendering for a `Ref<Text>` value: resolve the ref and print its content. */
+const RefStaticText = ({ reference }: { reference: Ref.Ref<any> }) => {
+  const text = useAtomValue(useMemo(() => AtomRef.make(reference), [reference]));
+  if (!text?.content) {
+    return null;
+  }
+  return <p className='whitespace-pre-wrap'>{text.content}</p>;
+};
+
+type RefMarkdownEditorProps = {
+  reference: Ref.Ref<any>;
+  placeholder?: string;
+};
+
+const RefMarkdownEditor = ({ reference, placeholder }: RefMarkdownEditorProps) => {
+  const text = useAtomValue(useMemo(() => AtomRef.make(reference), [reference]));
+  const dataExtensions = useMemo(
+    () =>
+      text ? [createDataExtensions({ id: reference.dxn.toString(), text: createDocAccessor(text, ['content']) })] : [],
+    [text, reference],
+  );
+  const extensions = useBasicMarkdownExtensions({ placeholder, extensions: dataExtensions });
+  if (!text) {
+    return null;
+  }
+
+  return (
+    <Editor.Root>
+      <Editor.View classNames={editorClassNames} extensions={extensions} />
+    </Editor.Root>
+  );
+};
+
+type StringMarkdownEditorProps = {
+  value: string;
+  placeholder?: string;
+  readonly?: boolean;
+  onChange: (value: string) => void;
+};
+
+const StringMarkdownEditor = ({ value, placeholder, readonly, onChange }: StringMarkdownEditorProps) => {
+  const extensions = useBasicMarkdownExtensions({ placeholder });
+  const handleChange = useCallback((next: string) => onChange(next), [onChange]);
+
+  return (
+    <Editor.Root>
+      <Editor.View
+        classNames={editorClassNames}
+        extensions={extensions}
+        value={value}
+        onChange={readonly ? undefined : handleChange}
+      />
+    </Editor.Root>
+  );
+};
+
+type CreateTextButtonProps = {
+  db?: Database.Database;
+  disabled?: boolean;
+  onCreate: (ref: Ref.Ref<Text.Text>) => void;
+};
+
+const CreateTextButton = ({ db, disabled, onCreate }: CreateTextButtonProps) => {
+  const { t } = useTranslation(translationKey);
+  const handleClick = useCallback(() => {
+    if (!db) {
+      return;
+    }
+    const text = db.add(Obj.make(Text.Text, { content: '' }));
+    onCreate(Ref.make(text));
+  }, [db, onCreate]);
+
+  return (
+    <Button onClick={handleClick} disabled={disabled}>
+      <Icon icon='ph--plus--regular' size={4} />
+      <span>{t('create-text.label')}</span>
+    </Button>
+  );
+};

package/src/components/Form/fields/RefField.tsx

@@ -2,23 +2,22 @@
 // Copyright 2025 DXOS.org
 //
 
-import '@dxos/lit-ui/dx-tag-picker.pcss';
-
-import React, { useCallback, useMemo } from 'react';
+import React, { useCallback, useMemo, useState } from 'react';
 
+import '@dxos/lit-ui/dx-tag-picker.pcss';
 import { type Database, Entity, Filter, Obj, Ref, Type } from '@dxos/echo';
+import { useQuery, useSchema as defaultUseSchema } from '@dxos/echo-react';
 import { ReferenceAnnotationId, type ReferenceAnnotationValue } from '@dxos/echo/internal';
-import { useQuery, useSchema as useSchema$ } from '@dxos/echo-react';
 import { findAnnotation } from '@dxos/effect';
 import { DXN } from '@dxos/keys';
 import { DxAnchor } from '@dxos/lit-ui/react';
 import { Button, Icon, Input, useTranslation } from '@dxos/react-ui';
 import { ParentLabelAnnotationId } from '@dxos/schema';
-import { mx } from '@dxos/ui-theme';
 
-import { translationKey } from '../../../translations';
+import { translationKey } from '#translations';
+
 import { ObjectPicker, type ObjectPickerContentProps, type RefOption } from '../../ObjectPicker';
-import { omitId } from '../Form';
+import { omitHiddenFormFields, omitId } from '../Form';
 import { type FormFieldComponentProps, FormFieldLabel } from '../FormFieldComponent';
 
 // TODO(burdon): Factor out.
@@ -34,7 +33,7 @@ const defaultGetOptions: NonNullable<RefFieldProps['getOptions']> = (results, {
     return { id, label: label ?? id };
   });
 
-const defaultResultsHook: NonNullable<RefFieldProps['resultsHook']> = (db, typename) =>
+const defaultUseResults: NonNullable<RefFieldProps['useResults']> = (db, typename) =>
   useQuery(
     db,
     typename
@@ -46,12 +45,22 @@ const defaultResultsHook: NonNullable<RefFieldProps['resultsHook']> = (db, typen
   );
 
 export type RefFieldProps = FormFieldComponentProps &
-  Pick<ObjectPickerContentProps, 'createOptionLabel' | 'createOptionIcon' | 'createInitialValuePath'> & {
+  Pick<
+    ObjectPickerContentProps,
+    'createOptionLabel' | 'createOptionIcon' | 'createInitialValuePath' | 'createFieldMap'
+  > & {
     db?: Database.Database;
-    resultsHook?: (db?: Database.Database, typename?: string) => Entity.Any[];
-    schemaHook?: (db?: Database.Database, typename?: string) => Type.AnyEntity;
+    // TODO(burdon): Replace hooks with callbacks.
+    useSchema?: (db?: Database.Database, typename?: string) => Type.AnyEntity;
+    useResults?: (db?: Database.Database, typename?: string) => Entity.Any[];
     getOptions?: (objects: Entity.Any[], options?: { parentLabel?: boolean }) => RefOption[];
-    onCreate?: (schema: Type.AnyEntity, values: any) => void;
+    /**
+     * Persist a newly-created object. Called after the user fills out the
+     * inline create form and clicks Save. Should add the object to the
+     * database and return it (sync or async). The returned object is then
+     * wired into this slot's form value as a Ref.
+     */
+    onCreate?: (schema: Type.AnyEntity, values: any) => Obj.Unknown | Promise<Obj.Unknown> | undefined | void;
   };
 
 export const RefField = (props: RefFieldProps) => {
@@ -66,9 +75,10 @@ export const RefField = (props: RefFieldProps) => {
     createOptionLabel,
     createOptionIcon,
     createInitialValuePath,
+    createFieldMap,
     db,
-    resultsHook: useResults = defaultResultsHook,
-    schemaHook: useSchema = useSchema$,
+    useSchema = defaultUseSchema,
+    useResults = defaultUseResults,
     getOptions = defaultGetOptions,
     onCreate,
     onValueChange,
@@ -89,42 +99,63 @@ export const RefField = (props: RefFieldProps) => {
 
   const handleGetValue = useCallback(() => {
     const formValue = getValue();
+    // Match form-value Refs against options by the bare object id (last DXN
+    // segment), not by full DXN string. Ref.make uses
+    // `DXN.fromLocalObjectId(id)` (`dxn:echo:@:<id>`), but
+    // `Entity.getDXN(obj)` on a registered object produces the space-scoped
+    // form (`dxn:echo:<spaceId>:<id>`). String-comparing the two never
+    // matches, so the just-created Ref's option lookup fails and the slot
+    // displays as empty even though the underlying form value IS set.
+    const dxnToObjectId = (dxn: string): string => dxn.split(':').pop() ?? dxn;
 
     const unknownToRefOption = (value: unknown) => {
       const isRef = Ref.isRef(value);
       if (isRef || isRefSnapshot(value)) {
         const dxnString = isRef ? value.dxn.toString() : value['/'];
-        const matchingOption = options.find((option) => option.id === dxnString);
+        const objectId = dxnToObjectId(dxnString);
+        const matchingOption = options.find((option) => dxnToObjectId(option.id) === objectId);
         if (matchingOption) {
           return matchingOption;
         }
       }
+
       return undefined;
     };
 
     return unknownToRefOption(formValue);
   }, [options, getValue]);
 
-  const handleUpdate = useCallback(
-    (id: string | undefined) => {
-      const item = options.find((option) => option.id === id);
-      const ref = item ? Ref.fromDXN(DXN.parse(item.id)) : undefined;
-      onValueChange(type, ref);
-    },
-    [options, type, onValueChange],
-  );
-
   const item = handleGetValue();
   const selectedIds = useMemo(() => (item ? [item.id] : []), [item]);
   const createSchema = useSchema(db, typename);
 
+  // Lift the popover open state so we can dismiss it after a successful create.
+  const [open, setOpen] = useState(false);
+
   const handleCreate = useCallback(
-    (values: any) => {
-      if (createSchema && onCreate) {
-        onCreate(createSchema, values);
+    async (values: any) => {
+      if (!createSchema || !onCreate) {
+        return;
+      }
+      const newObject = await onCreate(createSchema, values);
+      if (newObject) {
+        // Wire the newly-created object into this slot's form value. ArrayField
+        // owns the array; this RefField represents a single slot, so writing a
+        // Ref via `onValueChange` populates that slot.
+        onValueChange(type, Ref.make(newObject));
       }
+      setOpen(false);
+    },
+    [createSchema, onCreate, type, onValueChange],
+  );
+
+  const handleUpdate = useCallback(
+    (id: string | undefined) => {
+      const item = options.find((option) => option.id === id);
+      const ref = item ? Ref.fromDXN(DXN.parse(item.id)) : undefined;
+      onValueChange(type, ref);
     },
-    [createSchema, onCreate],
+    [options, type, onValueChange],
   );
 
   const handleSelect = useCallback(
@@ -148,25 +179,25 @@ export const RefField = (props: RefFieldProps) => {
       <div>
         {readonly ? (
           !item ? (
-            <p className={mx('text-description', 'mb-2')}>{t('empty readonly ref field label')}</p>
+            <p className='text-description mb-2'>{t('empty-readonly-ref-field.label')}</p>
           ) : (
             <DxAnchor key={item.id} dxn={item.id} rootclassname='me-1'>
               {item.label}
             </DxAnchor>
           )
         ) : (
-          <ObjectPicker.Root>
+          <ObjectPicker.Root open={open} onOpenChange={setOpen}>
             <ObjectPicker.Trigger asChild classNames='p-0'>
               {item ? (
-                <div className='flex gap-2 w-full'>
+                <div className='flex gap-form-gap w-full'>
                   <Input.Root key={item.id}>
                     <Input.TextInput value={item.label} readOnly classNames='w-full' />
                   </Input.Root>
                 </div>
               ) : (
-                <Button classNames='w-full text-start gap-2'>
-                  <div role='none' className='grow overflow-hidden'>
-                    <span className='flex truncate text-description'>{placeholder ?? t('ref field placeholder')}</span>
+                <Button classNames='w-full text-start gap-form-gap'>
+                  <div className='grow overflow-hidden'>
+                    <span className='truncate text-description'>{placeholder ?? t('ref-field.placeholder')}</span>
                   </div>
                   <Icon size={3} icon='ph--caret-down--bold' />
                 </Button>
@@ -177,10 +208,14 @@ export const RefField = (props: RefFieldProps) => {
                 classNames='dx-card-popover-width'
                 options={options}
                 selectedIds={selectedIds}
-                createSchema={createSchema && omitId(createSchema)}
+                // Strip hidden (`FormInputAnnotation.set(false)`) fields so the
+                // form's validator doesn't reject required-but-hidden fields
+                // such as backing-object refs supplied by a `FactoryAnnotation`.
+                createSchema={createSchema && omitHiddenFormFields(omitId(createSchema))}
                 createOptionLabel={createOptionLabel}
                 createOptionIcon={createOptionIcon}
                 createInitialValuePath={createInitialValuePath}
+                createFieldMap={createFieldMap}
                 onCreate={handleCreate}
                 onSelect={handleSelect}
               />

package/src/components/Form/fields/SelectOptionField.stories.tsx

@@ -9,10 +9,10 @@ import React, { useState } from 'react';
 import { SelectOption } from '@dxos/echo/internal';
 import { withLayout, withTheme } from '@dxos/react-ui/testing';
 
-import { translations } from '../../../translations';
+import { translations } from '#translations';
+
 import { TestLayout } from '../../testing';
 import { Form } from '../Form';
-
 import { SelectOptionField } from './SelectOptionField';
 
 const schema = Schema.Struct({
@@ -37,10 +37,12 @@ const DefaultStory = () => {
         fieldMap={{ options: SelectOptionField }}
         onSave={(values) => setValues(values)}
       >
-        <Form.Content>
-          <Form.FieldSet />
-          <Form.Actions />
-        </Form.Content>
+        <Form.Viewport>
+          <Form.Content>
+            <Form.FieldSet />
+            <Form.Actions />
+          </Form.Content>
+        </Form.Viewport>
       </Form.Root>
     </TestLayout>
   );