@dxos/react-ui-form 0.8.3 → 0.8.4-main.03d5cd7b56

package/src/components/ControlSection/ControlSection.tsx

@@ -1,139 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { type ComponentPropsWithoutRef, type PropsWithChildren } from 'react';
-
-import {
-  Button,
-  type ButtonProps,
-  Input,
-  type Label,
-  type ThemedClassName,
-  toLocalizedString,
-  useTranslation,
-} from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
-
-import { translationKey } from '../../translations';
-
-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>
-  );
-};
-
-export type ControlSectionProps = PropsWithChildren<{
-  title: Label;
-  description?: Label;
-}>;
-
-export const ControlSection = ({ title, description, children }: ControlSectionProps) => {
-  return (
-    <>
-      <ControlSectionHeading title={title} description={description} />
-      {children}
-    </>
-  );
-};
-
-export const ControlSectionHeading = ({ title, description }: Omit<ControlSectionProps, 'children'>) => {
-  const { t } = useTranslation(translationKey);
-  return (
-    <>
-      <h2 className='pli-trimMd container-max-width text-xl mbs-trimLg mbe-trimMd'>{toLocalizedString(title, t)}</h2>
-      {description && (
-        <p className='pli-trimMd mlb-trimMd container-max-width text-description'>
-          {toLocalizedString(description, t)}
-        </p>
-      )}
-    </>
-  );
-};
-
-export const ControlGroupButton = ({ classNames, ...props }: ButtonProps) => {
-  return <Button {...props} classNames={['md:col-span-2', classNames]} />;
-};
-
-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)}
-  >
-    {children}
-  </div>
-);
-
-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'
-  >
-    {children}
-  </div>
-);
-
-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);
-
-  return (
-    <div className={controlItemClasses}>
-      <div role='none'>
-        <h3 className={controlItemTitleClasses}>{toLocalizedString(title, t)}</h3>
-        {description && <p className={controlItemDescriptionClasses}>{toLocalizedString(description, t)}</p>}
-      </div>
-      {children}
-    </div>
-  );
-};
-
-export const ControlItemInput = ({ title, description, children }: ControlItemProps) => {
-  const { t } = useTranslation(translationKey);
-
-  return (
-    <Input.Root>
-      <div className={controlItemClasses}>
-        <div role='none'>
-          <Input.Label classNames={controlItemTitleClasses}>{toLocalizedString(title, t)}</Input.Label>
-          {description && (
-            <Input.DescriptionAndValidation>
-              <Input.Description classNames={controlItemDescriptionClasses}>
-                {toLocalizedString(description, t)}
-              </Input.Description>
-            </Input.DescriptionAndValidation>
-          )}
-        </div>
-        {children}
-      </div>
-    </Input.Root>
-  );
-};
-
-export const ControlFrameItem = ({ title, description, children }: ControlItemProps) => {
-  const { t } = useTranslation(translationKey);
-
-  return (
-    <div role='group' className='min-is-0'>
-      <h3 className='text-lg mbe-2'>{toLocalizedString(title, t)}</h3>
-      {description && <p className='mlb-trimSm md:mbe-0 text-description'>{toLocalizedString(description, t)}</p>}
-      {children}
-    </div>
-  );
-};

package/src/components/Form/ArrayField.tsx

@@ -1,124 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-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 { invariant } from '@dxos/invariant';
-import { IconButton, useTranslation } from '@dxos/react-ui';
-import { getSchemaProperties, type SchemaProperty } 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';
-
-type ArrayFieldProps = {
-  property: SchemaProperty<any>;
-  readonly?: boolean;
-  inputProps: FormInputStateProps;
-  path?: (string | number)[];
-  Custom?: Partial<Record<string, InputComponent>>;
-  lookupComponent?: ComponentLookup;
-};
-
-export const ArrayField = ({ property, readonly, path, inputProps, Custom, lookupComponent }: ArrayFieldProps) => {
-  const { t } = useTranslation(translationKey);
-  const { ast, name, type, title } = property;
-  // TODO(wittjosiah): The fallback to an empty array stops the form from crashing but isn't immediately live.
-  //  It doesn't become live until another field is touched, but that's better than the whole form crashing.
-  const values = (useFormValues(path ?? []) ?? []) as any[];
-  invariant(Array.isArray(values), `Values at path ${path?.join('.')} must be an array.`);
-  const label = title ?? pipe(name, capitalize);
-
-  const elementType = findArrayElementType(ast);
-
-  const getDefaultObjectValue = (typeNode: SchemaAST.AST): any => {
-    const baseNode = findNode(typeNode, isDiscriminatedUnion);
-    const typeLiteral = baseNode ? getDiscriminatedType(baseNode, {}) : findNode(typeNode, SchemaAST.isTypeLiteral);
-    if (!typeLiteral) {
-      return {};
-    }
-
-    return Object.fromEntries(getSchemaProperties(typeLiteral, {}).map((prop) => [prop.name, prop.defaultValue]));
-  };
-
-  const getDefaultValue = () =>
-    type === 'object' && elementType ? getDefaultObjectValue(elementType) : SimpleType.getDefaultValue(type);
-
-  const handleAdd = useCallback(() => {
-    inputProps.onValueChange(type, [...values, getDefaultValue()]);
-  }, [type, elementType, inputProps, values]);
-
-  const handleRemove = useCallback(
-    (index: number) => {
-      const newValues = values.filter((_, i) => i !== index);
-      inputProps.onValueChange(type, newValues);
-    },
-    [type, inputProps, values],
-  );
-
-  if (!elementType) {
-    return null;
-  }
-
-  return readonly && values.length < 1 ? null : (
-    <>
-      <InputHeader readonly label={label} />
-      <div
-        role='none'
-        className={
-          readonly
-            ? 'flex flex-wrap gap-1 mlb-1'
-            : values.length > 0
-              ? 'grid gap-1 grid-cols-[1fr_min-content] mlb-1'
-              : 'hidden'
-        }
-      >
-        {values.map((_value, index) => {
-          const field = (
-            <FormField
-              property={{
-                ...property,
-                array: false, // NOTE(ZaymonFC): This breaks arrays of arrays but ¯\_(ツ)_/¯. Ping me if you need that.
-                ast: elementType,
-              }}
-              path={[...(path ?? []), index]}
-              readonly={readonly}
-              inline
-              Custom={Custom}
-              lookupComponent={lookupComponent}
-            />
-          );
-          return readonly ? (
-            field
-          ) : (
-            <Fragment key={index}>
-              <div role='none'>{field}</div>
-              <IconButton
-                icon='ph--trash--regular'
-                iconOnly
-                label={t('button remove')}
-                onClick={() => handleRemove(index)}
-                classNames='self-center'
-              />
-            </Fragment>
-          );
-        })}
-      </div>
-      {!readonly && (
-        <IconButton
-          classNames='is-full mlb-1 flex'
-          icon='ph--plus--regular'
-          label={t('add field')}
-          onClick={handleAdd}
-        />
-      )}
-    </>
-  );
-};

package/src/components/Form/Defaults.tsx

@@ -1,203 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-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';
-
-export const TextInput = ({
-  type,
-  label,
-  inputOnly,
-  disabled,
-  placeholder,
-  getStatus,
-  getValue,
-  onValueChange,
-  onBlur,
-}: InputProps) => {
-  const { status, error } = getStatus();
-
-  return disabled && !getValue() ? null : disabled && inputOnly ? (
-    <p>{getValue() ?? ''}</p>
-  ) : (
-    <Input.Root validationValence={status}>
-      {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
-        <p>{getValue() ?? ''}</p>
-      ) : (
-        <Input.TextInput
-          disabled={disabled}
-          placeholder={placeholder}
-          value={getValue() ?? ''}
-          onChange={(event) => onValueChange(type, event.target.value)}
-          onBlur={onBlur}
-        />
-      )}
-      {inputOnly && <Input.Validation>{error}</Input.Validation>}
-    </Input.Root>
-  );
-};
-
-export const NumberInput = ({
-  type,
-  label,
-  inputOnly,
-  disabled,
-  placeholder,
-  getStatus,
-  getValue,
-  onValueChange,
-  onBlur,
-}: InputProps) => {
-  const { status, error } = getStatus();
-
-  return disabled && !getValue() ? null : disabled && inputOnly ? (
-    <p>{getValue() ?? ''}</p>
-  ) : (
-    <Input.Root validationValence={status}>
-      {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
-        <p>{getValue() ?? ''}</p>
-      ) : (
-        <Input.TextInput
-          type='number'
-          disabled={disabled}
-          placeholder={placeholder}
-          value={getValue() ?? 0}
-          onChange={(event) => onValueChange(type, event.target.value)}
-          onBlur={onBlur}
-        />
-      )}
-      {inputOnly && <Input.DescriptionAndValidation>{error}</Input.DescriptionAndValidation>}
-    </Input.Root>
-  );
-};
-
-export const BooleanInput = ({ type, label, inputOnly, getStatus, getValue, onValueChange, disabled }: InputProps) => {
-  const { status, error } = getStatus();
-  const checked = Boolean(getValue());
-  const { t } = useTranslation(translationKey);
-
-  return (
-    <Input.Root validationValence={status}>
-      {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
-        <p>{t(checked ? 'boolean input true value' : 'boolean input false value')}</p>
-      ) : (
-        <Input.Switch checked={checked} onCheckedChange={(value) => onValueChange(type, value)} />
-      )}
-      {inputOnly && <Input.DescriptionAndValidation>{error}</Input.DescriptionAndValidation>}
-    </Input.Root>
-  );
-};
-
-export type SelectInputOptions = InputProps & {
-  options?: Array<{ value: string | number; label?: string }>;
-};
-
-export const SelectInput = ({
-  type,
-  label,
-  inputOnly,
-  disabled,
-  placeholder,
-  options,
-  getStatus,
-  getValue,
-  onValueChange,
-}: SelectInputOptions) => {
-  const { status, error } = getStatus();
-
-  const value = getValue() as string | undefined;
-  const handleValueChange = useCallback((value: string | number) => onValueChange(type, value), [type, onValueChange]);
-
-  return disabled && !value ? null : (
-    <Input.Root validationValence={status}>
-      {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
-        <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.Portal>
-            <Select.Content>
-              <Select.Viewport>
-                {options?.map(({ value, label }) => (
-                  // NOTE: Numeric values are converted to and from strings.
-                  <Select.Option key={String(value)} value={String(value)}>
-                    {label ?? String(value)}
-                  </Select.Option>
-                ))}
-              </Select.Viewport>
-            </Select.Content>
-          </Select.Portal>
-        </Select.Root>
-      )}
-      {inputOnly && <Input.DescriptionAndValidation>{error}</Input.DescriptionAndValidation>}
-    </Input.Root>
-  );
-};
-
-export const MarkdownInput = ({
-  type,
-  label,
-  inputOnly,
-  disabled,
-  placeholder,
-  getStatus,
-  getValue,
-  onValueChange,
-  onBlur,
-}: InputProps) => {
-  const { status, error } = getStatus();
-  const textareaRef = useRef<HTMLTextAreaElement>(null);
-
-  // TODO(ZaymonFC): If we start using `Enter` for form submission, we should prevent default behavior here
-  //  since we're using a textarea element and the user needs to be able to enter new lines.
-
-  const adjustHeight = useCallback(() => {
-    const textarea = textareaRef.current;
-    if (textarea) {
-      textarea.style.blockSize = 'auto'; // For measurement.
-      textarea.style.blockSize = `${textarea.scrollHeight + 2}px`;
-    }
-  }, []);
-
-  // Adjust height on initial render.
-  useEffect(() => {
-    adjustHeight();
-  }, [adjustHeight]);
-
-  // Adjust height when the content changes.
-  useEffect(() => {
-    adjustHeight();
-  }, [getValue(), adjustHeight]);
-
-  return (
-    <Input.Root validationValence={status}>
-      {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
-        <p>{getValue() ?? ''}</p>
-      ) : (
-        <Input.TextArea
-          ref={textareaRef}
-          disabled={disabled}
-          placeholder={placeholder}
-          value={getValue() ?? ''}
-          classNames={'min-bs-auto max-h-40 overflow-auto'}
-          onChange={(event) => onValueChange(type, event.target.value)}
-          onBlur={onBlur}
-          style={{ resize: 'none' }}
-          spellCheck={false}
-        />
-      )}
-      {inputOnly && <Input.Validation>{error}</Input.Validation>}
-    </Input.Root>
-  );
-};

package/src/components/Form/FormActions.tsx

@@ -1,53 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { IconButton, useTranslation } from '@dxos/react-ui';
-import { cardSpacing } from '@dxos/react-ui-stack';
-import { mx } from '@dxos/react-ui-theme';
-
-import { useFormContext } from './FormContext';
-import { translationKey } from '../../translations';
-
-export type FormOuterSpacing = boolean | 'blockStart-0' | 'scroll-fields';
-
-export type FormActionsProps = {
-  readonly?: boolean;
-  onCancel?: () => void;
-  outerSpacing?: FormOuterSpacing;
-};
-
-export const FormActions = ({ readonly, onCancel, outerSpacing = true }: FormActionsProps) => {
-  const { t } = useTranslation(translationKey);
-  const { canSave, handleSave } = useFormContext();
-
-  return (
-    <div
-      role='none'
-      className={mx(
-        outerSpacing === 'scroll-fields'
-          ? 'pli-cardSpacingInline mbe-cardSpacingBlock'
-          : outerSpacing
-            ? cardSpacing
-            : 'mbs-cardSpacingBlock',
-        'flex [&_button]:grow gap-1 first:mbs-0',
-      )}
-    >
-      {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>
-  );
-};