@dxos/react-ui-form 0.8.3 → 0.8.4-main.28f8d3d

package/src/components/ViewEditor/ViewEditor.tsx

@@ -11,21 +11,19 @@ import { invariant } from '@dxos/invariant';
 import { Callout, IconButton, type ThemedClassName, useTranslation } from '@dxos/react-ui';
 import { List } from '@dxos/react-ui-list';
 import { cardSpacing } from '@dxos/react-ui-stack';
-import { ghostHover, inputTextLabel, mx } from '@dxos/react-ui-theme';
-import { FieldSchema, type FieldType, type ViewType, ViewProjection, VIEW_FIELD_LIMIT } from '@dxos/schema';
+import { inputTextLabel, mx, subtleHover } from '@dxos/react-ui-theme';
+import { type DataType, FieldSchema, type FieldType, ProjectionModel, VIEW_FIELD_LIMIT } from '@dxos/schema';
 
 import { translationKey } from '../../translations';
 import { FieldEditor } from '../FieldEditor';
 import { Form, type FormProps } from '../Form';
 
-const grid = 'grid grid-cols-[32px_1fr_32px_32px] min-bs-[2.5rem]';
+const listGrid = 'grid grid-cols-[min-content_1fr_min-content_min-content_min-content]';
+const listItemGrid = 'grid grid-cols-subgrid col-span-5';
 
 const ViewMetaSchema = Schema.Struct({
-  name: Schema.String.annotations({
-    title: 'View',
-  }),
   typename: Format.URL.annotations({
-    title: 'Typename',
+    title: 'Record type',
   }),
 }).pipe(Schema.mutable);
 
@@ -34,7 +32,7 @@ type ViewMetaType = Schema.Schema.Type<typeof ViewMetaSchema>;
 export type ViewEditorProps = ThemedClassName<
   {
     schema: Schema.Schema.AnyNoContext;
-    view: ViewType;
+    view: DataType.View;
     registry?: SchemaRegistry;
     readonly?: boolean;
     showHeading?: boolean;
@@ -61,27 +59,23 @@ export const ViewEditor = ({
   const projection = useMemo(() => {
     // Use reactive and mutable version of json schema when schema is mutable.
     const jsonSchema = schema instanceof EchoSchema ? schema.jsonSchema : toJsonSchema(schema);
-    return new ViewProjection(jsonSchema, view);
-  }, [schema, view]);
-  const [field, setField] = useState<FieldType>();
+    return new ProjectionModel(jsonSchema, view.projection);
+  }, [schema, view.projection]);
+  const [expandedField, setExpandedField] = useState<FieldType['id']>();
   const readonly = _readonly || !isMutable(schema);
 
   // TODO(burdon): Should be reactive.
   const viewValues = useMemo(() => {
     return {
-      name: view.name,
       // TODO(burdon): Need to warn user of possible consequences of editing.
       // TODO(burdon): Settings should have domain name owned by user.
       typename: view.query.typename,
     };
-  }, [view]);
+  }, [view.query.typename]);
 
-  const handleSelect = useCallback(
+  const handleToggleField = useCallback(
     (field: FieldType) => {
-      if (readonly) {
-        return;
-      }
-      setField((f) => (f === field ? undefined : field));
+      setExpandedField((prevExpandedFieldId) => (prevExpandedFieldId === field.id ? undefined : field.id));
     },
     [readonly],
   );
@@ -91,56 +85,52 @@ export const ViewEditor = ({
   const handleAdd = useCallback(() => {
     invariant(!readonly);
     const field = projection.createFieldProjection();
-    setField(field);
-  }, [schema, view, readonly]);
+    setExpandedField(field.id);
+  }, [schema, projection, readonly]);
 
   const handleUpdate = useCallback(
-    ({ name, typename }: ViewMetaType) => {
+    ({ typename }: ViewMetaType) => {
       invariant(!readonly);
       requestAnimationFrame(() => {
-        if (view.name !== name) {
-          view.name = name;
-        }
-
         if (view.query.typename !== typename && !readonly) {
           onTypenameChanged?.(typename);
         }
       });
     },
-    [schema, view, onTypenameChanged, readonly],
+    [view.query.typename, onTypenameChanged, readonly],
   );
 
   const handleDelete = useCallback(
     (fieldId: string) => {
       invariant(!readonly);
-      if (fieldId === field?.id) {
-        setField(undefined);
+      if (fieldId === expandedField) {
+        setExpandedField(undefined);
       }
 
       onDelete?.(fieldId);
     },
-    [schema, field, onDelete, readonly],
+    [expandedField, onDelete, readonly],
   );
 
   const handleMove = useCallback(
     (fromIndex: number, toIndex: number) => {
       invariant(!readonly);
       // NOTE(ZaymonFC): Using arrayMove here causes a race condition with the kanban model.
-      const fields = [...view.fields];
+      const fields = [...view.projection.fields];
       const [moved] = fields.splice(fromIndex, 1);
       fields.splice(toIndex, 0, moved);
-      view.fields = fields;
+      view.projection.fields = fields;
     },
-    [schema, view.fields, readonly],
+    [view.projection.fields, readonly],
   );
 
-  const handleClose = useCallback(() => setField(undefined), []);
+  const handleClose = useCallback(() => setExpandedField(undefined), []);
 
   const hiddenProperties = projection.getHiddenProperties();
 
   const handleHide = useCallback(
     (fieldId: string) => {
-      setField(undefined);
+      setExpandedField(undefined);
       projection.hideFieldProjection(fieldId);
     },
     [projection],
@@ -148,7 +138,7 @@ export const ViewEditor = ({
 
   const handleShow = useCallback(
     (property: string) => {
-      setField(undefined);
+      setExpandedField(undefined);
       projection.showFieldProjection(property as JsonProp);
     },
     [projection],
@@ -157,11 +147,12 @@ export const ViewEditor = ({
   return (
     <div role='none' className={mx(classNames)}>
       {readonly && (
-        <div role='none' className={mx('is-full', outerSpacing && 'plb-cardSpacingBlock pli-cardSpacingInline')}>
-          <Callout.Root valence='info'>
-            <Callout.Title>{t('system schema description')}</Callout.Title>
-          </Callout.Root>
-        </div>
+        <Callout.Root
+          valence='info'
+          classNames={['is-full mlb-cardSpacingBlock', outerSpacing && 'mli-cardSpacingInline']}
+        >
+          <Callout.Title>{t('system schema description')}</Callout.Title>
+        </Callout.Root>
       )}
 
       {/* TODO(burdon): Is the form read-only or just the schema? */}
@@ -176,46 +167,65 @@ export const ViewEditor = ({
       />
 
       <div role='none' className={outerSpacing ? cardSpacing : 'mlb-cardSpacingBlock'}>
-        <label className={mx(inputTextLabel)}>{t('fields label')}</label>
+        <h2 className={mx(inputTextLabel)}>{t('fields label')}</h2>
 
         <List.Root<FieldType>
-          items={view.fields}
+          items={view.projection.fields}
           isItem={Schema.is(FieldSchema)}
           getId={(field) => field.id}
-          readonly={readonly}
           onMove={readonly ? undefined : handleMove}
+          readonly={readonly}
         >
           {({ items: fields }) => (
             <>
-              {showHeading && (
-                <div role='heading' className={grid}>
-                  <div />
-                  <div className='flex items-center text-sm'>{t('field path label')}</div>
-                </div>
-              )}
+              {showHeading && <h3 className='text-sm'>{t('field path label')}</h3>}
 
-              <div role='list' className='flex flex-col is-full'>
+              <div role='list' className={listGrid}>
                 {fields?.map((field) => (
                   <List.Item<FieldType>
                     key={field.id}
                     item={field}
-                    classNames={mx(grid, ghostHover, 'overflow-hidden', !readonly && 'cursor-pointer')}
+                    classNames={listItemGrid}
+                    aria-expanded={expandedField === field.id}
                   >
-                    <List.ItemDragHandle />
-                    <List.ItemTitle onClick={() => handleSelect(field)}>{field.path}</List.ItemTitle>
-                    <List.ItemButton
-                      data-testid='hide-field-button'
-                      icon='ph--eye-slash--regular'
-                      // TDOO(burdon): Is this the correct test?
-                      disabled={view.fields.length <= 1}
-                      onClick={() => handleHide(field.id)}
-                    />
-                    {/* TODO(burdon): Remove unless implement undo. */}
-                    {!readonly && (
+                    <div role='none' className={mx(subtleHover, listItemGrid, 'rounded-sm cursor-pointer min-bs-10')}>
+                      <List.ItemDragHandle disabled={readonly} />
+                      <List.ItemTitle onClick={() => handleToggleField(field)}>{field.path}</List.ItemTitle>
+                      <List.ItemButton
+                        label={t('hide field label')}
+                        data-testid='hide-field-button'
+                        icon='ph--eye-slash--regular'
+                        autoHide={false}
+                        // TDOO(burdon): Is this the correct test?
+                        disabled={readonly || view.projection.fields.length <= 1}
+                        onClick={() => handleHide(field.id)}
+                      />
+                      {/* TODO(burdon): Remove unless implement undo. */}
                       <List.ItemDeleteButton
-                        disabled={view.fields.length <= 1}
+                        label={t('delete field label')}
+                        autoHide={false}
+                        disabled={readonly || view.projection.fields.length <= 1}
                         onClick={() => handleDelete(field.id)}
+                        data-testid='field.delete'
                       />
+                      <IconButton
+                        iconOnly
+                        variant='ghost'
+                        label={t('toggle expand label', { ns: 'os' })}
+                        icon={expandedField === field.id ? 'ph--caret-down--regular' : 'ph--caret-right--regular'}
+                        onClick={() => handleToggleField(field)}
+                      />
+                    </div>
+                    {expandedField === field.id && (
+                      <div role='none' className='col-span-5'>
+                        <FieldEditor
+                          readonly={readonly}
+                          projection={projection}
+                          field={field}
+                          registry={registry}
+                          onSave={handleClose}
+                        />
+                      </div>
                     )}
                   </List.Item>
                 ))}
@@ -226,7 +236,7 @@ export const ViewEditor = ({
 
         {hiddenProperties.length > 0 && (
           <>
-            <label className={mx(inputTextLabel)}>{t('hidden fields label')}</label>
+            <h2 className={mx(inputTextLabel)}>{t('hidden fields label')}</h2>
 
             <List.Root<string>
               items={hiddenProperties}
@@ -234,16 +244,17 @@ export const ViewEditor = ({
               getId={(property) => property}
             >
               {({ items: properties }) => (
-                <div role='list' className='flex flex-col is-full'>
+                <div role='list' className='grid grid-cols-[1fr_min-content]'>
                   {properties?.map((property) => (
                     <List.Item<string>
                       key={property}
                       item={property}
-                      classNames={mx(grid, ghostHover, !readonly && 'cursor-pointer')}
+                      classNames={mx('grid grid-cols-subgrid col-span-2 rounded-sm', subtleHover)}
                     >
-                      <List.ItemDragHandle disabled />
                       <List.ItemTitle>{property}</List.ItemTitle>
                       <List.ItemButton
+                        label={t('show field label')}
+                        disabled={readonly}
                         icon='ph--eye--regular'
                         onClick={() => handleShow(property)}
                         data-testid='show-field-button'
@@ -257,26 +268,15 @@ export const ViewEditor = ({
         )}
       </div>
 
-      {field && (
-        <FieldEditor
-          key={field.id}
-          view={view}
-          projection={projection}
-          field={field}
-          registry={registry}
-          onSave={handleClose}
-        />
-      )}
-
-      {!readonly && !field && (
+      {!readonly && !expandedField && (
         <div role='none' className={outerSpacing ? cardSpacing : 'mlb-cardSpacingBlock'}>
           <IconButton
             icon='ph--plus--regular'
             label={t('button add property')}
             onClick={readonly ? undefined : handleAdd}
             // TODO(burdon): Show field limit in ux (not tooltip).
-            disabled={view.fields.length >= VIEW_FIELD_LIMIT}
-            classNames='flex is-full'
+            disabled={view.projection.fields.length >= VIEW_FIELD_LIMIT}
+            classNames='is-full'
           />
         </div>
       )}

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

@@ -4,17 +4,18 @@
 
 import '@dxos-theme';
 
-import { type Meta, type StoryObj } from '@storybook/react';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React from 'react';
 
 import { live } from '@dxos/live-object';
-import { testData, TestSchema, testView, type TestType } from '@dxos/schema/testing';
+import { TestSchema, type TestType, testData, testView } from '@dxos/schema/testing';
 import { withLayout, withTheme } from '@dxos/storybook-utils';
 
-import { DeprecatedForm, type DeprecatedFormProps } from './Form';
-import translations from '../../translations';
+import { translations } from '../../translations';
 import { TestLayout, TestPanel } from '../testing';
 
+import { DeprecatedForm, type DeprecatedFormProps } from './Form';
+
 const DefaultStory = (props: DeprecatedFormProps) => (
   <TestLayout json={{ props }}>
     <TestPanel>
@@ -40,14 +41,14 @@ type Story = StoryObj<DeprecatedFormProps<TestType>>;
 export const Default: Story = {
   args: {
     object: live(testData),
-    view: live(testView),
+    projection: live(testView).projection,
     schema: TestSchema,
   },
 };
 
 export const Empty: Story = {
   args: {
-    view: live(testView),
+    projection: live(testView).projection,
     schema: TestSchema,
   },
 };
@@ -55,7 +56,7 @@ export const Empty: Story = {
 export const Readonly: Story = {
   args: {
     object: live(testData),
-    view: live(testView),
+    projection: live(testView).projection,
     schema: TestSchema,
     readonly: true,
   },

package/src/components/deprecated/Form.tsx

@@ -2,16 +2,16 @@
 // Copyright 2024 DXOS.org
 //
 
-import { SchemaAST, type Schema, Option, pipe } from 'effect';
+import { Option, type Schema, SchemaAST, pipe } from 'effect';
 import React, { useState } from 'react';
 
 import { findProperty } from '@dxos/effect';
-import { Input, type ThemedClassName, type TextInputProps as NativeTextInputProps } from '@dxos/react-ui';
+import { Input, type TextInputProps as NativeTextInputProps, type ThemedClassName } from '@dxos/react-ui';
 import { mx } from '@dxos/react-ui-theme';
-import { type ViewType, getFieldValue, setFieldValue } from '@dxos/schema';
+import { type Projection, getFieldValue, setFieldValue } from '@dxos/schema';
 
 export type DeprecatedFormProps<T extends {} = {}> = ThemedClassName<{
-  view: ViewType;
+  projection: Projection;
   object: T;
   schema?: Schema.Schema<T>;
   readonly?: boolean;
@@ -22,14 +22,14 @@ export type DeprecatedFormProps<T extends {} = {}> = ThemedClassName<{
  */
 export const DeprecatedForm = <T extends {} = {}>({
   classNames,
-  view,
+  projection,
   object,
   schema,
   readonly,
 }: DeprecatedFormProps<T>) => {
   return (
     <div role='none' className={mx('flex flex-col w-full gap-2 p-2', classNames)}>
-      {view.fields.map((field) => {
+      {projection.fields.map((field) => {
         const prop = schema && findProperty(schema, field.path);
         const title = (prop && pipe(SchemaAST.getTitleAnnotation(prop), Option.getOrUndefined)) ?? '';
         const description = (prop && pipe(SchemaAST.getDescriptionAnnotation(prop), Option.getOrUndefined)) ?? title;

package/src/components/testing.tsx

@@ -17,7 +17,7 @@ export const TestLayout = ({ classNames, json, children }: ThemedClassName<Props
 );
 
 export const TestPanel = ({ classNames, children }: ThemedClassName<PropsWithChildren>) => (
-  <Card.Content classNames={[textBlockWidth, classNames]}>{children}</Card.Content>
+  <Card.StaticRoot classNames={[textBlockWidth, classNames]}>{children}</Card.StaticRoot>
 );
 
 // Symbol for accessing debug objects in tests.

package/src/hooks/useForm.ts

@@ -2,14 +2,14 @@
 // Copyright 2025 DXOS.org
 //
 
-import { SchemaAST, type Schema } from 'effect';
+import { type Schema, SchemaAST } from 'effect';
 import { useCallback, useEffect, useMemo, useState } from 'react';
 
 import { type BaseObject, getValue, setValue } from '@dxos/echo-schema';
-import { type SimpleType, type JsonPath, createJsonPath, fromEffectValidationPath } from '@dxos/effect';
+import { type JsonPath, type SimpleType, createJsonPath, fromEffectValidationPath } from '@dxos/effect';
 import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
-import { validateSchema, type ValidationError } from '@dxos/schema';
+import { type ValidationError, validateSchema } from '@dxos/schema';
 import { type MaybePromise } from '@dxos/util';
 
 /**
@@ -26,6 +26,8 @@ export type FormHandler<T extends BaseObject> = {
   changed: Record<JsonPath, boolean>;
   canSave: boolean;
   formIsValid: boolean;
+
+  // TODO(burdon): Return onSave.
   handleSave: () => void;
 
   //

package/src/hooks/useRefQueryLookupHandler.ts

@@ -4,7 +4,7 @@
 
 import { useCallback } from 'react';
 
-import { getObjectDXN, type TypeAnnotation } from '@dxos/echo-schema';
+import { type TypeAnnotation, getObjectDXN } from '@dxos/echo-schema';
 import { Filter, type Space } from '@dxos/react-client/echo';
 import { isNonNullable } from '@dxos/util';
 

package/src/index.ts

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import translations from './translations';
+import { translations } from './translations';
 
 export * from './components';
 export * from './hooks';

package/src/translations.ts

@@ -2,9 +2,11 @@
 // Copyright 2023 DXOS.org
 //
 
+import { type Resource } from '@dxos/react-ui';
+
 export const translationKey = 'react-ui-form';
 
-export default [
+export const translations = [
   {
     'en-US': {
       [translationKey]: {
@@ -23,6 +25,7 @@ export default [
         'field limit reached': 'Maximum number of fields reached',
         'boolean input true value': 'Yes',
         'boolean input false value': 'No',
+        'delete field label': 'Delete field',
 
         // TODO(burdon): Factor out?
         'button cancel': 'Cancel',
@@ -70,9 +73,9 @@ export default [
         'select option add': 'Add option',
 
         // System schema message.
-        'system schema title': 'System Schema',
-        'system schema description': 'This is a system schema and cannot be modified.',
+        'system schema title': 'System record type',
+        'system schema description': 'This is a system record type and cannot be modified.',
       },
     },
   },
-];
+] as const satisfies Resource[];