@dxos/react-ui-form 0.8.4-main.3eb6e50203 → 0.8.4-main.3fbcb4aa9b

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-bs-auto max-bs-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,22 +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 { type Database, Entity, Filter, Ref, Type } from '@dxos/echo';
+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 { descriptionText, mx } from '@dxos/ui-theme';
+import { ParentLabelAnnotationId } from '@dxos/schema';
+
+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.
@@ -25,31 +25,42 @@ const isRefSnapshot = (val: any): val is { '/': string } => {
   return typeof val === 'object' && typeof (val as any)?.['/'] === 'string';
 };
 
-const defaultGetOptions: NonNullable<RefFieldProps['getOptions']> = (results) =>
+const defaultGetOptions: NonNullable<RefFieldProps['getOptions']> = (results, { parentLabel } = {}) =>
   results.map((result) => {
     const id = Entity.getDXN(result).toString();
-    const label = Entity.getLabel(result);
+    const parent = parentLabel ? Obj.getParent(result as Obj.Unknown) : undefined;
+    const label = parent ? Entity.getLabel(parent) : Entity.getLabel(result);
     return { id, label: label ?? id };
   });
 
-const defaultResultsHook: NonNullable<RefFieldProps['resultsHook']> = (db, typename) =>
+const defaultUseResults: NonNullable<RefFieldProps['useResults']> = (db, typename) =>
   useQuery(
     db,
     typename
-      ? // For Type.Ref(Type.Obj) we want to show all objects.
-        typename === Type.getTypename(Type.Obj)
+      ? // For Ref.Ref(Obj.Unknown) we want to show all objects.
+        typename === Type.getTypename(Obj.Unknown)
         ? Filter.everything()
         : Filter.typename(typename)
       : Filter.nothing(),
   );
 
 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.Entity.Any;
-    getOptions?: (objects: Entity.Any[]) => RefOption[];
-    onCreate?: (schema: Type.Entity.Any, values: any) => void;
+    // 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[];
+    /**
+     * 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) => {
@@ -64,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,
@@ -80,46 +92,70 @@ export const RefField = (props: RefFieldProps) => {
   );
 
   const results = useResults(db, typename);
-  const options = useMemo(() => getOptions(results), [results, getOptions]);
+  const options = useMemo(() => {
+    const parentLabel = type ? findAnnotation<boolean>(type, ParentLabelAnnotationId) === true : false;
+    return getOptions(results, { parentLabel });
+  }, [results, getOptions, type]);
 
   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(
@@ -143,25 +179,25 @@ export const RefField = (props: RefFieldProps) => {
       <div>
         {readonly ? (
           !item ? (
-            <p className={mx(descriptionText, 'mbe-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='mie-1'>
+            <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 is-full'>
+                <div className='flex gap-form-gap w-full'>
                   <Input.Root key={item.id}>
-                    <Input.TextInput value={item.label} readOnly classNames='is-full' />
+                    <Input.TextInput value={item.label} readOnly classNames='w-full' />
                   </Input.Root>
                 </div>
               ) : (
-                <Button classNames='is-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>
@@ -169,13 +205,17 @@ export const RefField = (props: RefFieldProps) => {
             </ObjectPicker.Trigger>
             <ObjectPicker.Portal>
               <ObjectPicker.Content
-                classNames='popover-card-width'
+                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/SelectField.tsx

@@ -43,7 +43,7 @@ export const SelectField = ({
       ) : (
         <Select.Root value={value} onValueChange={handleValueChange}>
           {/* TODO(burdon): Placeholder not working? */}
-          <Select.TriggerButton classNames='is-full' disabled={!!readonly} placeholder={placeholder} />
+          <Select.TriggerButton classNames='w-full' disabled={!!readonly} placeholder={placeholder} />
           <Select.Portal>
             <Select.Content>
               <Select.Viewport>

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

@@ -7,12 +7,12 @@ import * as Schema from 'effect/Schema';
 import React, { useState } from 'react';
 
 import { SelectOption } from '@dxos/echo/internal';
-import { withTheme } from '@dxos/react-ui/testing';
+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>
   );
@@ -50,7 +52,7 @@ const meta = {
   title: 'ui/react-ui-form/SelectOptionField',
   component: SelectOptionField as any,
   render: DefaultStory,
-  decorators: [withTheme()],
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
   parameters: {
     layout: 'fullscreen',
     translations,

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

@@ -11,7 +11,8 @@ import { List } from '@dxos/react-ui-list';
 import { HuePicker } from '@dxos/react-ui-pickers';
 import { hues, osTranslations, subtleHover } from '@dxos/ui-theme';
 
-import { translationKey } from '../../../translations';
+import { translationKey } from '#translations';
+
 import { type FormFieldComponentProps, FormFieldLabel } from '../FormFieldComponent';
 
 export const SelectOptionField = ({
@@ -119,7 +120,7 @@ export const SelectOptionField = ({
   return (
     <Input.Root validationValence={status}>
       <FormFieldLabel error={error} readonly={readonly} label={label} />
-      <div role='none'>
+      <div>
         {options && (
           <List.Root
             items={options}
@@ -128,13 +129,13 @@ export const SelectOptionField = ({
             readonly={!!readonly}
           >
             {({ items }) => (
-              <div role='list' className='is-full overflow-auto'>
+              <div role='list' className='w-full overflow-auto'>
                 {items?.map((item) => (
                   <div key={item.id}>
                     <List.Item
                       role='button'
                       item={item}
-                      classNames={[subtleHover, 'flex flex-col cursor-pointer rounded-sm']}
+                      classNames={[subtleHover, 'flex flex-col cursor-pointer rounded-xs']}
                       aria-expanded={selected === item.id}
                     >
                       <div className='flex items-center'>
@@ -146,19 +147,18 @@ export const SelectOptionField = ({
                         <IconButton
                           iconOnly
                           variant='ghost'
-                          label={t(selected === item.id ? 'collapse label' : 'expand label', { ns: osTranslations })}
+                          label={t(selected === item.id ? 'collapse.label' : 'expand.label', { ns: osTranslations })}
                           icon={selected === item.id ? 'ph--caret-down--regular' : 'ph--caret-right--regular'}
                           onClick={() => handleClick(item.id)}
                         />
                       </div>
                       {selected === item.id && (
-                        <div className='pli-cardSpacingInline plb-cardSpacingBlock flex flex-col gap-1 density-fine'>
-                          {/* 16px to match drag handle width. */}
-                          <Input.Label classNames='text-xs'>{t('select option label')}</Input.Label>
-                          <div className='grid grid-cols-[1fr_min-content_min-content] gap-1'>
+                        <div className='flex flex-col p-form-padding gap-form-gap dx-density-fine'>
+                          <Input.Label classNames='text-xs'>{t('select-option.label')}</Input.Label>
+                          <div className='grid grid-cols-[1fr_min-content_min-content] gap-form-gap'>
                             <Input.TextInput
                               disabled={!!readonly}
-                              placeholder={t('select option label placeholder')}
+                              placeholder={t('select-option-label.placeholder')}
                               ref={selected === item.id ? inputRef : undefined}
                               value={item.title}
                               onChange={handleTitleChange(item.id)}
@@ -170,7 +170,7 @@ export const SelectOptionField = ({
                               disabled={!!readonly}
                               icon='ph--trash--fill'
                               iconOnly
-                              label={t('select option delete')}
+                              label={t('select-option-delete.button')}
                               onClick={() => handleDelete(item.id)}
                             />
                           </div>
@@ -182,10 +182,10 @@ export const SelectOptionField = ({
                 <IconButton
                   variant='ghost'
                   icon='ph--plus--regular'
-                  label={t('select option add')}
+                  label={t('select-option-add.button')}
                   onClick={handleAdd}
                   disabled={!!readonly}
-                  classNames='is-full'
+                  classNames='w-full'
                 />
               </div>
             )}

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

@@ -12,8 +12,8 @@ export const TextField = ({
   type,
   readonly,
   placeholder,
-  onValueChange,
   onBlur,
+  onValueChange,
   ...props
 }: FormFieldComponentProps<string>) => {
   const handleChange = useCallback<NonNullable<TextInputProps['onChange']>>(
@@ -29,8 +29,8 @@ export const TextField = ({
           disabled={!!readonly}
           placeholder={placeholder}
           value={value}
-          onChange={handleChange}
           onBlur={onBlur}
+          onChange={handleChange}
         />
       )}
     </FormFieldWrapper>

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

@@ -32,7 +32,7 @@ export const TupleField = ({
   return (
     <Input.Root validationValence={status}>
       <FormFieldLabel error={error} readonly={readonly} label={label} />
-      <div className={mx('grid gap-2', gridCols[binding.length - 1])}>
+      <div className={mx('grid gap-form-gap', gridCols[binding.length - 1])}>
         {binding.map((prop) => (
           <Input.TextInput
             key={prop}