@digigov/form 2.0.0-555d1027 → 2.0.0-5701c39b

package/src/Field/FieldBaseContainer.tsx

@@ -1,5 +1,6 @@
+import type { ComponentRef } from 'react';
 import React from 'react';
-import { FieldContainerProps } from '@digigov/form/Field/types';
+import type { FieldContainerProps } from '@digigov/form/Field/types';
 import Label from '@digigov/form/inputs/Label';
 import { ErrorMessage } from '@digigov/react-core/ErrorMessage';
 import FieldContainer from '@digigov/react-core/FieldContainer';
@@ -9,63 +10,72 @@ import LabelContainer from '@digigov/react-core/LabelContainer';
 import { useTranslation } from '@digigov/ui/i18n';
 import { Hint } from '@digigov/ui/typography/Hint';
 
-export const FieldBaseContainer: React.FC<FieldContainerProps> = ({
-  name,
-  register,
-  wrapper,
-  label,
-  children,
-  error,
-  hasError,
-  layout,
-  controlled,
-  labelSize = 'sm',
-}) => {
-  const { t } = useTranslation();
-  const errorMessage = error?.message.key
-    ? error.message.key
-    : error?.message || '';
-  const errorContext = error?.message.context || {};
-  if (wrapper === 'fieldset') {
-    return (
-      <FieldContainer error={hasError} {...layout}>
-        <Fieldset
-          className="outline-none"
-          {...(controlled && {
-            tabIndex: -1,
-            ...(register(name || '') as any),
-          })}
-        >
-          <FieldsetLegend size={labelSize}>
-            {label && label.primary}
-          </FieldsetLegend>
-          {label && label.secondary && <Hint>{t(label.secondary)}</Hint>}
-          {error && (
-            <ErrorMessage id={`${name}-error`}>
-              {t(errorMessage, errorContext)}
-            </ErrorMessage>
-          )}
-          {children}
-          {label && label.hint && <Hint size="sm">{label.hint}</Hint>}
-        </Fieldset>
-      </FieldContainer>
-    );
-  } else {
-    return (
-      <FieldContainer error={hasError} {...layout}>
-        <LabelContainer>
-          {label && <Label label={label} />}
-          {error && (
-            <ErrorMessage id={`${name}-error`}>
-              {t(errorMessage, errorContext)}
-            </ErrorMessage>
-          )}
-          {children}
-          {label && label.hint && <Hint size="sm">{label.hint}</Hint>}
-        </LabelContainer>
-      </FieldContainer>
-    );
+export const FieldBaseContainer = React.forwardRef<
+  ComponentRef<typeof Fieldset>,
+  FieldContainerProps
+>(
+  (
+    {
+      name,
+      wrapper,
+      label,
+      children,
+      error,
+      hasError,
+      layout,
+      controlled,
+      labelSize = 'sm',
+    },
+    ref
+  ) => {
+    const { t } = useTranslation();
+    const errorMessage = error?.message.key
+      ? error.message.key
+      : error?.message || '';
+    const errorContext = error?.message.context || {};
+    if (wrapper === 'fieldset') {
+      return (
+        <FieldContainer error={hasError} {...layout}>
+          <Fieldset
+            ref={ref}
+            className="outline-none"
+            {...(controlled && {
+              tabIndex: -1,
+            })}
+          >
+            <FieldsetLegend size={labelSize}>
+              {label && label.primary}
+            </FieldsetLegend>
+            {label && label.secondary && <Hint>{t(label.secondary)}</Hint>}
+            {error && (
+              <ErrorMessage id={`${name}-error`}>
+                {t(errorMessage, errorContext)}
+              </ErrorMessage>
+            )}
+            {children}
+            {label && label.hint && <Hint size="sm">{label.hint}</Hint>}
+          </Fieldset>
+        </FieldContainer>
+      );
+    } else {
+      return (
+        <FieldContainer error={hasError} {...layout}>
+          <LabelContainer>
+            {label && <Label label={label} />}
+            {error && (
+              <ErrorMessage id={`${name}-error`}>
+                {t(errorMessage, errorContext)}
+              </ErrorMessage>
+            )}
+            {children}
+            {label && label.hint && <Hint size="sm">{label.hint}</Hint>}
+          </LabelContainer>
+        </FieldContainer>
+      );
+    }
   }
-};
+);
+
+FieldBaseContainer.displayName = 'FieldBaseContainer';
 
 export default FieldBaseContainer;

package/src/Field/FieldConditional.tsx

@@ -1,7 +1,7 @@
 import React from 'react';
 import { useWatch } from 'react-hook-form';
 import { FieldBase } from '@digigov/form/Field/FieldBase';
-import {
+import type {
   ChildFieldMemoProps,
   FieldConditionalProps,
 } from '@digigov/form/Field/types';

package/src/Field/index.tsx

@@ -1,16 +1,8 @@
 import React, { useMemo } from 'react';
 import { FieldBase } from '@digigov/form/Field/FieldBase';
 import FieldConditional from '@digigov/form/Field/FieldConditional';
-import {
-  FieldWithCondition,
-  CalculatedField,
-  FieldProps,
-} from '@digigov/form/Field/types';
-import {
-  FIELD_COMPONENTS,
-  ALTERNATIVE_COMPONENTS,
-} from '@digigov/form/Field/utils';
-import { calculateField } from '@digigov/form/Field/utils/calculateField';
+import type { FieldWithCondition, FieldProps } from '@digigov/form/Field/types';
+import { resolveField } from '@digigov/form/Field/utils/resolveField';
 import { useField } from '@digigov/form/Field/utils/useField';
 import FieldArray from '@digigov/form/FieldArray';
 import Multiplicity from '@digigov/form/MultiplicityField';
@@ -33,59 +25,47 @@ export const Field: React.FC<FieldProps> = ({
     unregister,
     trigger,
     clearErrors,
+    registerFieldFocus,
   } = useField(name, customField?.type ? customField : null);
-  const calculatedField: CalculatedField = useMemo(
-    () =>
-      calculateField(
-        children,
-        field,
-        {
-          ...FIELD_COMPONENTS,
-          ...componentRegistry,
-        },
-        ALTERNATIVE_COMPONENTS
-      ),
+  const resolvedField = useMemo(
+    () => resolveField(children, field, componentRegistry),
     [field]
   );
-  if (calculatedField.condition) {
+  if (resolvedField.condition) {
     return (
       <FieldConditional
         control={control}
         reset={reset}
         resetField={resetField}
         register={register}
-        field={calculatedField as FieldWithCondition}
+        field={resolvedField as FieldWithCondition}
         error={error}
         Field={Field}
       />
     );
   }
-  if (calculatedField.type === 'array' && !calculatedField.multiplicity) {
-    calculatedField.name = name;
+  if (resolvedField.type === 'array' && !resolvedField.multiplicity) {
+    resolvedField.name = name;
     return (
       <FieldArray
         control={control}
         trigger={trigger}
         register={register}
         clearErrors={clearErrors}
-        error={
-          formState.isSubmitted && !formState.isSubmitting ? error : undefined
-        }
+        error={error}
         getValues={getValues}
         setValue={setValue}
         formState={formState}
         Field={Field}
         reset={reset}
         resetField={resetField}
-        {...calculatedField}
+        registerFieldFocus={registerFieldFocus}
+        {...resolvedField}
       />
     );
   }
-  if (
-    calculatedField.type === 'array' &&
-    calculatedField.multiplicity === true
-  ) {
-    calculatedField.name = name;
+  if (resolvedField.type === 'array' && resolvedField.multiplicity === true) {
+    resolvedField.name = name;
     return (
       <Multiplicity
         control={control}
@@ -99,7 +79,7 @@ export const Field: React.FC<FieldProps> = ({
         unregister={unregister}
         resetField={resetField}
         Field={Field}
-        {...calculatedField}
+        {...resolvedField}
       />
     );
   }
@@ -110,7 +90,7 @@ export const Field: React.FC<FieldProps> = ({
   const customError = error ? error : formState?.errors[name];
   return (
     <FieldBase
-      {...calculatedField}
+      {...resolvedField}
       editable={editable}
       name={name}
       control={control}

package/src/Field/types.tsx

@@ -1,8 +1,10 @@
-import React from 'react';
-import { ErrorOption, UseFormReturn, UseFormProps } from 'react-hook-form';
-import { ValidatorSchema } from '@digigov/form/validators/types';
-import { FieldsetLegendProps } from '@digigov/ui/form/FieldContainer';
-import { GridProps } from '@digigov/ui/layouts/Grid';
+import type React from 'react';
+import type { ErrorOption, UseFormReturn, UseFormProps } from 'react-hook-form';
+import type { FieldComponentRegistry } from '@digigov/form/inputs/registry';
+import type { registerFieldFocus } from '@digigov/form/types';
+import type { ValidatorSchema } from '@digigov/form/validators/types';
+import type { FieldsetLegendProps } from '@digigov/ui/form/FieldContainer';
+import type { GridProps } from '@digigov/ui/layouts/Grid';
 
 export interface FieldLabelProps {
   primary?: string;
@@ -73,7 +75,7 @@ export interface ChildFieldMemoProps extends FieldConditionalProps {
 }
 export type FormData = UseFormProps['defaultValues'];
 
-export interface FieldWithCondition extends Omit<CalculatedField, 'condition'> {
+export interface FieldWithCondition extends Omit<ResolvedField, 'condition'> {
   condition: Record<string, FieldCondition>;
 }
 
@@ -107,10 +109,6 @@ export interface FieldContainerProps {
   labelSize?: FieldsetLegendProps['size'];
 }
 
-export type FieldComponentRegistry = Record<string, FieldComponentItem>;
-
-export type OmittedFieldSpec = Omit<FieldSpec, 'component'>;
-
 export type UnknownValue = never | never[];
 
 export interface ControlledFieldProps {
@@ -137,7 +135,7 @@ export interface UncontrolledFieldProps {
   Field: React.FC<FieldProps>;
 }
 
-export interface CalculatedField extends OmittedFieldSpec {
+export interface ResolvedField extends Omit<FieldSpec, 'component'> {
   name: string;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   component: any;
@@ -147,7 +145,7 @@ export interface CalculatedField extends OmittedFieldSpec {
   multiplicity?: boolean;
 }
 
-export interface FieldBaseProps extends CalculatedField {
+export interface FieldBaseProps extends ResolvedField {
   control: UseFormReturn['control'];
   register: UseFormReturn['register'];
   reset: UseFormReturn['reset'];
@@ -175,5 +173,6 @@ export interface UseFieldProps {
   trigger: UseFormReturn['trigger'];
   clearErrors: UseFormReturn['clearErrors'];
   error?: ErrorOption;
+  registerFieldFocus: registerFieldFocus;
   componentRegistry?: FieldComponentRegistry;
 }

package/src/Field/utils/evaluateFieldWithConditions.ts

@@ -1,9 +1,12 @@
-import { FieldWithCondition, CalculatedField } from '@digigov/form/Field/types';
+import type {
+  FieldWithCondition,
+  ResolvedField,
+} from '@digigov/form/Field/types';
 
 export function evaluateFieldWithConditions(
   field: FieldWithCondition,
   variables: FormData
-): CalculatedField {
+): ResolvedField {
   const newField = { ...field };
   if (variables) {
     for (const key in variables) {

package/src/Field/utils/resolveField.ts

@@ -0,0 +1,58 @@
+import type {
+  FieldProps,
+  FieldSpec,
+  ResolvedField,
+} from '@digigov/form/Field/types';
+import {
+  ALTERNATIVE_COMPONENTS,
+  FIELD_COMPONENTS,
+  type FieldComponentRegistry,
+} from '@digigov/form/inputs/registry';
+
+export function resolveField(
+  children: FieldProps['children'],
+  field: FieldSpec,
+  customComponentRegistry?: FieldComponentRegistry
+): ResolvedField {
+  const fieldComponentRegistry = {
+    ...FIELD_COMPONENTS,
+    ...(customComponentRegistry ?? {}),
+  };
+
+  const resolvedField = { ...field };
+
+  if (children) {
+    resolvedField.component = children;
+    resolvedField.controlled = true;
+  } else if (typeof field.component === 'function') {
+    // leave as is
+  } else if (!field.component && !field.type) {
+    resolvedField.component = fieldComponentRegistry.string.component;
+    resolvedField.controlled =
+      fieldComponentRegistry.string?.controlled || false;
+  } else if (
+    typeof field?.extra?.component === 'string' &&
+    ALTERNATIVE_COMPONENTS[field.extra.component]
+  ) {
+    resolvedField.controlled =
+      ALTERNATIVE_COMPONENTS[field.extra.component]?.controlled || false;
+    resolvedField.component =
+      ALTERNATIVE_COMPONENTS[field.extra.component].component;
+    resolvedField.wrapper =
+      ALTERNATIVE_COMPONENTS[field.extra.component].wrapper;
+  } else if (
+    !field.component &&
+    field.type &&
+    fieldComponentRegistry[field.type]
+  ) {
+    resolvedField.component = fieldComponentRegistry[field.type].component;
+    resolvedField.wrapper = fieldComponentRegistry[field.type].wrapper;
+    resolvedField.controlled =
+      fieldComponentRegistry[field.type]?.controlled || false;
+  } else {
+    resolvedField.component = fieldComponentRegistry.string.component;
+    resolvedField.controlled =
+      fieldComponentRegistry.string?.controlled || false;
+  }
+  return resolvedField as ResolvedField;
+}

package/src/Field/utils/useField.ts

@@ -1,5 +1,5 @@
 import { useContext, useMemo } from 'react';
-import { FieldSpec, UseFieldProps } from '@digigov/form/Field/types';
+import type { FieldSpec, UseFieldProps } from '@digigov/form/Field/types';
 import { FormContext } from '@digigov/form/FormContext';
 
 export const useField = (
@@ -23,6 +23,7 @@ export const useField = (
     getValues,
     unregister,
     formState,
+    registerFieldFocus,
   } = useContext(FormContext);
   if (!registerField) {
     throw new Error(`
@@ -62,5 +63,6 @@ export const useField = (
     unregister,
     formState,
     error,
+    registerFieldFocus,
   };
 };

package/src/FieldArray/BaseFieldArray.tsx

@@ -0,0 +1,97 @@
+import React from 'react';
+import { useFieldArray } from 'react-hook-form';
+import type { FieldArrayProps } from '@digigov/form/FieldArray';
+import { FieldObject } from '@digigov/form/FieldObject';
+import { FieldsetLabel, Fieldset } from '@digigov/form/Fieldset';
+import { Card } from '@digigov/ui/content/Card';
+import { Button } from '@digigov/ui/form/Button';
+
+type BaseFieldArrayProps = Omit<
+  FieldArrayProps,
+  | 'registerFieldFocus'
+  | 'trigger'
+  | 'clearErrors'
+  | 'setValue'
+  | 'reset'
+  | 'resetField'
+>;
+export const BaseFieldArray = React.forwardRef<
+  HTMLButtonElement,
+  BaseFieldArrayProps
+>(
+  (
+    {
+      name,
+      register,
+      control,
+      formState,
+      error,
+      getValues,
+      Field,
+      ...customField
+    },
+    ref
+  ) => {
+    const { append, remove } = useFieldArray({
+      control,
+      name,
+    });
+    const fields = getValues(name) || [];
+
+    return (
+      <>
+        {fields.map((field, index) => (
+          <Card
+            variant={customField.extra?.border ? 'border' : 'divider'}
+            key={field.id || index}
+          >
+            <Fieldset>
+              <FieldsetLabel>
+                {`${customField.extra?.label.object.title}${!customField.extra?.noIndex ? ' ' + String(index + 1) : ''}`}
+              </FieldsetLabel>
+              <FieldObject
+                name={`${name}.${index}`}
+                error={Array.isArray(error) && error[index]}
+                formState={formState}
+                register={register}
+                control={control}
+                {...customField.extra?.of}
+                Field={Field}
+              />
+              <Button
+                name={`${name}-object-remove`}
+                variant={customField.extra?.label.object?.deleteButtonVariant}
+                type="button"
+                color="warning"
+                onClick={() => remove(index)}
+                disabled={!customField?.editable}
+              >
+                {customField.extra?.label.object?.delete}
+              </Button>
+            </Fieldset>
+          </Card>
+        ))}
+        {customField.editable && (
+          <Button
+            ref={ref}
+            type="button"
+            name={`${name}-add-object`}
+            color="secondary"
+            variant={customField.extra?.label.object?.addButtonVariant}
+            onClick={(ev) => {
+              ev.preventDefault();
+              append({});
+            }}
+            disabled={!customField?.editable}
+          >
+            {customField.extra?.label.object?.add}
+          </Button>
+        )}
+      </>
+    );
+  }
+);
+
+BaseFieldArray.displayName = 'BaseFieldArray';
+
+export default BaseFieldArray;

package/src/FieldArray/FieldArray.stories.js

@@ -7,3 +7,4 @@ export default {
 export { Default } from '@digigov/form/FieldArray/__stories__/Default';
 export { WithModal } from '@digigov/form/FieldArray/__stories__/WithModal';
 export { WithExactLength } from '@digigov/form/FieldArray/__stories__/WithExactLength';
+export { CardsWithError } from '@digigov/form/FieldArray/__stories__/CardsWithError';

package/src/FieldArray/FormDialog/ArrayDisplay/ArrayContainerDisplay.tsx

@@ -0,0 +1,45 @@
+import React from 'react';
+import { ArrayItemHeader } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/ArrayItemHeader';
+import { Table, TableBody, TableContainer } from '@digigov/ui/content';
+
+export interface ArrayContainerDisplayProps {
+  fieldArrayValues: any[];
+  ofField: any;
+  customField: any;
+  children: React.ReactNode;
+}
+
+export const ArrayContainerDisplay = ({
+  fieldArrayValues,
+  ofField,
+  customField,
+  children,
+}: ArrayContainerDisplayProps) => {
+  return (
+    <>
+      {customField?.extra?.layout === 'card' ? (
+        children
+      ) : (
+        <TableContainer {...customField.extra?.tableContainer}>
+          <Table verticalAlign={customField.extra?.verticalAlign}>
+            {!customField.extra?.noHeader &&
+              ofField?.extra &&
+              fieldArrayValues?.length > 0 && (
+                <ArrayItemHeader
+                  labels={
+                    ofField.type === 'object'
+                      ? ofField.extra.fields.map(({ label }) => label.primary)
+                      : [ofField.label.primary]
+                  }
+                  disabled={customField?.editable === false}
+                />
+              )}
+            <TableBody>{children}</TableBody>
+          </Table>
+        </TableContainer>
+      )}
+    </>
+  );
+};
+
+export default ArrayContainerDisplay;

package/src/FieldArray/FormDialog/ArrayDisplay/ArrayDisplay.stories.js

@@ -0,0 +1,14 @@
+import ArrayDisplay from '@digigov/form/FieldArray/FormDialog/ArrayDisplay';
+
+export default {
+  title: 'Digigov Form/FieldArray/FormDialog/ArrayDisplay',
+  component: ArrayDisplay,
+  displayName: 'ArrayDisplay',
+};
+
+export { Default } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/__stories__/Default';
+export { Sortable } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/__stories__/Sortable';
+export { ReadOnly } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/__stories__/ReadOnly';
+export { Cards } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/__stories__/Cards';
+export { SortableCards } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/__stories__/SortableCards';
+export { ReadOnlyCards } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/__stories__/ReadOnlyCards';