@dxos/react-ui-form 0.7.4 → 0.7.5-labs.071a3e2

package/src/components/Form/FormContent.tsx

@@ -0,0 +1,173 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { pipe } from 'effect';
+import { capitalize } from 'effect/String';
+import React, { useMemo } from 'react';
+
+import { AST, S } from '@dxos/echo-schema';
+import { createJsonPath, findNode, getDiscriminatedType, isDiscriminatedUnion } from '@dxos/effect';
+import { mx } from '@dxos/react-ui-theme';
+import { getSchemaProperties, type SchemaProperty } from '@dxos/schema';
+import { isNotFalsy } from '@dxos/util';
+
+import { ArrayField } from './ArrayField';
+import { SelectInput } from './Defaults';
+import { type ComponentLookup } from './Form';
+import { useInputProps, useFormValues } from './FormContext';
+import { type InputComponent } from './Input';
+import { getInputComponent } from './factory';
+
+export type FormContentProps = {
+  schema: S.Schema.All;
+  path?: (string | number)[];
+  filter?: (props: SchemaProperty<any>[]) => SchemaProperty<any>[];
+  sort?: string[];
+  readonly?: boolean;
+  lookupComponent?: ComponentLookup;
+  Custom?: Partial<Record<string, InputComponent>>;
+};
+
+export type FormFieldProps = {
+  property: SchemaProperty<any>;
+  path?: (string | number)[];
+  readonly?: boolean;
+  /** Used to indicate if input should be presented inline (e.g. for array items). */
+  inline?: boolean;
+  lookupComponent?: ComponentLookup;
+  Custom?: Partial<Record<string, InputComponent>>;
+};
+
+export const FormField = ({ property, path, readonly, inline, lookupComponent, Custom }: FormFieldProps) => {
+  const inputProps = useInputProps(path);
+  const { ast, name, type, format, title, description, options, examples, array } = property;
+
+  const label = useMemo(() => title ?? pipe(name, capitalize), [title, name]);
+  const placeholder = useMemo(
+    () => (examples?.length ? `Example: "${examples[0]}"` : description),
+    [examples, description],
+  );
+
+  const FoundComponent = lookupComponent?.({
+    prop: name,
+    schema: S.make(ast),
+    inputProps: {
+      type,
+      format,
+      label,
+      disabled: readonly,
+      placeholder,
+      ...inputProps,
+    },
+  });
+
+  if (FoundComponent) {
+    return <div role='none'>{FoundComponent}</div>;
+  }
+
+  const jsonPath = createJsonPath(path ?? []);
+  const CustomComponent = Custom?.[jsonPath];
+  if (CustomComponent) {
+    return (
+      // TODO(ZaymonFC): We should try to remove this div wrapper.
+      <div role='none'>
+        <CustomComponent
+          type={type}
+          format={format}
+          label={label}
+          inputOnly={inline}
+          placeholder={placeholder}
+          disabled={readonly}
+          {...inputProps}
+        />
+      </div>
+    );
+  }
+
+  if (array) {
+    return <ArrayField property={property} path={path} inputProps={inputProps} readonly={readonly} Custom={Custom} />;
+  }
+
+  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>
+    );
+  }
+
+  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>
+    );
+  }
+
+  if (type === 'object') {
+    const baseNode = findNode(ast, isDiscriminatedUnion);
+    const typeLiteral = baseNode
+      ? getDiscriminatedType(baseNode, inputProps.getValue() as any)
+      : findNode(ast, AST.isTypeLiteral);
+
+    if (typeLiteral) {
+      return (
+        <div role='none'>
+          {!inline && <div>{label}</div>}
+          <FormFields schema={S.make(typeLiteral)} path={path} readonly={readonly} Custom={Custom} />
+        </div>
+      );
+    }
+  }
+
+  return null;
+};
+
+export const FormFields = ({ schema, path, filter, sort, readonly, lookupComponent, Custom }: FormContentProps) => {
+  const values = useFormValues(path);
+
+  const properties = useMemo(() => {
+    const props = getSchemaProperties(schema.ast, values);
+    const filtered = filter ? filter(props) : props;
+
+    return sort ? filtered.sort((a, b) => sort.indexOf(a.name) - sort.indexOf(b.name)) : filtered;
+  }, [schema, values, filter, sort]);
+
+  return (
+    <div role='form' className={mx('flex flex-col w-full gap-2 py-2')}>
+      {properties
+        .map((property) => {
+          return (
+            <FormField
+              key={property.name}
+              property={property}
+              path={[...(path ?? []), property.name]}
+              readonly={readonly}
+              lookupComponent={lookupComponent}
+              Custom={Custom}
+            />
+          );
+        })
+        .filter(isNotFalsy)}
+    </div>
+  );
+};

package/src/components/Form/FormContext.tsx

@@ -0,0 +1,48 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { createContext, useContext, type FocusEvent, type PropsWithChildren } from 'react';
+
+import { raise } from '@dxos/debug';
+import { type BaseObject, getValue } from '@dxos/echo-schema';
+import { createJsonPath, type SimpleType } from '@dxos/effect';
+
+import { type FormHandler, type FormOptions, useForm } from '../../hooks';
+
+type FormContextValue<T extends BaseObject> = FormHandler<T>;
+
+const FormContext = createContext<FormContextValue<any> | undefined>(undefined);
+
+export const useFormContext = <T extends BaseObject>(): FormContextValue<T> => {
+  return useContext(FormContext) ?? raise(new Error('Missing FormContext'));
+};
+
+export const useFormValues = (path: (string | number)[] = []): any => {
+  const { values: formValues } = useFormContext();
+  const jsonPath = createJsonPath(path);
+  return getValue(formValues, jsonPath) as BaseObject;
+};
+
+export type FormInputStateProps = {
+  getStatus: () => { status?: 'error'; error?: string };
+  getValue: <V>() => V | undefined;
+  onValueChange: (type: SimpleType, value: any) => void;
+  onBlur: (event: FocusEvent<HTMLElement>) => void;
+};
+
+export const useInputProps = (path: (string | number)[] = []): FormInputStateProps => {
+  const { getStatus, getValue: getFormValue, onValueChange, onTouched } = useFormContext();
+
+  return {
+    getStatus: () => getStatus(path),
+    getValue: () => getFormValue(path),
+    onValueChange: (type: SimpleType, value: any) => onValueChange(path, type, value),
+    onBlur: () => onTouched(path),
+  };
+};
+
+export const FormProvider = ({ children, ...formOptions }: PropsWithChildren<FormOptions<any>>) => {
+  const formHandler = useForm(formOptions);
+  return <FormContext.Provider value={formHandler}>{children}</FormContext.Provider>;
+};

package/src/components/Form/Input.tsx

@@ -4,30 +4,29 @@
 
 import React, { type FC, type PropsWithChildren } from 'react';
 
-import { type BaseObject, type FormatEnum } from '@dxos/echo-schema';
+import { type FormatEnum } from '@dxos/echo-schema';
 import { type SimpleType } from '@dxos/effect';
 import { Icon, Tooltip } from '@dxos/react-ui';
 import { errorText } from '@dxos/react-ui-theme';
 
-import { type FormPath, type FormHandler } from '../../hooks';
+import { type FormInputStateProps } from './FormContext';
 
 /**
  * Props passed to input components.
  */
-export type InputProps<T extends BaseObject> = {
-  property: FormPath<T>;
+export type InputProps = {
   type: SimpleType;
   format?: FormatEnum;
   label?: string;
   disabled?: boolean;
   placeholder?: string;
   inputOnly?: boolean;
-} & Pick<FormHandler<T>, 'getStatus' | 'getValue' | 'onValueChange' | 'onBlur'>;
+} & FormInputStateProps;
 
 /**
  * Form input component.
  */
-export type InputComponent<T extends BaseObject> = FC<InputProps<T>>;
+export type InputComponent = FC<InputProps>;
 
 export type InputHeaderProps = PropsWithChildren<{
   error?: string;

package/src/components/Form/custom/GeoPointInput.tsx

@@ -0,0 +1,44 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React from 'react';
+
+import { type GeoPoint } from '@dxos/echo-schema';
+import { Input, useTranslation } from '@dxos/react-ui';
+import { safeParseFloat } from '@dxos/util';
+
+import { translationKey } from '../../../translations';
+import { InputHeader, type InputProps } from '../Input';
+
+export const GeoPointInput = ({ type, label, disabled, getStatus, getValue, onValueChange, onBlur }: InputProps) => {
+  const { t } = useTranslation(translationKey);
+  const { status, error } = getStatus();
+  const [lng = 0, lat = 0] = getValue<GeoPoint>() ?? [];
+
+  return (
+    <Input.Root validationValence={status}>
+      <InputHeader error={error}>
+        <Input.Label>{label}</Input.Label>
+      </InputHeader>
+      <div className='grid grid-cols-2 gap-2'>
+        <Input.TextInput
+          type='number'
+          disabled={disabled}
+          placeholder={t('placeholder longitude')}
+          value={lng}
+          onChange={(event) => onValueChange(type, [lat, safeParseFloat(event.target.value, 0)])}
+          onBlur={onBlur}
+        />
+        <Input.TextInput
+          type='number'
+          disabled={disabled}
+          placeholder={t('placeholder latitude')}
+          value={lat}
+          onChange={(event) => onValueChange(type, [safeParseFloat(event.target.value, 0), lng])}
+          onBlur={onBlur}
+        />
+      </div>
+    </Input.Root>
+  );
+};

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

@@ -0,0 +1,58 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import '@dxos-theme';
+
+import { type Meta, type StoryObj } from '@storybook/react';
+import React, { useState } from 'react';
+
+import { S, SelectOptionSchema, type SelectOption } from '@dxos/echo-schema';
+import { withLayout, withTheme } from '@dxos/storybook-utils';
+
+import { SelectOptionInput } from './SelectOptionsInput';
+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 DefaultStory = () => {
+  const [values, setValues] = useState<{ options: SelectOption[] }>({
+    // TODO(Zaymon): Pick colors from our limited set.
+    options: [
+      { id: 'opt_1', title: 'First option', color: 'amber' },
+      { id: 'opt_2', title: 'Second option', color: 'emerald' },
+      { id: 'opt_3', title: 'Third option', color: 'rose' },
+    ],
+  });
+
+  return (
+    <TestLayout>
+      <TestPanel>
+        <Form
+          schema={schema}
+          values={values}
+          onSave={(vals) => setValues(vals)}
+          Custom={{ options: SelectOptionInput }}
+        />
+      </TestPanel>
+    </TestLayout>
+  );
+};
+
+const meta: Meta = {
+  title: 'ui/react-ui-form/SelectOptionsInput',
+  component: SelectOptionInput,
+  decorators: [withTheme, withLayout({ tooltips: true })],
+  parameters: { translations },
+};
+
+export default meta;
+type Story = StoryObj;
+
+export const Default: Story = {
+  render: DefaultStory,
+};

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

@@ -0,0 +1,192 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { useCallback, useEffect, useState, type ChangeEvent, useRef } from 'react';
+
+import { type SelectOption } from '@dxos/echo-schema';
+import { PublicKey } from '@dxos/keys';
+import { type ChromaticPalette, Icon, IconButton, Input, Tag, Toolbar, useTranslation } from '@dxos/react-ui';
+import { List } from '@dxos/react-ui-list';
+import { HuePickerToolbarButton } from '@dxos/react-ui-pickers';
+import { hueTokenThemes, mx } from '@dxos/react-ui-theme';
+
+import { translationKey } from '../../../translations';
+import { InputHeader, type InputProps } from '../Input';
+
+// TODO(ZaymonFC): Handle disabled.
+export const SelectOptionInput = ({ type, label, disabled, getStatus, getValue, onValueChange }: InputProps) => {
+  const [selected, setSelectedId] = useState<string | null>(null);
+  const [isNewOption, setIsNewOption] = useState(false);
+  const inputRef = useRef<HTMLInputElement>(null);
+  const { t } = useTranslation(translationKey);
+  const { status, error } = getStatus();
+  const options = getValue<SelectOption[] | undefined>();
+
+  // Initialization.
+  useEffect(() => {
+    if (options === undefined) {
+      onValueChange(type, []);
+    }
+  }, [options, onValueChange, type]);
+
+  const randomHue = () => {
+    const usedHues = new Set(options?.map((option) => option.color) ?? []);
+    const hueKeys = Object.keys(hueTokenThemes) as Array<keyof typeof hueTokenThemes>;
+
+    // Pick a random unused option from hueTokenThemes.
+    const unusedHues = hueKeys.filter((hue) => !usedHues.has(hue));
+    if (unusedHues.length > 0) {
+      return unusedHues[Math.floor(Math.random() * unusedHues.length)];
+    }
+
+    // Pick a random one that hasn't been used in the last three options
+    const lastThree = new Set(options?.slice(-3).map((option) => option.color) ?? []);
+    const availableHues = hueKeys.filter((hue) => !lastThree.has(hue));
+    return (
+      availableHues[Math.floor(Math.random() * availableHues.length)] ??
+      hueKeys[Math.floor(Math.random() * hueKeys.length)]
+    );
+  };
+
+  const handleAdd = useCallback(() => {
+    const newId = PublicKey.random().truncate();
+    const newOption = { id: newId, title: '', color: randomHue() };
+    onValueChange(type, [...(options ?? []), newOption]);
+    setSelectedId(newId);
+    setIsNewOption(true);
+  }, [options, type, onValueChange]);
+
+  const handleDelete = useCallback(
+    (id: string) => {
+      const newOptions = options?.filter((option) => option.id !== id) ?? [];
+      onValueChange(type, newOptions);
+      setSelectedId(null);
+    },
+    [options, type, onValueChange],
+  );
+
+  const handleMove = useCallback(
+    (from: number, to: number) => {
+      if (!options) {
+        return;
+      }
+
+      const newOptions = [...options];
+      const [removed] = newOptions.splice(from, 1);
+      newOptions.splice(to, 0, removed);
+      onValueChange(type, newOptions);
+    },
+    [options, type, onValueChange],
+  );
+
+  const handleClick = useCallback((id: string) => {
+    setSelectedId((current) => (current === id ? null : id));
+  }, []);
+
+  const handleTitleChange = useCallback(
+    (id: string) => (e: ChangeEvent<HTMLInputElement>) => {
+      const newOptions = options?.map((o) => (o.id === id ? { ...o, title: e.target.value } : o));
+      onValueChange(type, newOptions ?? []);
+    },
+    [options, type, onValueChange],
+  );
+
+  const handleKeyDown = useCallback((e: React.KeyboardEvent<HTMLInputElement>) => {
+    if (e.key === 'Enter') {
+      setSelectedId(null);
+    }
+  }, []);
+
+  const handleColorChange = useCallback(
+    (id: string) => (hue: string) => {
+      const newOptions = options?.map((o) => (o.id === id ? { ...o, color: hue } : o));
+      onValueChange(type, newOptions ?? []);
+    },
+    [options, type, onValueChange],
+  );
+
+  useEffect(() => {
+    if (selected && isNewOption && inputRef.current) {
+      inputRef.current.focus();
+      setIsNewOption(false);
+    }
+  }, [selected, isNewOption]);
+
+  return (
+    <Input.Root validationValence={status}>
+      <InputHeader error={error}>
+        <Input.Label>{label}</Input.Label>
+      </InputHeader>
+      <div role='none'>
+        {options && (
+          <List.Root items={options} isItem={(item) => true} onMove={handleMove}>
+            {({ items }) => (
+              <div role='list' className='w-full overflow-auto'>
+                {items?.map((item) => (
+                  <div key={item.id}>
+                    <List.Item
+                      role='button'
+                      item={item}
+                      classNames={mx('p-1 plb-2', 'flex flex-col', 'cursor-pointer', 'hover:bg-hoverOverlay')}
+                      aria-expanded={selected === item.id}
+                    >
+                      <div className='flex items-center'>
+                        <List.ItemDragHandle />
+                        <List.ItemTitle onClick={() => handleClick(item.id)} classNames='flex-1'>
+                          {/* TODO(ZaymonFC): Move spacer into Tag component. */}
+                          <Tag palette={item.color as ChromaticPalette}>{item.title || '\u200b'}</Tag>
+                        </List.ItemTitle>
+                        <Icon
+                          icon={selected === item.id ? 'ph--caret-down--regular' : 'ph--caret-right--regular'}
+                          onClick={() => handleClick(item.id)}
+                        />
+                      </div>
+                      {selected === item.id && (
+                        <div className='mis-4 mbs-2 flex flex-col gap-1'>
+                          {/* 16px to match drag handle width. */}
+                          <Input.Label classNames='text-xs'>{t('select option label')}</Input.Label>
+                          <div className='flex flex-row items-center gap-1'>
+                            <Input.TextInput
+                              placeholder={t('select option label placeholder')}
+                              ref={selected === item.id ? inputRef : undefined}
+                              value={item.title}
+                              onChange={handleTitleChange(item.id)}
+                              onKeyDown={handleKeyDown}
+                              classNames='flex-1'
+                            />
+                            <Toolbar.Root classNames='p-0 m-0 !is-auto'>
+                              <HuePickerToolbarButton hue={item.color} onChangeHue={handleColorChange(item.id)} />
+                            </Toolbar.Root>
+                            <IconButton
+                              icon='ph--trash--fill'
+                              iconOnly
+                              label={t('select option delete')}
+                              onClick={() => handleDelete(item.id)}
+                            />
+                          </div>
+                        </div>
+                      )}
+                    </List.Item>
+                  </div>
+                ))}
+                <div role='listitem'>
+                  <div
+                    role='button'
+                    className={mx('p-1 plb-2', 'flex flex-col', 'cursor-pointer', 'hover:bg-hoverOverlay')}
+                    onClick={handleAdd}
+                  >
+                    <div className='flex items-center gap-1'>
+                      <Icon icon='ph--plus--regular' />
+                      <span className='text-sm'>{t('select option add')}</span>
+                    </div>
+                  </div>
+                </div>
+              </div>
+            )}
+          </List.Root>
+        )}
+      </div>
+    </Input.Root>
+  );
+};

package/src/components/Form/custom/TupleInput.tsx

@@ -0,0 +1,49 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React from 'react';
+
+import { Input } from '@dxos/react-ui';
+import { mx } from '@dxos/react-ui-theme';
+import { safeParseFloat } from '@dxos/util';
+
+import { InputHeader, type InputProps } from '../Input';
+
+const gridCols = ['grid-cols-1', 'grid-cols-2', 'grid-cols-3', 'grid-cols-4'];
+
+export const TupleInput = ({
+  binding,
+  type,
+  label,
+  disabled,
+  getStatus,
+  getValue,
+  onValueChange,
+  onBlur,
+}: InputProps & { binding: string[] }) => {
+  const { status, error } = getStatus();
+
+  // TODO(burdon): Generalize number/float/string, etc.
+  const values: Record<string, number> = getValue<Record<string, number>>() ?? {};
+
+  return (
+    <Input.Root validationValence={status}>
+      <InputHeader error={error}>
+        <Input.Label>{label}</Input.Label>
+      </InputHeader>
+      <div className={mx('grid gap-2', gridCols[binding.length - 1])}>
+        {binding.map((prop) => (
+          <Input.TextInput
+            key={prop}
+            type='number'
+            disabled={disabled}
+            value={values[prop]}
+            onChange={(event) => onValueChange(type, { ...values, [prop]: safeParseFloat(event.target.value, 0) })}
+            onBlur={onBlur}
+          />
+        ))}
+      </div>
+    </Input.Root>
+  );
+};

package/src/components/Form/custom/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export * from './GeoPointInput';
+export * from './SelectOptionsInput';
+export * from './TupleInput';

package/src/components/Form/factory.tsx

@@ -2,23 +2,20 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type BaseObject, FormatEnum } from '@dxos/echo-schema';
+import { FormatEnum } from '@dxos/echo-schema';
 import { type SimpleType } from '@dxos/effect';
 
-import { GeiPointInput } from './Custom';
 import { BooleanInput, NumberInput, TextInput } from './Defaults';
 import { type InputComponent } from './Input';
+import { GeoPointInput } from './custom';
 
 /**
  * Get property input component.
  */
-export const getInputComponent = <T extends BaseObject>(
-  type: SimpleType,
-  format?: FormatEnum,
-): InputComponent<T> | undefined => {
+export const getInputComponent = (type: SimpleType, format?: FormatEnum): InputComponent | undefined => {
   switch (format) {
     case FormatEnum.LatLng:
-      return GeiPointInput;
+      return GeoPointInput;
   }
 
   switch (type) {

package/src/components/Form/index.ts

@@ -2,7 +2,8 @@
 // Copyright 2024 DXOS.org
 //
 
-export * from './Form';
-export * from './Custom';
+export * from './custom';
+
 export * from './Defaults';
+export * from './Form';
 export * from './Input';