@dxos/react-ui-form 0.8.4-main.fd6878d → 0.8.4-staging.60fe92afc8

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

@@ -0,0 +1,167 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { useAtomValue } from '@effect-atom/atom-react';
+import React, { useCallback, useMemo } from 'react';
+
+import { type Database, Obj, Ref } from '@dxos/echo';
+import { createDocAccessor } from '@dxos/echo-client';
+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,
+  jsonPath,
+  placeholder,
+  layout,
+  db,
+  getStatus,
+  getValue,
+  onValueChange,
+}: FormFieldComponentProps) => {
+  const { status, error } = getStatus();
+  const isRef = Ref.isRefType(type);
+  const value = getValue();
+
+  if ((readonly || layout === 'static') && value == null) {
+    return null;
+  }
+
+  const renderEditor = () => {
+    if (isRef) {
+      const reference = value as Ref.Ref<any> | undefined;
+      if (reference) {
+        return <RefMarkdownEditor reference={reference} placeholder={placeholder} />;
+      }
+
+      if (readonly) {
+        return null;
+      }
+
+      return <CreateTextButton db={db} disabled={!db} onCreate={(ref) => onValueChange(type, ref)} />;
+    }
+
+    return (
+      <StringMarkdownEditor
+        value={(value as string | undefined) ?? ''}
+        placeholder={placeholder}
+        readonly={!!readonly}
+        onChange={(next) => onValueChange(type, next)}
+      />
+    );
+  };
+
+  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>;
+  };
+
+  return (
+    <Input.Root validationValence={status}>
+      {layout !== 'inline' && <FormFieldLabel error={error} readonly={readonly} label={label} path={jsonPath} />}
+      {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(() => reference.atom, [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(() => reference.atom, [reference]));
+  const dataExtensions = useMemo(
+    () => (text ? [createDataExtensions({ id: reference.uri, 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/NumberField.tsx

@@ -0,0 +1,76 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React, { useCallback, useEffect, useState } from 'react';
+
+import { Input, type TextInputProps } from '@dxos/react-ui';
+import { safeParseFloat } from '@dxos/util';
+
+import { type FormFieldComponentProps, FormFieldWrapper } from '../FormFieldComponent';
+
+export const NumberField = ({
+  type,
+  readonly,
+  placeholder,
+  getValue,
+  onValueChange,
+  onBlur,
+  ...props
+}: FormFieldComponentProps<number>) => {
+  // Track raw string input so the user can clear the field before typing a new number.
+  // We only commit to onValueChange when the raw string parses to a valid number.
+  const [raw, setRaw] = useState<string>(() => {
+    const v = getValue();
+    return v !== undefined ? String(v) : '';
+  });
+
+  // Sync display when an external change updates the committed value (e.g. reactive form
+  // calculations). Only overwrite raw when the external value differs from what raw parses
+  // to, preserving partial edits like "1." which correctly parse to 1.
+  const externalValue = getValue();
+  useEffect(() => {
+    if (externalValue !== safeParseFloat(raw)) {
+      setRaw(externalValue !== undefined ? String(externalValue) : '');
+    }
+  }, [externalValue]); // eslint-disable-line react-hooks/exhaustive-deps
+
+  const handleChange = useCallback<NonNullable<TextInputProps['onChange']>>(
+    (event) => {
+      const value = event.target.value;
+      setRaw(value);
+      const parsed = safeParseFloat(value);
+      if (parsed !== undefined) {
+        onValueChange(type, parsed);
+      }
+    },
+    [type, onValueChange],
+  );
+
+  const handleBlur = useCallback(
+    (event: React.FocusEvent<HTMLElement>) => {
+      // If the field was left empty or invalid, reset to the last committed value.
+      if (safeParseFloat(raw) === undefined) {
+        const committed = getValue();
+        setRaw(committed !== undefined ? String(committed) : '');
+      }
+      onBlur(event);
+    },
+    [raw, getValue, onBlur],
+  );
+
+  return (
+    <FormFieldWrapper<number> readonly={readonly} getValue={getValue} {...props}>
+      {() => (
+        <Input.TextInput
+          type='number'
+          disabled={!!readonly}
+          placeholder={placeholder}
+          value={raw}
+          onChange={handleChange}
+          onBlur={handleBlur}
+        />
+      )}
+    </FormFieldWrapper>
+  );
+};

package/src/components/Form/fields/RefField.test.ts

@@ -0,0 +1,45 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { describe, test } from 'vitest';
+
+import { type RefOption } from '../../ObjectPicker';
+import { findRefOption } from './RefField';
+
+// Sample qualified self URIs as produced by an in-space object (Entity.getURI / `echo://<space>/<id>`).
+const SPACE_ID = 'BA25QRC2FEWCSAMRP4RZL65LWJ7352CKE';
+const ENTITY_ID = '01J00J9B45YHYSGZQTQMSKMGJ6';
+const QUALIFIED = `echo://${SPACE_ID}/${ENTITY_ID}`;
+const LOCAL = `echo:/${ENTITY_ID}`;
+
+const options: RefOption[] = [
+  { id: QUALIFIED, label: 'Target' },
+  { id: 'echo://BA25QRC2FEWCSAMRP4RZL65LWJ7352CKE/01J00OTHER0000000000000000', label: 'Other' },
+];
+
+describe('findRefOption', () => {
+  test('matches an exact qualified ref', ({ expect }) => {
+    expect(findRefOption({ '/': QUALIFIED }, options)?.label).toBe('Target');
+  });
+
+  test('matches a bare local ref against a qualified option by entity id', ({ expect }) => {
+    // `Ref.make` yields the local form; the option is keyed by the qualified self URI.
+    expect(findRefOption({ '/': LOCAL }, options)?.label).toBe('Target');
+  });
+
+  test('returns undefined for a non-ref value', ({ expect }) => {
+    expect(findRefOption('not-a-ref', options)).toBeUndefined();
+    expect(findRefOption(undefined, options)).toBeUndefined();
+  });
+
+  test('returns undefined when no option matches', ({ expect }) => {
+    expect(findRefOption({ '/': 'echo:/01J00MISSING0000000000000000' }, options)).toBeUndefined();
+  });
+
+  test('does not match a qualified ref against a same-entity-id option from a different space', ({ expect }) => {
+    // The entity id coincides but the space authority differs; ids are only unique within a space.
+    const otherSpace = `echo://BZ25QRC2FEWCSAMRP4RZL65LWJ7352CKE/${ENTITY_ID}`;
+    expect(findRefOption({ '/': otherSpace }, options)).toBeUndefined();
+  });
+});