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

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,16 +68,14 @@ 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';
-      const inputOptOut = (event.target as HTMLElement).hasAttribute('data-no-submit');
+      const inputOptOut =
+        (event.target as HTMLElement).hasAttribute('data-no-submit') ||
+        (event.target as HTMLElement).closest('[data-no-submit]') !== null;
 
       // Regular inputs: Submit on Enter (no modifiers).
       const shouldSubmitRegularInput = !inputIsTextarea && keyIsEnter && !modifierUsed;
@@ -92,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,18 +34,12 @@ 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.Root>
-          <Tooltip.Trigger asChild>
-            <Icon icon='ph--warning--regular' size={4} classNames={errorText} />
-          </Tooltip.Trigger>
-          <Tooltip.Content side='bottom'>
-            <Tooltip.Arrow />
-            {error}
-          </Tooltip.Content>
-        </Tooltip.Root>
+        <Tooltip.Trigger asChild content={error} side='bottom'>
+          <Icon icon='ph--warning--regular' size={4} classNames={errorText} />
+        </Tooltip.Trigger>
       )}
     </div>
   );

package/src/components/Form/RefField.tsx

@@ -2,149 +2,215 @@
 // Copyright 2025 DXOS.org
 //
 
-import React, { useEffect, useState } from 'react';
+import { type SchemaAST } from 'effect';
+import React, { useCallback, useMemo, type FocusEvent } from 'react';
 
 import {
-  type AST,
   Expando,
   getTypeAnnotation,
+  Ref,
   ReferenceAnnotationId,
   type ReferenceAnnotationValue,
-  type TypeAnnotation,
 } from '@dxos/echo-schema';
-import { findAnnotation, type SimpleType } from '@dxos/effect';
+import { findAnnotation } from '@dxos/effect';
 import { DXN } from '@dxos/keys';
-import { refFromDXN, RefImpl } from '@dxos/live-object';
-import { log } from '@dxos/log';
-import { type MaybePromise } from '@dxos/util';
-
-import { SelectInput, TextInput } from './Defaults';
-import { type FormInputStateProps } from './FormContext';
-
-export type QueryRefOptions = (type: TypeAnnotation) => MaybePromise<{ dxn: DXN; label?: string }[]>;
-
-type RefFieldProps = {
-  ast: AST.AST;
-  type: SimpleType;
-  label: string;
-  readonly?: boolean;
-  placeholder?: string;
-  inline?: boolean;
+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;
+  array?: boolean;
   onQueryRefOptions?: QueryRefOptions;
-  inputProps: FormInputStateProps;
 };
 
 export const RefField = ({
-  ast,
   type,
   label,
-  readonly,
+  disabled,
   placeholder,
-  inline,
+  inputOnly,
+  array,
+  ast,
+  getValue,
+  onBlur,
   onQueryRefOptions,
-  inputProps,
+  onValueChange,
+  ...restInputProps
 }: RefFieldProps) => {
-  const { getValue, onValueChange, ...restInputProps } = inputProps;
-  const refTypeInfo = findAnnotation<ReferenceAnnotationValue>(ast, ReferenceAnnotationId);
-  const [refOptions, setRefOptions] = useState<Array<{ value: string; label?: string }>>([]);
-  const [loading, setLoading] = useState(false);
-
-  useEffect(() => {
-    if (!refTypeInfo || !onQueryRefOptions) {
-      return;
-    }
+  const { t } = useTranslation(translationKey);
+  const refTypeInfo = useMemo(
+    () => (ast ? findAnnotation<ReferenceAnnotationValue>(ast, ReferenceAnnotationId) : undefined),
+    [ast],
+  );
+  const { options: availableOptions, loading: _loading } = useQueryRefOptions({ refTypeInfo, onQueryRefOptions });
+
+  if ((refTypeInfo && refTypeInfo?.typename === getTypeAnnotation(Expando)?.typename) || !onQueryRefOptions) {
+    // If ref type is expando, fall back to taking a DXN in string format.
+    return (
+      <RefFieldFallback
+        {...{ type, label, placeholder, disabled, inputOnly, getValue, onBlur, onValueChange, ...restInputProps }}
+      />
+    );
+  }
 
-    const fetchOptions = async () => {
-      setLoading(true);
-      try {
-        const options = await onQueryRefOptions(refTypeInfo);
-        setRefOptions(
-          options.map((option) => ({
-            label: option.label,
-            value: option.dxn.toString(),
-          })),
-        );
-      } catch (error) {
-        log.error('Failed to fetch ref options:', error);
-        setRefOptions([]);
-      } finally {
-        setLoading(false);
+  const handleGetValue = useCallback((): TagPickerItemData[] => {
+    const formValue = getValue();
+
+    const unknownToRefOption = (val: unknown) => {
+      if (Ref.isRef(val)) {
+        const dxnString = val.dxn.toString();
+        const matchingOption = availableOptions.find((option) => option.id === dxnString);
+        if (matchingOption) {
+          return matchingOption;
+        }
       }
+      return undefined;
     };
 
-    void fetchOptions();
-  }, [refTypeInfo, onQueryRefOptions]);
+    if (array && Array.isArray(formValue)) {
+      return formValue.map(unknownToRefOption).filter(isNonNullable) ?? [];
+    }
 
-  if (!refTypeInfo) {
-    return null;
-  }
+    const option = unknownToRefOption(formValue);
+    if (option) {
+      return [option];
+    }
 
-  // If ref type is expando, fall back to taking a DXN in string format.
-  if (refTypeInfo.typename === getTypeAnnotation(Expando)?.typename || !onQueryRefOptions) {
-    const handleOnValueChange = (_type: any, dxnString: string) => {
-      const dxn = DXN.tryParse(dxnString);
-      if (dxn) {
-        onValueChange?.('object', refFromDXN(dxn));
-      } else if (dxnString === '') {
-        onValueChange?.('object', undefined);
-      } else {
-        onValueChange?.('string', dxnString);
-      }
-    };
+    return [];
+  }, [getValue, availableOptions, array]);
 
-    const handleGetValue = () => {
-      const formValue = getValue();
-      if (typeof formValue === 'string') {
-        return formValue;
+  const handleSearch = useCallback(
+    (text: string, ids: string[]): TagPickerItemData[] =>
+      availableOptions
+        .filter((option) => !ids.includes(option.id))
+        .filter((option) => option.label.toLowerCase().includes(text.toLowerCase()))
+        .map((option) => ({ id: option.id, label: option.label, hue: option.hue as any })),
+    [availableOptions],
+  );
+
+  const handleUpdate = useCallback(
+    (ids: string[]) => {
+      if (ids.length === 0) {
+        onValueChange('object', undefined);
+        return;
       }
-      if (formValue instanceof RefImpl) {
-        return formValue.dxn.toString();
+
+      const refs = ids
+        .map((id) => {
+          const item = availableOptions.find((option) => option.id === id);
+          if (item) {
+            const dxn = DXN.parse(item.id);
+            return Ref.fromDXN(dxn);
+          }
+          return null;
+        })
+        .filter(isNonNullable);
+
+      if (array) {
+        onValueChange('object', refs);
+      } else {
+        onValueChange('object', refs[0]);
       }
+    },
+    [availableOptions, array, onValueChange],
+  );
 
-      return undefined;
-    };
+  const tagPickerMode: TagPickerMode = useMemo(() => (array ? 'multi-select' : 'single-select'), [array]);
 
-    return (
-      <TextInput
-        type={type}
-        label={label}
-        disabled={readonly}
-        placeholder={placeholder}
-        inputOnly={inline}
-        getValue={handleGetValue as <V>() => V | undefined}
-        onValueChange={handleOnValueChange}
-        {...restInputProps}
-      />
-    );
+  if (!refTypeInfo) {
+    return null;
   }
 
+  const { status, error } = restInputProps.getStatus();
+
+  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}>
+          <Input.Label>{label}</Input.Label>
+        </InputHeader>
+      )}
+      <div data-no-submit>
+        {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>
+  );
+};
+
+const RefFieldFallback = ({
+  type,
+  label,
+  disabled,
+  placeholder,
+  inputOnly,
+  getValue,
+  onValueChange,
+  ...restInputProps
+}: InputProps) => {
+  const handleOnValueChange = (_type: any, dxnString: string) => {
+    const dxn = DXN.tryParse(dxnString);
+    if (dxn) {
+      onValueChange?.('object', Ref.fromDXN(dxn));
+    } else if (dxnString === '') {
+      onValueChange?.('object', undefined);
+    } else {
+      onValueChange?.('string', dxnString);
+    }
+  };
+
   const handleGetValue = () => {
     const formValue = getValue();
-
-    if (formValue instanceof RefImpl) {
+    if (typeof formValue === 'string') {
+      return formValue;
+    }
+    if (Ref.isRef(formValue)) {
       return formValue.dxn.toString();
     }
 
     return undefined;
   };
 
-  const handleValueChanged = (_type: any, dxnString: string) => {
-    const dxn = DXN.parse(dxnString);
-    const ref = refFromDXN(dxn);
-
-    onValueChange('object', ref);
-  };
-
   return (
-    <SelectInput
+    <TextInput
       type={type}
       label={label}
-      disabled={readonly || loading}
-      placeholder={loading ? 'Loading options...' : placeholder}
-      inputOnly={inline}
+      disabled={disabled}
+      placeholder={placeholder}
+      inputOnly={inputOnly}
       getValue={handleGetValue as <V>() => V | undefined}
-      onValueChange={handleValueChanged}
-      options={refOptions}
+      onValueChange={handleOnValueChange}
       {...restInputProps}
     />
   );

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

@@ -5,9 +5,10 @@
 import '@dxos-theme';
 
 import { type Meta, type StoryObj } from '@storybook/react';
+import { Schema } from 'effect';
 import React, { useState } from 'react';
 
-import { S, SelectOptionSchema, type SelectOption } from '@dxos/echo-schema';
+import { SelectOptionSchema, type SelectOption } from '@dxos/echo-schema';
 import { withLayout, withTheme } from '@dxos/storybook-utils';
 
 import { SelectOptionInput } from './SelectOptionsInput';
@@ -15,9 +16,9 @@ import translations from '../../../translations';
 import { TestLayout, TestPanel } from '../../testing';
 import { Form } from '../Form';
 
-const schema = S.Struct({
-  options: S.Array(SelectOptionSchema).pipe(S.mutable),
-}).pipe(S.mutable);
+const schema = Schema.Struct({
+  options: Schema.Array(SelectOptionSchema).pipe(Schema.mutable),
+}).pipe(Schema.mutable);
 
 const DefaultStory = () => {
   const [values, setValues] = useState<{ options: SelectOption[] }>({
@@ -46,7 +47,7 @@ const DefaultStory = () => {
 const meta: Meta = {
   title: 'ui/react-ui-form/SelectOptionsInput',
   component: SelectOptionInput,
-  decorators: [withTheme, withLayout({ tooltips: true })],
+  decorators: [withTheme, withLayout()],
   parameters: { translations },
 };
 

package/src/components/Form/factory.tsx

@@ -12,7 +12,7 @@ import { GeoPointInput } from './custom';
 /**
  * Get property input component.
  */
-export const getInputComponent = (type: SimpleType, format?: FormatEnum): InputComponent | undefined => {
+export const getInputComponent = (type: SimpleType, format?: FormatEnum | string): InputComponent | undefined => {
   switch (format) {
     case FormatEnum.GeoPoint:
       return GeoPointInput;

package/src/components/Form/index.ts

@@ -3,7 +3,6 @@
 //
 
 export * from './custom';
-
 export * from './Defaults';
 export * from './Form';
 export * from './FormContext';

package/src/components/ViewEditor/ViewEditor.stories.tsx

@@ -5,20 +5,23 @@
 import '@dxos-theme';
 
 import { type Meta, type StoryObj } from '@storybook/react';
+import { Schema } from 'effect';
 import React, { useCallback, useMemo, useState } from 'react';
 
-import { Format, type EchoSchema, S, toJsonSchema, TypedObject } from '@dxos/echo-schema';
+import { Format, type EchoSchema, toJsonSchema, TypedObject } from '@dxos/echo-schema';
 import { Filter, useQuery, useSpace } from '@dxos/react-client/echo';
 import { withClientProvider } from '@dxos/react-client/testing';
 import { useAsyncEffect } from '@dxos/react-ui';
 import { ViewProjection, ViewType, createView } from '@dxos/schema';
 import { withTheme, withLayout } from '@dxos/storybook-utils';
 
-import { ViewEditor } from './ViewEditor';
+import { ViewEditor, type ViewEditorProps } from './ViewEditor';
 import translations from '../../translations';
 import { TestLayout, TestPanel } from '../testing';
 
-const DefaultStory = () => {
+type StoryProps = Pick<ViewEditorProps, 'readonly'>;
+
+const DefaultStory = (props: StoryProps) => {
   const space = useSpace();
   const [schema, setSchema] = useState<EchoSchema>();
   const [view, setView] = useState<ViewType>();
@@ -26,7 +29,7 @@ const DefaultStory = () => {
   useAsyncEffect(async () => {
     if (space) {
       class TestSchema extends TypedObject({ typename: 'example.com/type/Test', version: '0.1.0' })({
-        name: S.String,
+        name: Schema.String,
         email: Format.Email,
         salary: Format.Currency(),
       }) {}
@@ -41,7 +44,7 @@ const DefaultStory = () => {
     }
   }, [space]);
 
-  const views = useQuery(space, Filter.schema(ViewType));
+  const views = useQuery(space, Filter.type(ViewType));
   const currentTypename = useMemo(() => view?.query?.typename, [view]);
   const updateViewTypename = useCallback(
     (newTypename: string) => {
@@ -56,6 +59,7 @@ const DefaultStory = () => {
     },
     [views, schema],
   );
+
   const handleDelete = useCallback((property: string) => projection?.deleteFieldProjection(property), [projection]);
 
   if (!schema || !view || !projection) {
@@ -69,6 +73,7 @@ const DefaultStory = () => {
           schema={schema}
           view={view}
           registry={space?.db.schemaRegistry}
+          readonly={props.readonly}
           onTypenameChanged={updateViewTypename}
           onDelete={handleDelete}
         />
@@ -77,11 +82,10 @@ const DefaultStory = () => {
   );
 };
 
-const meta: Meta<typeof ViewEditor> = {
+const meta: Meta<StoryProps> = {
   title: 'ui/react-ui-form/ViewEditor',
-  component: ViewEditor,
   render: DefaultStory,
-  decorators: [withClientProvider({ createSpace: true }), withLayout({ fullscreen: true, tooltips: true }), withTheme],
+  decorators: [withClientProvider({ createSpace: true }), withLayout({ fullscreen: true }), withTheme],
   parameters: {
     translations,
   },
@@ -89,6 +93,12 @@ const meta: Meta<typeof ViewEditor> = {
 
 export default meta;
 
-type Story = StoryObj;
+type Story = StoryObj<StoryProps>;
 
 export const Default: Story = {};
+
+export const Readonly: Story = {
+  args: {
+    readonly: true,
+  },
+};