@digigov/form 1.2.0-dcbd7ded → 2.0.0-0138f8bd

package/src/Field/utils/useField.ts

@@ -0,0 +1,68 @@
+import { useContext, useMemo } from 'react';
+import type { FieldSpec, UseFieldProps } from '@digigov/form/Field/types';
+import { FormContext } from '@digigov/form/FormContext';
+
+export const useField = (
+  name: string,
+  customField: FieldSpec | null
+): UseFieldProps => {
+  const {
+    fieldsMap,
+    control,
+    register,
+    reset,
+    resetField,
+    trigger,
+    clearErrors,
+    errors,
+    registerField,
+    watch,
+    componentRegistry,
+    getFieldState,
+    setValue,
+    getValues,
+    unregister,
+    formState,
+    registerFieldFocus,
+  } = useContext(FormContext);
+  if (!registerField) {
+    throw new Error(`
+      You can't use the Field component without wrapping it in FormBuilder.
+      https://devs.pages.grnet.gr/digigov/digigov-sdk/sdk-docs/forms/create-simple-form/
+    `);
+  }
+  let error = errors[name];
+
+  const nameIndexRegex = name.match(/^\[*(.*?)\.(\d+)\]*$/);
+  if (nameIndexRegex) {
+    const [, fieldArrayName, indexStr] = nameIndexRegex;
+    error = errors[fieldArrayName]?.[Number(indexStr)];
+  }
+  const nestedNameIndexRegex = name.match(/^\[*(.*?)\.(\d+)\.(.*?)\]*$/);
+  if (nestedNameIndexRegex) {
+    const [, fieldArrayName, indexStr, fieldItemName] = nestedNameIndexRegex;
+    error = errors[fieldArrayName]?.[Number(indexStr)]?.[fieldItemName];
+  }
+  useMemo(
+    () => customField?.type && registerField({ ...customField, key: name }),
+    [customField, name, registerField]
+  );
+  return {
+    field: customField || fieldsMap[name],
+    control,
+    register,
+    reset,
+    resetField,
+    trigger,
+    watch,
+    componentRegistry,
+    getFieldState,
+    setValue,
+    clearErrors,
+    getValues,
+    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

@@ -4,5 +4,7 @@ export default {
   component: FieldArray,
   displayName: 'FieldArray',
 };
-export * from '@digigov/form/FieldArray/__stories__/Default';
-export * from '@digigov/form/FieldArray/__stories__/WithExactLength';
+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';

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

@@ -0,0 +1,335 @@
+import React from 'react';
+import type { ErrorOption, UseFieldArrayMove } from 'react-hook-form';
+import { ErrorMessage } from '@digigov/ui';
+import {
+  Card,
+  SummaryList,
+  SummaryListItem,
+  SummaryListItemKey,
+  SummaryListItemValue,
+  TableDataCell,
+  TableRow,
+} from '@digigov/ui/content';
+import { Button, ButtonGroup } from '@digigov/ui/form/Button';
+import type { StackProps } from '@digigov/ui/layouts';
+import { Grid, SectionBreak, Stack } from '@digigov/ui/layouts';
+import Heading from '@digigov/ui/typography/Heading';
+import { NormalText } from '@digigov/ui/typography/NormalText';
+
+export interface ArrayItemDisplayProps {
+  data: any;
+  name: string;
+  edit: (name: string) => void;
+  remove: (name: string) => void;
+  disabledEdit?: boolean;
+  disabledDelete?: boolean;
+  disabled?: boolean;
+  sortable: boolean;
+  index: number;
+  isFirst: boolean;
+  isLast: boolean;
+  move: UseFieldArrayMove;
+  valueDisplay?: (value) => React.ReactNode;
+  border: boolean;
+  wordBreak?: 'break-all' | 'none';
+  stackProps?: StackProps;
+  customField: any;
+  ofField: any;
+  fieldArrayValues: any[];
+  error?: Record<string, ErrorOption> | undefined;
+}
+
+export const ArrayItemDisplay = ({
+  name,
+  data,
+  edit,
+  remove,
+  disabledEdit,
+  disabledDelete,
+  disabled,
+  sortable,
+  index,
+  isFirst,
+  isLast,
+  move,
+  valueDisplay,
+  border = true,
+  wordBreak = 'break-all',
+  stackProps = {
+    spacing: 4,
+    alignItems: 'flex-end',
+    justifyContent: 'flex-end',
+    direction: 'column',
+  },
+  customField,
+  ofField,
+  fieldArrayValues,
+  error,
+}: ArrayItemDisplayProps) => {
+  if (data === undefined || data === null) {
+    return null;
+  }
+  if (
+    Object.keys(data).length === 0 ||
+    (Object.keys(data).length === 1 && data.id)
+  ) {
+    return null;
+  }
+  delete data.id;
+  const values: (string | Record<string, any>)[] =
+    typeof data === 'string' ? [data] : Object.values(data || {});
+  const borderVariant = border === false || sortable ? 'none' : 'border';
+  // Show last border if there are action buttons to separate buttons from item values
+  const hasItemButtons = !disabled && (!disabledEdit || !disabledDelete);
+
+  const fieldLabel: Record<string, string> | string =
+    ofField?.type === 'object'
+      ? ofField?.extra?.fields.reduce(
+          (acc: Record<string, string>, { key, label }) => ({
+            ...acc,
+            [key]: label.primary,
+          }),
+          {}
+        )
+      : ofField?.label?.primary;
+
+  return (
+    <>
+      {customField?.extra?.layout === 'card' ? (
+        <Card
+          borderColor="light"
+          variant="border"
+          dense
+          {...customField?.extra.cardContainer}
+        >
+          {sortable && <Heading size="sm">Επιλογή #{index + 1}</Heading>}
+          <SummaryList mb={0} noLastBorder={!hasItemButtons} error={!!error}>
+            {error &&
+              Object.keys(error).length > 0 &&
+              Object.entries(error).map(([fieldKey, fieldError]) => (
+                <ErrorMessage key={fieldKey} id={`${name}-error`}>
+                  {`${
+                    ofField?.type === 'object' && ofField?.extra?.fields
+                      ? `${fieldLabel[fieldKey] || fieldKey}: `
+                      : ''
+                  }`}
+                  {
+                    fieldError.message /* This is expected to be a SafeHTML component, not a string */
+                  }
+                </ErrorMessage>
+              ))}
+            {values?.map?.((value, valueIndex) => {
+              const key =
+                ofField?.type === 'object'
+                  ? ofField?.extra?.fields?.[valueIndex]?.key
+                  : ofField?.key;
+              const label =
+                ofField?.type === 'object' ? fieldLabel[key] : fieldLabel;
+
+              const shouldShowKey =
+                !customField?.extra?.noHeader &&
+                ofField?.extra &&
+                fieldArrayValues?.length > 0;
+
+              return (
+                <SummaryListItem key={valueIndex}>
+                  {shouldShowKey && (
+                    <SummaryListItemKey
+                      error={!!error && Object.keys(error)?.includes(key)}
+                    >
+                      {label}
+                    </SummaryListItemKey>
+                  )}
+                  <SummaryListItemValue
+                    error={
+                      !shouldShowKey &&
+                      !!error &&
+                      Object.keys(error)?.includes(key)
+                    }
+                  >
+                    {(value as Record<string, any>)?.name ||
+                      (Array.isArray(value)
+                        ? value.join('\n')
+                        : valueDisplay
+                          ? valueDisplay(value)
+                          : value) ||
+                      ''}
+                  </SummaryListItemValue>
+                </SummaryListItem>
+              );
+            })}
+          </SummaryList>
+          {disabled === true ||
+          (disabledEdit === true && disabledDelete === true) ? null : (
+            <ButtonGroup mb={0} {...customField?.extra?.cardButtonGroup}>
+              {disabledEdit !== true && (
+                <Button
+                  variant="link"
+                  type="button"
+                  onClick={() => {
+                    edit(name);
+                  }}
+                >
+                  Επεξεργασία
+                </Button>
+              )}
+              {disabledDelete !== true && (
+                <Button
+                  variant="link"
+                  type="button"
+                  onClick={() => remove(name)}
+                >
+                  Διαγραφή
+                </Button>
+              )}
+            </ButtonGroup>
+          )}
+          {sortable && (
+            <>
+              <SectionBreak />
+              {sortable && !disabled && !(isFirst && isLast) && (
+                <NormalText mb={0}>
+                  Μετακίνηση{' '}
+                  {!isFirst && (
+                    <>
+                      προς τα{' '}
+                      <Button
+                        type="button"
+                        variant="link"
+                        onClick={() => move(index, index - 1)}
+                      >
+                        πάνω
+                      </Button>
+                    </>
+                  )}
+                  {!isFirst && !isLast && ' ή '}
+                  {!isLast && (
+                    <>
+                      προς τα{' '}
+                      <Button
+                        type="button"
+                        variant="link"
+                        onClick={() => move(index, index + 1)}
+                      >
+                        κάτω
+                      </Button>
+                    </>
+                  )}
+                </NormalText>
+              )}
+            </>
+          )}
+        </Card>
+      ) : (
+        <>
+          <TableRow>
+            {values?.map?.((value, valueIndex) => {
+              const fieldKey =
+                ofField?.type === 'object'
+                  ? ofField?.extra?.fields?.[valueIndex]?.key
+                  : ofField?.key;
+              return (
+                <TableDataCell
+                  key={valueIndex}
+                  variant={borderVariant}
+                  wordBreak={wordBreak}
+                  pb={sortable ? 0 : undefined}
+                  pt={sortable ? 4 : undefined}
+                  highlight={
+                    !!error && Object.keys(error)?.includes(fieldKey)
+                      ? 'error'
+                      : undefined
+                  }
+                >
+                  {sortable && valueIndex === 0 && (
+                    <Heading size="sm" mb={2}>
+                      Επιλογή #{index + 1}
+                    </Heading>
+                  )}
+                  {(value as Record<string, any>)?.name ||
+                    (Array.isArray(value)
+                      ? value.join('\n')
+                      : valueDisplay
+                        ? valueDisplay(value)
+                        : value) ||
+                    ''}
+                </TableDataCell>
+              );
+            })}
+            {disabled === true ||
+            (disabledEdit === true && disabledDelete === true) ? null : (
+              <TableDataCell variant={borderVariant}>
+                <Stack {...stackProps}>
+                  {disabledEdit !== true && (
+                    <Button
+                      variant="link"
+                      type="button"
+                      onClick={() => {
+                        edit(name);
+                      }}
+                    >
+                      Επεξεργασία
+                    </Button>
+                  )}
+                  {disabledDelete !== true && (
+                    <Button
+                      variant="link"
+                      type="button"
+                      onClick={() => remove(name)}
+                    >
+                      Διαγραφή
+                    </Button>
+                  )}
+                </Stack>
+              </TableDataCell>
+            )}
+          </TableRow>
+          {sortable && (
+            <TableRow>
+              <TableDataCell
+                variant={isLast ? 'none' : 'border'}
+                colSpan={
+                  disabled === true ||
+                  (disabledEdit === true && disabledDelete === true)
+                    ? values.length
+                    : values.length + 1
+                }
+              >
+                {sortable && !disabled && !(isFirst && isLast) && (
+                  <Grid xs={12} mt={2}>
+                    Μετακίνηση{' '}
+                    {!isFirst && (
+                      <>
+                        προς τα{' '}
+                        <Button
+                          type="button"
+                          variant="link"
+                          onClick={() => move(index, index - 1)}
+                        >
+                          πάνω
+                        </Button>
+                      </>
+                    )}
+                    {!isFirst && !isLast && ' ή '}
+                    {!isLast && (
+                      <>
+                        προς τα{' '}
+                        <Button
+                          type="button"
+                          variant="link"
+                          onClick={() => move(index, index + 1)}
+                        >
+                          κάτω
+                        </Button>
+                      </>
+                    )}
+                  </Grid>
+                )}
+              </TableDataCell>
+            </TableRow>
+          )}
+        </>
+      )}
+    </>
+  );
+};

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

@@ -0,0 +1,15 @@
+import React from 'react';
+import { TableHead, TableHeadCell, TableRow } from '@digigov/ui/content';
+
+export const ArrayItemHeader = ({ labels, disabled }) => {
+  return (
+    <TableHead>
+      <TableRow>
+        {labels.map((label, index) => {
+          return <TableHeadCell key={index}>{label}</TableHeadCell>;
+        })}
+        {!disabled && <TableHeadCell>Ενέργειες</TableHeadCell>}
+      </TableRow>
+    </TableHead>
+  );
+};

package/src/FieldArray/FormDialog/ArrayDisplay/__stories__/Cards.tsx

@@ -0,0 +1,88 @@
+import React, { useState } from 'react';
+import { ArrayDisplay } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/';
+
+const mockOfField = {
+  type: 'object',
+  label: { primary: 'Item' },
+  extra: {
+    fields: [
+      { key: 'afm', label: { primary: 'ΑΦΜ' } },
+      { key: 'firstName', label: { primary: 'Όνομα' } },
+      { key: 'lastName', label: { primary: 'Επώνυμο' } },
+    ],
+  },
+};
+
+const mockCustomField = {
+  editable: true,
+  extra: {
+    noHeader: false,
+    noEdit: false,
+    noDelete: false,
+    border: true,
+    verticalAlign: 'top',
+    wordBreak: 'break-all',
+    layout: 'card',
+  },
+};
+
+const initialValues = [
+  {
+    afm: '123456789',
+    firstName: 'Γιάννης',
+    lastName: 'Παπαδόπουλος',
+  },
+  {
+    afm: '987654321',
+    firstName: 'Μαρία',
+    lastName: 'Κωνσταντίνου',
+  },
+  {
+    afm: '456789123',
+    firstName: 'Δημήτρης',
+    lastName: 'Αθανασίου',
+  },
+];
+
+export const Cards = () => {
+  const [fieldArrayValues, setFieldArrayValues] = useState(initialValues);
+
+  const handleEdit = (index: number) => {
+    const newFirstName = prompt(
+      '[TEST INTERFACE] Εισάγετε νέο όνομα:',
+      fieldArrayValues[index].firstName
+    );
+    if (newFirstName !== null) {
+      const newValues = [...fieldArrayValues];
+      newValues[index] = { ...newValues[index], firstName: newFirstName };
+      setFieldArrayValues(newValues);
+    }
+  };
+
+  const handleRemove = (index: number) => {
+    if (confirm('Είστε βέβαιοι ότι θέλετε να διαγράψετε αυτό το στοιχείο;')) {
+      const newValues = fieldArrayValues.filter((_, i) => i !== index);
+      setFieldArrayValues(newValues);
+    }
+  };
+
+  const handleMove = (fromIndex: number, toIndex: number) => {
+    const newValues = [...fieldArrayValues];
+    const [movedItem] = newValues.splice(fromIndex, 1);
+    newValues.splice(toIndex, 0, movedItem);
+    setFieldArrayValues(newValues);
+  };
+
+  return (
+    <ArrayDisplay
+      fieldArrayName="signatories"
+      fieldArrayValues={fieldArrayValues}
+      ofField={mockOfField}
+      customField={mockCustomField}
+      onEdit={handleEdit}
+      onRemove={handleRemove}
+      move={handleMove}
+      sortable={false}
+    />
+  );
+};