@dxos/react-ui-form 0.8.2-main.fbd8ed0 → 0.8.2-staging.42af850

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

@@ -5,14 +5,15 @@
 import '@dxos-theme';
 
 import { type Meta, type StoryObj } from '@storybook/react';
-import { Schema, SchemaAST } from 'effect';
+import { Schema } from 'effect';
 import React, { useCallback, useState } from 'react';
 
 import { ContactType } from '@dxos/client/testing';
 import { type BaseObject, Expando, Format, getDXN, Ref, type TypeAnnotation } from '@dxos/echo-schema';
 import { live } from '@dxos/live-object';
+import { withSurfaceVariantsLayout } from '@dxos/react-ui/testing';
 import { Testing } from '@dxos/schema/testing';
-import { withLayout, withTheme } from '@dxos/storybook-utils';
+import { withTheme } from '@dxos/storybook-utils';
 
 import { SelectInput } from './Defaults';
 import { Form, type FormProps } from './Form';
@@ -20,20 +21,18 @@ import translations from '../../translations';
 import { TestLayout, TestPanel } from '../testing';
 
 const AddressSchema = Schema.Struct({
-  street: Schema.optional(Schema.String.annotations({ [SchemaAST.TitleAnnotationId]: 'Street' })),
-  city: Schema.optional(Schema.String.annotations({ [SchemaAST.TitleAnnotationId]: 'City' })),
-  zip: Schema.optional(
-    Schema.String.pipe(Schema.pattern(/^\d{5}(-\d{4})?$/)).annotations({ [SchemaAST.TitleAnnotationId]: 'ZIP' }),
-  ),
-  location: Schema.optional(Format.GeoPoint.annotations({ [SchemaAST.TitleAnnotationId]: 'Location' })),
-}).annotations({ [SchemaAST.TitleAnnotationId]: 'Address' });
+  street: Schema.optional(Schema.String.annotations({ title: 'Street' })),
+  city: Schema.optional(Schema.String.annotations({ title: 'City' })),
+  zip: Schema.optional(Schema.String.pipe(Schema.pattern(/^\d{5}(-\d{4})?$/)).annotations({ title: 'ZIP' })),
+  location: Schema.optional(Format.GeoPoint.annotations({ title: 'Location' })),
+}).annotations({ title: 'Address' });
 
 // TODO(burdon): Translations?
 const TestSchema = Schema.Struct({
-  name: Schema.optional(Schema.String.annotations({ [SchemaAST.TitleAnnotationId]: 'Name' })),
-  active: Schema.optional(Schema.Boolean.annotations({ [SchemaAST.TitleAnnotationId]: 'Active' })),
-  rank: Schema.optional(Schema.Number.annotations({ [SchemaAST.TitleAnnotationId]: 'Rank' })),
-  website: Schema.optional(Format.URL.annotations({ [SchemaAST.TitleAnnotationId]: 'Website' })),
+  name: Schema.optional(Schema.String.annotations({ title: 'Name' })),
+  active: Schema.optional(Schema.Boolean.annotations({ title: 'Active' })),
+  rank: Schema.optional(Schema.Number.annotations({ title: 'Rank' })),
+  website: Schema.optional(Format.URL.annotations({ title: 'Website' })),
   address: Schema.optional(AddressSchema),
 }).pipe(Schema.mutable);
 
@@ -47,6 +46,15 @@ const DefaultStory = <T extends BaseObject>({ schema, values: initialValues, ...
     setValues(values);
   }, []);
 
+  return <Form<T> schema={schema} values={values} onSave={handleSave} {...props} />;
+};
+
+const DebugStory = <T extends BaseObject>({ schema, values: initialValues, ...props }: StoryProps<T>) => {
+  const [values, setValues] = useState(initialValues);
+  const handleSave = useCallback<NonNullable<FormProps<T>['onSave']>>((values) => {
+    setValues(values);
+  }, []);
+
   return (
     <TestLayout json={{ values, schema: schema.ast.toJSON() }}>
       <TestPanel>
@@ -59,11 +67,17 @@ const DefaultStory = <T extends BaseObject>({ schema, values: initialValues, ...
 const meta: Meta<StoryProps<any>> = {
   title: 'ui/react-ui-form/Form',
   component: Form,
-  render: DefaultStory,
-  decorators: [withLayout({ fullscreen: true }), withTheme],
+  render: DebugStory,
+  decorators: [withTheme],
   parameters: {
     translations,
   },
+  argTypes: {
+    readonly: {
+      control: 'boolean',
+      description: 'Readonly',
+    },
+  },
 };
 
 export default meta;
@@ -71,6 +85,8 @@ export default meta;
 type Story<T extends BaseObject> = StoryObj<StoryProps<T>>;
 
 export const Default: Story<TestType> = {
+  render: DefaultStory,
+  decorators: [withSurfaceVariantsLayout(), withTheme],
   args: {
     schema: TestSchema,
     values: {
@@ -80,6 +96,7 @@ export const Default: Story<TestType> = {
         zip: '11205',
       },
     },
+    readonly: false,
   },
 };
 
@@ -88,8 +105,9 @@ export const Organization: Story<Testing.Organization> = {
     schema: Testing.OrganizationSchema,
     values: {
       name: 'DXOS',
-      // website: 'https://dxos.org',
+      website: 'https://dxos.org',
     },
+    readonly: false,
   },
 };
 
@@ -98,9 +116,10 @@ export const OrganizationAutoSave: Story<Testing.Organization> = {
     schema: Testing.OrganizationSchema,
     values: {
       name: 'DXOS',
-      // website: 'https://dxos.org',
+      website: 'https://dxos.org',
     },
     autoSave: true,
+    readonly: false,
   },
 };
 
@@ -116,70 +135,44 @@ export const OrganizationAutoSave: Story<Testing.Organization> = {
 //   },
 // };
 
-//
-// TODO(burdon): Move into separate storybook and use test types.
-//
-
 const ShapeSchema = Schema.Struct({
   shape: Schema.optional(
     Schema.Union(
       Schema.Struct({
-        type: Schema.Literal('circle').annotations({ [SchemaAST.TitleAnnotationId]: 'Type' }),
-        radius: Schema.optional(Schema.Number.annotations({ [SchemaAST.TitleAnnotationId]: 'Radius' })),
+        type: Schema.Literal('circle').annotations({ title: 'Type' }),
+        radius: Schema.optional(Schema.Number.annotations({ title: 'Radius' })),
       }),
       Schema.Struct({
-        type: Schema.Literal('square').annotations({ [SchemaAST.TitleAnnotationId]: 'Type' }),
-        size: Schema.optional(
-          Schema.Number.pipe(Schema.nonNegative()).annotations({ [SchemaAST.TitleAnnotationId]: 'Size' }),
-        ),
+        type: Schema.Literal('square').annotations({ title: 'Type' }),
+        size: Schema.optional(Schema.Number.pipe(Schema.nonNegative()).annotations({ title: 'Size' })),
       }),
-    ).annotations({ [SchemaAST.TitleAnnotationId]: 'Shape' }),
+    ).annotations({ title: 'Shape' }),
   ),
 }).pipe(Schema.mutable);
 
 type ShapeType = Schema.Schema.Type<typeof ShapeSchema>;
 
-type DiscriminatedUnionStoryProps = FormProps<ShapeType>;
-
-const DiscriminatedUnionStory = ({ values: initialValues }: DiscriminatedUnionStoryProps) => {
-  const [values, setValues] = useState(initialValues);
-  const handleSave = useCallback<NonNullable<FormProps<ShapeType>['onSave']>>((values) => {
-    setValues(values);
-  }, []);
-
-  return (
-    <TestLayout json={{ values, schema: ShapeSchema.ast.toJSON() }}>
-      <TestPanel>
-        <Form<ShapeType>
-          schema={ShapeSchema}
-          values={values}
-          onSave={handleSave}
-          Custom={{
-            ['shape.type' as const]: (props) => (
-              <SelectInput
-                {...props}
-                options={['circle', 'square'].map((value) => ({
-                  value,
-                  label: value,
-                }))}
-              />
-            ),
-          }}
-        />
-      </TestPanel>
-    </TestLayout>
-  );
-};
-
-export const DiscriminatedShape: StoryObj<DiscriminatedUnionStoryProps> = {
-  render: DiscriminatedUnionStory,
+export const DiscriminatedShape: Story<ShapeType> = {
   args: {
+    schema: ShapeSchema,
+    readonly: false,
     values: {
       shape: {
         type: 'circle',
         radius: 5,
       },
     },
+    Custom: {
+      ['shape.type' as const]: (props) => (
+        <SelectInput
+          {...props}
+          options={['circle', 'square'].map((value) => ({
+            value,
+            label: value,
+          }))}
+        />
+      ),
+    },
   },
 };
 
@@ -190,24 +183,10 @@ const ArraysSchema = Schema.Struct({
 
 type ArraysType = Schema.Schema.Type<typeof ArraysSchema>;
 
-const ArraysStory = ({ values: initialValues }: FormProps<ArraysType>) => {
-  const [values, setValues] = useState(initialValues);
-  const handleSave = useCallback<NonNullable<FormProps<ArraysType>['onSave']>>((values) => {
-    setValues(values);
-  }, []);
-
-  return (
-    <TestLayout json={{ values, schema: ArraysSchema.ast.toJSON() }}>
-      <TestPanel>
-        <Form<ArraysType> schema={ArraysSchema} values={values} onSave={handleSave} />
-      </TestPanel>
-    </TestLayout>
-  );
-};
-
 export const Arrays: StoryObj<FormProps<ArraysType>> = {
-  render: ArraysStory,
   args: {
+    schema: ArraysSchema,
+    readonly: false,
     values: {
       names: ['Alice', 'Bob'],
       addresses: [],
@@ -217,30 +196,16 @@ export const Arrays: StoryObj<FormProps<ArraysType>> = {
 
 const ColorSchema = Schema.Struct({
   color: Schema.Union(Schema.Literal('red'), Schema.Literal('green'), Schema.Literal('blue')).annotations({
-    [SchemaAST.TitleAnnotationId]: 'Color',
+    title: 'Color',
   }),
 }).pipe(Schema.mutable);
 
 type ColorType = Schema.Schema.Type<typeof ColorSchema>;
 
-const EnumStory = ({ values: initialValues }: FormProps<ColorType>) => {
-  const [values, setValues] = useState(initialValues);
-  const handleSave = useCallback<NonNullable<FormProps<ColorType>['onSave']>>((values) => {
-    setValues(values);
-  }, []);
-
-  return (
-    <TestLayout json={{ values, schema: ColorSchema.ast.toJSON() }}>
-      <TestPanel>
-        <Form<ColorType> schema={ColorSchema} values={values} onSave={handleSave} />
-      </TestPanel>
-    </TestLayout>
-  );
-};
-
 export const Enum: StoryObj<FormProps<ColorType>> = {
-  render: EnumStory,
   args: {
+    schema: ColorSchema,
+    readonly: false,
     values: {
       color: 'red',
     },
@@ -254,15 +219,15 @@ const RefSchema = Schema.Struct({
   unknownExpando: Schema.optional(Ref(Expando).annotations({ title: 'Optional Ref to an Expando (DXN Input)' })),
 });
 
-const RefStory = ({ values: initialValues }: FormProps<any>) => {
+const contact1 = live(ContactType, { identifiers: [] });
+const contact2 = live(ContactType, { identifiers: [] });
+
+const RefStory = ({ values: initialValues, readonly }: FormProps<any>) => {
   const [values, setValues] = useState(initialValues);
   const handleSave = useCallback<NonNullable<FormProps<any>['onSave']>>((values) => {
     setValues(values);
   }, []);
 
-  const contact1 = live(ContactType, { identifiers: [] });
-  const contact2 = live(ContactType, { identifiers: [] });
-
   const onQueryRefOptions = useCallback((typeInfo: TypeAnnotation) => {
     switch (typeInfo.typename) {
       case ContactType.typename:
@@ -278,7 +243,13 @@ const RefStory = ({ values: initialValues }: FormProps<any>) => {
   return (
     <TestLayout json={{ values, schema: RefSchema.ast.toJSON() }}>
       <TestPanel>
-        <Form schema={RefSchema} values={values} onSave={handleSave} onQueryRefOptions={onQueryRefOptions} />
+        <Form
+          schema={RefSchema}
+          values={values}
+          readonly={readonly}
+          onSave={handleSave}
+          onQueryRefOptions={onQueryRefOptions}
+        />
       </TestPanel>
     </TestLayout>
   );
@@ -286,5 +257,10 @@ const RefStory = ({ values: initialValues }: FormProps<any>) => {
 
 export const Refs: StoryObj<FormProps<ContactType>> = {
   render: RefStory,
-  args: { values: {} },
+  args: {
+    readonly: false,
+    values: {
+      refArray: [Ref.make(contact1), Ref.make(contact2)],
+    } as any,
+  },
 };

package/src/components/Form/Form.tsx

@@ -95,8 +95,7 @@ export const Form = <T extends BaseObject>({
       onValid={onValid}
       onSave={onSave}
     >
-      {/* TODO(burdon): Remove padding. */}
-      <div ref={formRef} role='none' className={mx('p-2', classNames)} data-testid={testId}>
+      <div ref={formRef} role='none' className={mx('flex flex-col gap-4', classNames)} data-testid={testId}>
         <FormFields
           schema={schema}
           path={path}

package/src/components/Form/FormActions.tsx

@@ -5,7 +5,6 @@
 import React from 'react';
 
 import { IconButton, useTranslation } from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
 
 import { useFormContext } from './FormContext';
 import { translationKey } from '../../translations';
@@ -15,27 +14,25 @@ export type FormActionsProps = {
   onCancel?: () => void;
 };
 
-export const FormActions = ({ onCancel, readonly }: FormActionsProps) => {
+export const FormActions = ({ readonly, onCancel }: FormActionsProps) => {
   const { t } = useTranslation(translationKey);
   const { canSave, handleSave } = useFormContext();
 
   return (
-    <div role='none' className='mt-2 flex justify-center'>
-      <div role='none' className={mx(onCancel && !readonly && 'grid grid-cols-2 gap-2')}>
-        {onCancel && !readonly && (
-          <IconButton data-testid='cancel-button' icon='ph--x--regular' label={t('button cancel')} onClick={onCancel} />
-        )}
-        {handleSave && (
-          <IconButton
-            type='submit'
-            data-testid='save-button'
-            disabled={!canSave}
-            icon='ph--check--regular'
-            label={t('button save')}
-            onClick={handleSave}
-          />
-        )}
-      </div>
+    <div role='none' className='flex [&_button]:grow gap-1'>
+      {onCancel && !readonly && (
+        <IconButton data-testid='cancel-button' icon='ph--x--regular' label={t('button cancel')} onClick={onCancel} />
+      )}
+      {handleSave && (
+        <IconButton
+          type='submit'
+          data-testid='save-button'
+          disabled={!canSave}
+          icon='ph--check--regular'
+          label={t('button save')}
+          onClick={handleSave}
+        />
+      )}
     </div>
   );
 };

package/src/components/Form/FormContent.tsx

@@ -7,6 +7,7 @@ import { capitalize } from 'effect/String';
 import React, { useMemo } from 'react';
 
 import { createJsonPath, findNode, getDiscriminatedType, isDiscriminatedUnion } from '@dxos/effect';
+import { type ThemedClassName } from '@dxos/react-ui';
 import { mx } from '@dxos/react-ui-theme';
 import { getSchemaProperties, type SchemaProperty } from '@dxos/schema';
 import { isNotFalsy } from '@dxos/util';
@@ -68,7 +69,7 @@ export const FormField = ({
   });
 
   if (FoundComponent) {
-    return <div role='none'>{FoundComponent}</div>;
+    return FoundComponent;
   }
 
   const jsonPath = createJsonPath(path ?? []);
@@ -124,17 +125,15 @@ export const FormField = ({
   const InputComponent = getInputComponent(type, format);
   if (InputComponent) {
     return (
-      <div role='none'>
-        <InputComponent
-          type={type}
-          format={format}
-          label={label}
-          inputOnly={inline}
-          placeholder={placeholder}
-          disabled={readonly}
-          {...inputProps}
-        />
-      </div>
+      <InputComponent
+        type={type}
+        format={format}
+        label={label}
+        inputOnly={inline}
+        placeholder={placeholder}
+        disabled={readonly}
+        {...inputProps}
+      />
     );
   }
 
@@ -144,18 +143,16 @@ export const FormField = ({
 
   if (options) {
     return (
-      <div role='none'>
-        <SelectInput
-          type={type}
-          format={format}
-          disabled={readonly}
-          inputOnly={inline}
-          label={label}
-          options={options.map((option) => ({ value: option, label: String(option) }))}
-          placeholder={placeholder}
-          {...inputProps}
-        />
-      </div>
+      <SelectInput
+        type={type}
+        format={format}
+        disabled={readonly}
+        inputOnly={inline}
+        label={label}
+        options={options.map((option) => ({ value: option, label: String(option) }))}
+        placeholder={placeholder}
+        {...inputProps}
+      />
     );
   }
 
@@ -171,8 +168,8 @@ export const FormField = ({
 
     if (typeLiteral) {
       return (
-        <div role='none'>
-          {!inline && <h3 className='text-lg mbs-2 mbe-1'>{label}</h3>}
+        <>
+          {!inline && <h3 className='text-lg mbs-2 mbe-1 first:mbs-0'>{label}</h3>}
           <FormFields
             schema={Schema.make(typeLiteral)}
             path={path}
@@ -181,7 +178,7 @@ export const FormField = ({
             Custom={Custom}
             lookupComponent={lookupComponent}
           />
-        </div>
+        </>
       );
     }
   }
@@ -189,27 +186,28 @@ export const FormField = ({
   return null;
 };
 
-export type FormContentProps = {
+export type FormFieldsProps = ThemedClassName<{
+  Custom?: Partial<Record<string, InputComponent>>;
   schema: Schema.Schema.All;
   path?: (string | number)[];
   filter?: (props: SchemaProperty<any>[]) => SchemaProperty<any>[];
   sort?: string[];
   readonly?: boolean;
-  onQueryRefOptions?: QueryRefOptions;
   lookupComponent?: ComponentLookup;
-  Custom?: Partial<Record<string, InputComponent>>;
-};
+  onQueryRefOptions?: QueryRefOptions;
+}>;
 
 export const FormFields = ({
+  classNames,
+  Custom,
   schema,
   path,
   filter,
   sort,
   readonly,
-  onQueryRefOptions,
   lookupComponent,
-  Custom,
-}: FormContentProps) => {
+  onQueryRefOptions,
+}: FormFieldsProps) => {
   const values = useFormValues(path);
 
   const properties = useMemo(() => {
@@ -220,7 +218,8 @@ export const FormFields = ({
   }, [schema, values, filter, sort]);
 
   return (
-    <div role='form' className={mx('flex flex-col w-full gap-2')}>
+    // TODO(burdon): Consistent padding (with composite forms).
+    <div role='form' className={mx('p-2 is-full', classNames)}>
       {properties
         .map((property) => {
           return (

package/src/components/Form/FormContext.tsx

@@ -10,6 +10,7 @@ import React, {
   useMemo,
   type FocusEvent,
   type PropsWithChildren,
+  useCallback,
 } from 'react';
 
 import { raise } from '@dxos/debug';
@@ -67,12 +68,8 @@ export const FormProvider = ({
 >) => {
   const form = useForm(formOptions);
 
-  useEffect(() => {
-    if (!formRef?.current) {
-      return;
-    }
-
-    const handleKeyDown = (event: KeyboardEvent) => {
+  const handleKeyDown = useCallback(
+    (event: KeyboardEvent) => {
       const keyIsEnter = event.key === 'Enter';
       const modifierUsed = event.ctrlKey || event.altKey || event.metaKey || event.shiftKey;
       const inputIsTextarea = (event.target as HTMLElement).tagName.toLowerCase() === 'textarea';
@@ -94,7 +91,14 @@ export const FormProvider = ({
           (event.target as HTMLElement).blur();
         }
       }
-    };
+    },
+    [form, autoSave],
+  );
+
+  useEffect(() => {
+    if (!formRef?.current) {
+      return;
+    }
 
     const formElement = formRef.current;
 

package/src/components/Form/Input.tsx

@@ -34,7 +34,7 @@ export type InputHeaderProps = PropsWithChildren<{
 
 export const InputHeader = ({ children, error }: InputHeaderProps) => {
   return (
-    <div role='none' className='flex justify-between items-center mb-1'>
+    <div role='none' className='flex justify-between items-center mbs-2 mbe-1 first:mbs-0'>
       {children}
       {error && (
         <Tooltip.Trigger asChild content={error} side='bottom'>

package/src/components/Form/RefField.tsx

@@ -14,13 +14,16 @@ import {
 } from '@dxos/echo-schema';
 import { findAnnotation } from '@dxos/effect';
 import { DXN } from '@dxos/keys';
-import { Input } from '@dxos/react-ui';
+import { DxRefTag } from '@dxos/lit-ui/react';
+import { Input, useTranslation } from '@dxos/react-ui';
 import { TagPicker, type TagPickerMode, type TagPickerItemData } from '@dxos/react-ui-tag-picker';
+import { descriptionText, mx } from '@dxos/react-ui-theme';
 import { isNonNullable } from '@dxos/util';
 
 import { TextInput } from './Defaults';
 import { InputHeader, type InputProps } from './Input';
 import { type QueryRefOptions, useQueryRefOptions } from '../../hooks';
+import { translationKey } from '../../translations';
 
 type RefFieldProps = InputProps & {
   ast?: SchemaAST.AST;
@@ -42,6 +45,7 @@ export const RefField = ({
   onValueChange,
   ...restInputProps
 }: RefFieldProps) => {
+  const { t } = useTranslation(translationKey);
   const refTypeInfo = useMemo(
     () => (ast ? findAnnotation<ReferenceAnnotationValue>(ast, ReferenceAnnotationId) : undefined),
     [ast],
@@ -127,7 +131,10 @@ export const RefField = ({
 
   const { status, error } = restInputProps.getStatus();
 
-  return (
+  const items = handleGetValue();
+
+  // NOTE(thure): I left both predicates in-place in case we decide to add variants which do render readonly but empty values.
+  return disabled && items.length < 1 ? null : (
     <Input.Root validationValence={status}>
       {!inputOnly && (
         <InputHeader error={error}>
@@ -135,14 +142,27 @@ export const RefField = ({
         </InputHeader>
       )}
       <div data-no-submit>
-        <TagPicker
-          items={handleGetValue()}
-          mode={tagPickerMode}
-          onBlur={(event) => onBlur(event as unknown as FocusEvent<HTMLElement>)}
-          onUpdate={handleUpdate}
-          onSearch={handleSearch}
-          classNames='rounded-sm bg-input p-1.5'
-        />
+        {disabled ? (
+          items.length < 1 ? (
+            <p className={mx(descriptionText, 'mbe-2')}>{t('empty readonly ref field label')}</p>
+          ) : (
+            items.map((item) => (
+              <DxRefTag key={item.id} refid={item.id} rootclassname='mie-1' style={{ marginInlineEnd: '.25rem' }}>
+                {item.label}
+              </DxRefTag>
+            ))
+          )
+        ) : (
+          <TagPicker
+            readonly={disabled}
+            items={items}
+            mode={tagPickerMode}
+            onBlur={(event) => onBlur(event as unknown as FocusEvent<HTMLElement>)}
+            onUpdate={handleUpdate}
+            onSearch={handleSearch}
+            classNames='rounded-sm bg-inputSurface p-1.5'
+          />
+        )}
       </div>
       {inputOnly && <Input.DescriptionAndValidation>{error}</Input.DescriptionAndValidation>}
     </Input.Root>