@dxos/react-ui-form 0.8.4-main.b97322e → 0.8.4-main.dedc0f3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-ui-form",
-  "version": "0.8.4-main.b97322e",
+  "version": "0.8.4-main.dedc0f3",
   "description": "Data components.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -9,6 +9,7 @@
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
@@ -25,52 +26,56 @@
   "dependencies": {
     "@atlaskit/pragmatic-drag-and-drop": "^1.4.0",
     "@atlaskit/pragmatic-drag-and-drop-hitbox": "^1.0.3",
+    "@fluentui/react-tabster": "^9.24.2",
     "@preact-signals/safe-react": "^0.9.0",
     "@radix-ui/react-context": "1.1.1",
     "date-fns": "^3.3.1",
     "jsonpath": "^1.1.1",
-    "@dxos/async": "0.8.4-main.b97322e",
-    "@dxos/debug": "0.8.4-main.b97322e",
-    "@dxos/echo-schema": "0.8.4-main.b97322e",
-    "@dxos/echo": "0.8.4-main.b97322e",
-    "@dxos/echo-db": "0.8.4-main.b97322e",
-    "@dxos/effect": "0.8.4-main.b97322e",
-    "@dxos/invariant": "0.8.4-main.b97322e",
-    "@dxos/keys": "0.8.4-main.b97322e",
-    "@dxos/lit-ui": "0.8.4-main.b97322e",
-    "@dxos/log": "0.8.4-main.b97322e",
-    "@dxos/react-client": "0.8.4-main.b97322e",
-    "@dxos/live-object": "0.8.4-main.b97322e",
-    "@dxos/react-ui-list": "0.8.4-main.b97322e",
-    "@dxos/react-ui-stack": "0.8.4-main.b97322e",
-    "@dxos/react-ui-pickers": "0.8.4-main.b97322e",
-    "@dxos/react-ui-types": "0.8.4-main.b97322e",
-    "@dxos/react-ui-tag-picker": "0.8.4-main.b97322e",
-    "@dxos/schema": "0.8.4-main.b97322e",
-    "@dxos/util": "0.8.4-main.b97322e"
+    "@dxos/async": "0.8.4-main.dedc0f3",
+    "@dxos/echo": "0.8.4-main.dedc0f3",
+    "@dxos/debug": "0.8.4-main.dedc0f3",
+    "@dxos/echo-db": "0.8.4-main.dedc0f3",
+    "@dxos/echo-schema": "0.8.4-main.dedc0f3",
+    "@dxos/effect": "0.8.4-main.dedc0f3",
+    "@dxos/keys": "0.8.4-main.dedc0f3",
+    "@dxos/lit-ui": "0.8.4-main.dedc0f3",
+    "@dxos/live-object": "0.8.4-main.dedc0f3",
+    "@dxos/log": "0.8.4-main.dedc0f3",
+    "@dxos/react-client": "0.8.4-main.dedc0f3",
+    "@dxos/invariant": "0.8.4-main.dedc0f3",
+    "@dxos/react-ui-editor": "0.8.4-main.dedc0f3",
+    "@dxos/react-ui-components": "0.8.4-main.dedc0f3",
+    "@dxos/react-ui-searchlist": "0.8.4-main.dedc0f3",
+    "@dxos/react-ui-stack": "0.8.4-main.dedc0f3",
+    "@dxos/react-ui-tag-picker": "0.8.4-main.dedc0f3",
+    "@dxos/react-ui-types": "0.8.4-main.dedc0f3",
+    "@dxos/schema": "0.8.4-main.dedc0f3",
+    "@dxos/react-ui-pickers": "0.8.4-main.dedc0f3",
+    "@dxos/react-ui-list": "0.8.4-main.dedc0f3",
+    "@dxos/util": "0.8.4-main.dedc0f3"
   },
   "devDependencies": {
     "@types/jsonpath": "^0.2.4",
     "@types/react": "~18.2.0",
     "@types/react-dom": "~18.2.0",
-    "effect": "3.17.0",
+    "effect": "3.17.7",
     "fast-check": "^3.19.0",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/echo-signals": "0.8.4-main.b97322e",
-    "@dxos/random": "0.8.4-main.b97322e",
-    "@dxos/react-ui": "0.8.4-main.b97322e",
-    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.b97322e",
-    "@dxos/storybook-utils": "0.8.4-main.b97322e",
-    "@dxos/react-ui-theme": "0.8.4-main.b97322e"
+    "vite": "7.1.1",
+    "@dxos/echo-signals": "0.8.4-main.dedc0f3",
+    "@dxos/random": "0.8.4-main.dedc0f3",
+    "@dxos/react-ui": "0.8.4-main.dedc0f3",
+    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.dedc0f3",
+    "@dxos/react-ui-theme": "0.8.4-main.dedc0f3",
+    "@dxos/storybook-utils": "0.8.4-main.dedc0f3"
   },
   "peerDependencies": {
     "effect": "^3.13.3",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.b97322e",
-    "@dxos/react-ui-theme": "0.8.4-main.b97322e"
+    "@dxos/react-ui": "0.8.4-main.dedc0f3",
+    "@dxos/react-ui-theme": "0.8.4-main.dedc0f3"
   },
   "publishConfig": {
     "access": "public"

package/src/components/ControlSection/ControlSection.stories.tsx

@@ -7,31 +7,29 @@ import '@dxos-theme';
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React from 'react';
 
-import { StackItem } from '@dxos/react-ui-stack';
 import { withLayout, withTheme } from '@dxos/storybook-utils';
 
-import { ControlPage, ControlSection, type ControlSectionProps } from './ControlSection';
 import { translations } from '../../translations';
 
-const meta: Meta<ControlSectionProps> = {
+import { ControlPage, ControlSection } from './ControlSection';
+
+const meta = {
   title: 'ui/react-ui-form/ControlSection',
   component: ControlSection,
   render: (args) => (
-    <StackItem.Content classNames='w-[40rem]'>
-      <ControlPage>
-        <ControlSection {...args} />
-      </ControlPage>
-    </StackItem.Content>
+    <ControlPage classNames='w-[40rem]'>
+      <ControlSection {...args} />
+    </ControlPage>
   ),
   decorators: [withLayout({ fullscreen: true, classNames: 'justify-center' }), withTheme],
   parameters: {
     translations,
   },
-};
+} satisfies Meta<typeof ControlSection>;
 
 export default meta;
 
-type Story = StoryObj<ControlSectionProps>;
+type Story = StoryObj<typeof meta>;
 
 export const Default: Story = {
   args: {

package/src/components/ControlSection/ControlSection.tsx

@@ -13,6 +13,7 @@ import {
   toLocalizedString,
   useTranslation,
 } from '@dxos/react-ui';
+import { StackItem } from '@dxos/react-ui-stack';
 import { mx } from '@dxos/react-ui-theme';
 
 import { translationKey } from '../../translations';
@@ -21,9 +22,11 @@ export type ControlPageProps = ThemedClassName<ComponentPropsWithoutRef<'div'>>;
 
 export const ControlPage = ({ children, classNames, ...props }: ControlPageProps) => {
   return (
-    <div role='none' className={mx('pli-cardSpacingInline', classNames)} {...props}>
-      {children}
-    </div>
+    <StackItem.Content classNames='block overflow-y-auto [--control-spacing:var(--dx-trimMd)]'>
+      <div role='none' className={mx('pli-cardSpacingInline pbe-trimLg', classNames)} {...props}>
+        {children}
+      </div>
+    </StackItem.Content>
   );
 };
 
@@ -59,12 +62,16 @@ export const ControlGroupButton = ({ classNames, ...props }: ButtonProps) => {
   return <Button {...props} classNames={['md:col-span-2', classNames]} />;
 };
 
-export type ControlGroupProps = ThemedClassName<PropsWithChildren<{}>>;
+export type ControlGroupProps = ThemedClassName<PropsWithChildren>;
 
 export const ControlGroup = ({ children, classNames }: ControlGroupProps) => (
   <div
     role='none'
-    className={mx('group container-max-width grid grid-cols-1 md:grid-cols-[1fr_min-content] gap-trimMd', classNames)}
+    className={mx(
+      'group container-max-width grid grid-cols-1 md:grid-cols-[1fr_min-content] gap-trimMd',
+      '[--control-spacing:0px] [&_input]:justify-self-end [&_button]:justify-self-end',
+      classNames,
+    )}
   >
     {children}
   </div>
@@ -73,23 +80,30 @@ export const ControlGroup = ({ children, classNames }: ControlGroupProps) => (
 export const ControlFrame = ({ children }: ControlGroupProps) => (
   <div
     role='none'
-    className='p-trimMd container-max-width grid grid-cols-1 md:grid-cols-[1fr_1fr] gap-trimSm md:gap-trimMd border border-separator rounded-md'
+    className={mx(
+      'container-max-width grid grid-cols-1 md:grid-cols-[1fr_1fr] gap-trimSm md:gap-trimMd p-trimMd',
+      'border border-separator rounded-md',
+    )}
   >
     {children}
   </div>
 );
 
+export const controlItemClasses = mx([
+  'container-max-width grid md:col-span-2 grid-cols-subgrid gap-trimSm items-center',
+  // TODO(burdon): Use grid gap consistently or apply margins consistently?
+  'mlb-[--control-spacing] *:first:!mbs-0 *:last:!mbe-0 pli-trimMd plb-trimMd',
+  'border border-separator rounded-md',
+]);
+
+const controlItemTitleClasses = 'mbe-0 text-lg text-baseText font-normal';
+const controlItemDescriptionClasses = 'mlb-trimSm md:mbe-0 text-base text-description';
+
 export type ControlItemProps = PropsWithChildren<{
   title: Label;
   description?: Label;
 }>;
 
-export const controlItemClasses =
-  'pli-trimMd plb-trimMd container-max-width grid md:col-span-2 grid-cols-subgrid items-center gap-trimSm border border-separator rounded-md *:first:!mbs-0 *:last:!mbe-0';
-
-const controlItemTitleClasses = 'text-lg font-normal';
-const controlItemDescriptionClasses = 'text-base mlb-trimSm md:mbe-0 text-description';
-
 export const ControlItem = ({ title, description, children }: ControlItemProps) => {
   const { t } = useTranslation(translationKey);
 

package/src/components/FieldEditor/FieldEditor.stories.tsx

@@ -5,7 +5,7 @@
 import '@dxos-theme';
 
 import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React, { useMemo, useEffect } from 'react';
+import React, { useEffect, useMemo } from 'react';
 
 import { createEchoSchema } from '@dxos/live-object/testing';
 import { log } from '@dxos/log';
@@ -13,9 +13,10 @@ import { ProjectionModel } from '@dxos/schema';
 import { TestSchema, testView } from '@dxos/schema/testing';
 import { withLayout, withTheme } from '@dxos/storybook-utils';
 
-import { FieldEditor, type FieldEditorProps } from './FieldEditor';
 import { translations } from '../../translations';
-import { TestLayout, TestPanel, FIELD_EDITOR_DEBUG_SYMBOL } from '../testing';
+import { FIELD_EDITOR_DEBUG_SYMBOL, TestLayout, TestPanel } from '../testing';
+
+import { FieldEditor, type FieldEditorProps } from './FieldEditor';
 
 // Type definition for debug objects exposed to tests.
 export type FieldEditorDebugObjects = {
@@ -23,8 +24,6 @@ export type FieldEditorDebugObjects = {
   projection: ProjectionModel;
 };
 
-type StoryProps = FieldEditorProps;
-
 const DefaultStory = (props: FieldEditorProps) => {
   const handleComplete: FieldEditorProps['onSave'] = () => {
     log.info('onClose', { props });
@@ -55,19 +54,19 @@ const DefaultStory = (props: FieldEditorProps) => {
   );
 };
 
-const meta: Meta<StoryProps> = {
+const meta = {
   title: 'ui/react-ui-form/FieldEditor',
-  component: FieldEditor,
+  component: FieldEditor as any,
   render: DefaultStory,
   decorators: [withLayout({ fullscreen: true }), withTheme],
   parameters: {
     translations,
   },
-};
+} satisfies Meta<typeof DefaultStory>;
 
 export default meta;
 
-type Story = StoryObj<StoryProps>;
+type Story = StoryObj<typeof meta>;
 
 export const Default: Story = {
   args: {

package/src/components/FieldEditor/FieldEditor.test.tsx

@@ -3,14 +3,15 @@
 //
 
 import { composeStories } from '@storybook/react';
-import { screen, cleanup, fireEvent, act } from '@testing-library/react';
+import { act, cleanup, fireEvent, screen } from '@testing-library/react';
 import { afterEach, describe, expect, test } from 'vitest';
 
 import { ProjectionModel } from '@dxos/schema';
 
+import { FIELD_EDITOR_DEBUG_SYMBOL } from '../testing';
+
 import * as stories from './FieldEditor.stories';
 import { type FieldEditorDebugObjects } from './FieldEditor.stories';
-import { FIELD_EDITOR_DEBUG_SYMBOL } from '../testing';
 
 const { Default } = composeStories(stories);
 

package/src/components/FieldEditor/FieldEditor.tsx

@@ -5,17 +5,17 @@
 import React, { useCallback, useEffect, useMemo, useState } from 'react';
 
 import { type SchemaRegistry } from '@dxos/echo-db';
-import { FormatEnum, FormatEnums, formatToType, type EchoSchema } from '@dxos/echo-schema';
+import { type EchoSchema, FormatEnum, FormatEnums, formatToType } from '@dxos/echo-schema';
 import { log } from '@dxos/log';
-import { useTranslation } from '@dxos/react-ui';
+import { useAsyncEffect, useTranslation } from '@dxos/react-ui';
 import {
-  getFormatSchema,
-  getSchemaProperties,
-  sortProperties,
   type FieldType,
-  type PropertyType,
   type ProjectionModel,
+  type PropertyType,
   type SchemaProperty,
+  getFormatSchema,
+  getSchemaProperties,
+  sortProperties,
 } from '@dxos/schema';
 
 import { translationKey } from '../../translations';
@@ -27,18 +27,26 @@ export type FieldEditorProps = {
   registry?: SchemaRegistry;
   onSave: () => void;
   onCancel?: () => void;
-} & Pick<FormProps<any>, 'outerSpacing'>;
+} & Pick<FormProps<any>, 'outerSpacing' | 'readonly'>;
 
 /**
  * Displays a Form representing the metadata for a given `Field` and `View`.
  */
-export const FieldEditor = ({ projection, field, registry, onSave, onCancel, outerSpacing }: FieldEditorProps) => {
+export const FieldEditor = ({
+  readonly,
+  projection,
+  field,
+  registry,
+  onSave,
+  onCancel,
+  outerSpacing,
+}: FieldEditorProps) => {
   const { t } = useTranslation(translationKey);
   const [props, setProps] = useState<PropertyType>(projection.getFieldProjection(field.id).props);
   useEffect(() => setProps(projection.getFieldProjection(field.id).props), [field, projection]);
 
   const [schemas, setSchemas] = useState<EchoSchema[]>([]);
-  useEffect(() => {
+  useAsyncEffect(async () => {
     if (!registry) {
       return;
     }
@@ -46,14 +54,10 @@ export const FieldEditor = ({ projection, field, registry, onSave, onCancel, out
     const subscription = registry.query().subscribe((query) => setSchemas(query.results), { fire: true });
 
     // TODO(dmaretskyi): This shouldn't be needed.
-    const t = setTimeout(async () => {
-      const schemas = await registry.query().run();
-      setSchemas(schemas);
-    });
-    return () => {
-      clearTimeout(t);
-      subscription?.();
-    };
+    const schemas = await registry.query().run();
+    setSchemas(schemas);
+
+    return () => subscription?.();
   }, [registry]);
 
   const [referenceSchema, setReferenceSchema] = useState<EchoSchema>();
@@ -178,6 +182,7 @@ export const FieldEditor = ({ projection, field, registry, onSave, onCancel, out
     <Form<PropertyType>
       key={field.id}
       autoFocus
+      readonly={readonly}
       values={props}
       schema={fieldSchema}
       filter={propIsNotType}

package/src/components/Form/ArrayField.tsx

@@ -6,26 +6,26 @@ import { SchemaAST, pipe } from 'effect';
 import { capitalize } from 'effect/String';
 import React, { Fragment, useCallback } from 'react';
 
-import { findNode, getDiscriminatedType, isDiscriminatedUnion, SimpleType } from '@dxos/effect';
+import { SimpleType, findNode, getDiscriminatedType, isDiscriminatedUnion } from '@dxos/effect';
 import { invariant } from '@dxos/invariant';
 import { IconButton, useTranslation } from '@dxos/react-ui';
-import { getSchemaProperties, type SchemaProperty } from '@dxos/schema';
+import { type SchemaProperty, getSchemaProperties } from '@dxos/schema';
 
-import { type ComponentLookup } from './Form';
-import { FormField } from './FormContent';
-import { useFormValues, type FormInputStateProps } from './FormContext';
-import { InputHeader, type InputComponent } from './Input';
 import { translationKey } from '../../translations';
 import { findArrayElementType } from '../../util';
 
+import { type ComponentLookup } from './Form';
+import { FormField, type FormFieldProps } from './FormContent';
+import { type FormInputStateProps, useFormValues } from './FormContext';
+import { type InputComponent, InputHeader } from './Input';
+
 type ArrayFieldProps = {
   property: SchemaProperty<any>;
-  readonly?: boolean;
   inputProps: FormInputStateProps;
   path?: (string | number)[];
   Custom?: Partial<Record<string, InputComponent>>;
   lookupComponent?: ComponentLookup;
-};
+} & Pick<FormFieldProps, 'readonly'>;
 
 export const ArrayField = ({ property, readonly, path, inputProps, Custom, lookupComponent }: ArrayFieldProps) => {
   const { t } = useTranslation(translationKey);

package/src/components/Form/Defaults.tsx

@@ -6,14 +6,15 @@ import React, { useCallback, useEffect, useRef } from 'react';
 
 import { Input, Select, useTranslation } from '@dxos/react-ui';
 
-import { type InputProps, InputHeader } from './Input';
 import { translationKey } from '../../translations';
 
+import { InputHeader, type InputProps } from './Input';
+
 export const TextInput = ({
   type,
   label,
   inputOnly,
-  disabled,
+  readonly,
   placeholder,
   getStatus,
   getValue,
@@ -22,16 +23,16 @@ export const TextInput = ({
 }: InputProps) => {
   const { status, error } = getStatus();
 
-  return disabled && !getValue() ? null : disabled && inputOnly ? (
+  return readonly && !getValue() ? null : readonly === 'static' && inputOnly ? (
     <p>{getValue() ?? ''}</p>
   ) : (
     <Input.Root validationValence={status}>
       {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
+      {readonly === 'static' ? (
         <p>{getValue() ?? ''}</p>
       ) : (
         <Input.TextInput
-          disabled={disabled}
+          disabled={!!readonly}
           placeholder={placeholder}
           value={getValue() ?? ''}
           onChange={(event) => onValueChange(type, event.target.value)}
@@ -47,7 +48,7 @@ export const NumberInput = ({
   type,
   label,
   inputOnly,
-  disabled,
+  readonly,
   placeholder,
   getStatus,
   getValue,
@@ -56,19 +57,19 @@ export const NumberInput = ({
 }: InputProps) => {
   const { status, error } = getStatus();
 
-  return disabled && !getValue() ? null : disabled && inputOnly ? (
+  return readonly && !getValue() ? null : readonly === 'static' && inputOnly ? (
     <p>{getValue() ?? ''}</p>
   ) : (
     <Input.Root validationValence={status}>
       {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
+      {readonly === 'static' ? (
         <p>{getValue() ?? ''}</p>
       ) : (
         <Input.TextInput
           type='number'
-          disabled={disabled}
+          disabled={!!readonly}
           placeholder={placeholder}
-          value={getValue() ?? 0}
+          value={getValue()}
           onChange={(event) => onValueChange(type, event.target.value)}
           onBlur={onBlur}
         />
@@ -78,7 +79,7 @@ export const NumberInput = ({
   );
 };
 
-export const BooleanInput = ({ type, label, inputOnly, getStatus, getValue, onValueChange, disabled }: InputProps) => {
+export const BooleanInput = ({ type, label, inputOnly, getStatus, getValue, onValueChange, readonly }: InputProps) => {
   const { status, error } = getStatus();
   const checked = Boolean(getValue());
   const { t } = useTranslation(translationKey);
@@ -86,10 +87,10 @@ export const BooleanInput = ({ type, label, inputOnly, getStatus, getValue, onVa
   return (
     <Input.Root validationValence={status}>
       {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
+      {readonly === 'static' ? (
         <p>{t(checked ? 'boolean input true value' : 'boolean input false value')}</p>
       ) : (
-        <Input.Switch checked={checked} onCheckedChange={(value) => onValueChange(type, value)} />
+        <Input.Switch disabled={!!readonly} checked={checked} onCheckedChange={(value) => onValueChange(type, value)} />
       )}
       {inputOnly && <Input.DescriptionAndValidation>{error}</Input.DescriptionAndValidation>}
     </Input.Root>
@@ -104,7 +105,7 @@ export const SelectInput = ({
   type,
   label,
   inputOnly,
-  disabled,
+  readonly,
   placeholder,
   options,
   getStatus,
@@ -116,15 +117,15 @@ export const SelectInput = ({
   const value = getValue() as string | undefined;
   const handleValueChange = useCallback((value: string | number) => onValueChange(type, value), [type, onValueChange]);
 
-  return disabled && !value ? null : (
+  return readonly && !value ? null : (
     <Input.Root validationValence={status}>
       {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
+      {readonly === 'static' ? (
         <p>{options?.find(({ value: optionValue }) => optionValue === value)?.label ?? String(value)}</p>
       ) : (
         <Select.Root value={value} onValueChange={handleValueChange}>
           {/* TODO(burdon): Placeholder not working? */}
-          <Select.TriggerButton classNames='is-full' disabled={disabled} placeholder={placeholder} />
+          <Select.TriggerButton classNames='is-full' disabled={!!readonly} placeholder={placeholder} />
           <Select.Portal>
             <Select.Content>
               <Select.Viewport>
@@ -135,6 +136,7 @@ export const SelectInput = ({
                   </Select.Option>
                 ))}
               </Select.Viewport>
+              <Select.Arrow />
             </Select.Content>
           </Select.Portal>
         </Select.Root>
@@ -148,7 +150,7 @@ export const MarkdownInput = ({
   type,
   label,
   inputOnly,
-  disabled,
+  readonly,
   placeholder,
   getStatus,
   getValue,
@@ -182,12 +184,12 @@ export const MarkdownInput = ({
   return (
     <Input.Root validationValence={status}>
       {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
+      {readonly === 'static' ? (
         <p>{getValue() ?? ''}</p>
       ) : (
         <Input.TextArea
           ref={textareaRef}
-          disabled={disabled}
+          disabled={!!readonly}
           placeholder={placeholder}
           value={getValue() ?? ''}
           classNames={'min-bs-auto max-h-40 overflow-auto'}