@digigov/form 2.0.0-4be8f7cc → 2.0.0-5701c39b

package/src/inputs/FileInput/index.tsx

@@ -1,11 +1,20 @@
-import React, { useState } from 'react';
-import { UncontrolledFieldProps } from '@digigov/form/Field/types';
-import FileUpload from '@digigov/react-core/FileUpload';
-import FileUploadContainer from '@digigov/react-core/FileUploadContainer';
-import CoreHint from '@digigov/react-core/Hint';
-import Button from '@digigov/ui/form/Button';
+import type { ComponentRef } from 'react';
+import React, { useCallback, useEffect, useState } from 'react';
+import type { UseFormReturn } from 'react-hook-form';
+import { useWatch } from 'react-hook-form';
+import type { UncontrolledFieldProps } from '@digigov/form/Field/types';
+import { omit } from '@digigov/form/utils';
+import type { ButtonProps } from '@digigov/ui/form/Button';
+import { Button } from '@digigov/ui/form/Button';
+import type {
+  FileUploadContainerProps,
+  FileUploadProps,
+} from '@digigov/ui/form/FileUpload';
+import { FileUpload, FileUploadContainer } from '@digigov/ui/form/FileUpload';
 import { useTranslation } from '@digigov/ui/i18n';
-import Paragraph from '@digigov/ui/typography/Paragraph';
+import { Hint } from '@digigov/ui/typography/Hint';
+import { Paragraph } from '@digigov/ui/typography/Paragraph';
+
 export interface FileInputProps extends Omit<UncontrolledFieldProps, 'extra'> {
   extra?: {
     className?: string;
@@ -14,62 +23,112 @@ export interface FileInputProps extends Omit<UncontrolledFieldProps, 'extra'> {
     limit: {
       maxSize?: number;
     };
+    containerProps?: FileUploadContainerProps;
+    uploadButtonProps?: FileUploadProps;
+    noResetButton?: boolean;
+    resetButtonProps?: ButtonProps;
+    locales?: {
+      file?: string;
+      chooseFile?: string;
+      changeFile?: string;
+      resetFile?: string;
+    };
   };
+  reset: (values?: FileList) => void;
+  resetField: UseFormReturn['resetField'];
+  onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const FileInput: React.FC<any> = React.forwardRef(function FileInput(
-  { name, extra = {}, disabled, reset, onChange, ...props },
-  ref: any
+export const FileInput = React.forwardRef<
+  ComponentRef<typeof FileUpload>,
+  FileInputProps
+>(function FileInput(
+  { name, disabled, extra, control, onChange, resetField, ...props },
+  ref
 ) {
   const { t } = useTranslation();
-  const [files, setFiles] = useState<Array<string> | undefined>([]);
-  const handleChange = (e) => {
-    const target = e.target as HTMLInputElement;
-    const selectedFiles = Array.from(
-      target.files as ArrayLike<{ name: string }>
-    ).map(({ name }) => name);
-    setFiles(selectedFiles);
-    // proceed calling the onChange provided
-    // by react-hook-form
-    onChange(e);
-  };
+  const value: FileList = useWatch({ control, name });
+
+  const [filenames, setFilenames] = useState<string[] | undefined>(
+    Object.values(value || {}).map(({ name }) => name) || []
+  );
+
+  useEffect(() => {
+    setFilenames(Object.values(value || {}).map(({ name }) => name));
+  }, [value]);
+
+  const handleChange = useCallback(
+    (event: React.ChangeEvent<HTMLInputElement>) => {
+      event.preventDefault();
+      const target = event.target;
+      if (target.files && target.files.length > 0) {
+        setFilenames(Object.values(target.files).map(({ name }) => name));
+      }
+      onChange(event);
+    },
+    [onChange]
+  );
+
+  const handleReset = useCallback(
+    (event: React.MouseEvent<HTMLButtonElement>) => {
+      event.preventDefault();
+      resetField(name);
+      setFilenames(undefined);
+    },
+    [name, resetField]
+  );
+
   return (
     <>
-      <FileUploadContainer hasFiles={files && files.length > 0}>
-        {files?.length ? (
+      <FileUploadContainer
+        variant={extra?.containerProps?.variant || 'default'}
+        hasFiles={filenames && filenames.length > 0}
+      >
+        {filenames?.length ? (
           <>
             <Paragraph>
-              <b>{t('upload.file')}:</b> {`${files.join(', ')}`}
+              <b>{t('upload.file')}:</b> {`${filenames.join(', ')}`}
             </Paragraph>
           </>
         ) : (
-          <CoreHint>{t('upload.no_file')}</CoreHint>
+          <Hint>
+            <b>
+              {t('upload.file')}
+              {': '}
+            </b>
+            {t('upload.no_file')}
+          </Hint>
         )}
         <FileUpload
           ref={ref}
-          hasFiles={!!files?.length}
+          hasFiles={!!filenames?.length}
           name={name}
+          variant={extra?.uploadButtonProps?.variant}
           disabled={disabled}
+          id={name}
           onChange={handleChange}
-          {...{ ...props, required: undefined }}
+          {...{
+            ...omit(props, ['Field', 'reset', 'error']),
+            required: undefined,
+          }}
         >
-          {files?.length ? t('upload.change_file') : t('upload.choose_file')}
+          {filenames?.length
+            ? t('upload.change_file')
+            : t('upload.choose_file')}
         </FileUpload>
-        {files !== undefined && files.length > 0 && (
-          <>
-            <Button
-              variant="link"
-              onClick={(event) => {
-                event.preventDefault();
-                reset({ [name]: '' });
-                setFiles(undefined);
-              }}
-            >
-              {t('upload.reset_file')}
-            </Button>
-          </>
-        )}
+        {filenames !== undefined &&
+          filenames?.length > 0 &&
+          !extra?.noResetButton && (
+            <>
+              <Button
+                variant={extra?.resetButtonProps?.variant || 'link'}
+                onClick={handleReset}
+                color={extra?.resetButtonProps?.color || 'secondary'}
+              >
+                {t('upload.reset_file')}
+              </Button>
+            </>
+          )}
       </FileUploadContainer>
     </>
   );

package/src/inputs/ImageInput/ImageInput.stories.js

@@ -1,9 +1,13 @@
 import ImageInput from '@digigov/form/inputs/ImageInput';
+import doc from './doc.mdx?raw';
 export default {
   title: 'Digigov Form/inputs/ImageInput',
   component: ImageInput,
+  tags: ['autodocs'],
+  markdown: doc,
   displayName: 'ImageInput',
 };
-export * from '@digigov/form/inputs/ImageInput/__stories__/Default';
-export * from '@digigov/form/inputs/ImageInput/__stories__/WithInvalidImageSize';
-export * from '@digigov/form/inputs/ImageInput/__stories__/WithInvalidImageDimension';
+export { Default } from '@digigov/form/inputs/ImageInput/__stories__/Default';
+export { MaxSize } from '@digigov/form/inputs/ImageInput/__stories__/MaxSize';
+export { WithInvalidImageDimension } from '@digigov/form/inputs/ImageInput/__stories__/WithInvalidImageDimension';
+export { WithInitialValues } from '@digigov/form/inputs/ImageInput/__stories__/WithInitialValues';

package/src/inputs/ImageInput/__stories__/Default.tsx

@@ -13,7 +13,7 @@ const FIELDS: FieldSpec[] = [
   },
 ];
 
-export const Default = () => (
+export const Default = (_: any) => (
   <FormBuilder
     fields={FIELDS}
     onSubmit={(data) => {

package/src/inputs/ImageInput/__stories__/{WithInvalidImageSize.tsx → MaxSize.tsx}

@@ -9,16 +9,18 @@ const FIELDS: FieldSpec[] = [
     required: true,
     label: {
       primary: 'Ανέβασμα φωτογραφίας',
+      secondary: 'Μέγιστο μέγεθος φωτογραφίας: 1KB.',
     },
     extra: {
       limit: {
-        maxSize: 300,
+        // bytes
+        maxSize: 1000,
       },
     },
   },
 ];
 
-export const WithInvalidImageSize = () => (
+export const MaxSize = (_: any) => (
   <FormBuilder
     fields={FIELDS}
     onSubmit={(data) => {
@@ -33,4 +35,4 @@ export const WithInvalidImageSize = () => (
     <Button type="submit">Συνέχεια</Button>
   </FormBuilder>
 );
-export default WithInvalidImageSize;
+export default MaxSize;

package/src/inputs/ImageInput/__stories__/WithInitialValues.tsx

@@ -0,0 +1,45 @@
+import React from 'react';
+import FormBuilder, { Field, Fieldset } from '@digigov/form';
+import logo from '@digigov/form/inputs/ImageInput/__stories__/logo.png';
+import { FieldSpec } from '@digigov/form/types';
+import { Button } from '@digigov/ui/form/Button';
+const FIELDS: FieldSpec[] = [
+  {
+    key: 'image',
+    type: 'image',
+    required: true,
+    label: {
+      primary: 'Ανέβασμα φωτογραφίας',
+      secondary:
+        'Οι επιτρεπόμενες διαστάσεις είναι για το ύψος από 100 μέχρι 400 και για το πλάτος από 100 μέχρι 400.',
+    },
+    extra: {
+      limit: {
+        maxHeight: 400,
+        maxWidth: 400,
+        minHeight: 100,
+        minWidth: 100,
+      },
+    },
+  },
+];
+
+export const WithInitialValues = (_: any) => (
+  <FormBuilder
+    fields={FIELDS}
+    initial={{
+      image: { src: logo, filename: 'logo.png' },
+    }}
+    onSubmit={(data) => {
+      console.log(data);
+    }}
+  >
+    <Fieldset>
+      {FIELDS.map((field) => (
+        <Field key={field.key} name={field.key} />
+      ))}
+    </Fieldset>
+    <Button type="submit">Συνέχεια</Button>
+  </FormBuilder>
+);
+export default WithInitialValues;

package/src/inputs/ImageInput/__stories__/WithInvalidImageDimension.tsx

@@ -9,6 +9,8 @@ const FIELDS: FieldSpec[] = [
     required: true,
     label: {
       primary: 'Ανέβασμα φωτογραφίας',
+      secondary:
+        'Οι επιτρεπόμενες διαστάσεις είναι για το ύψος από 100 μέχρι 400 και για το πλάτος από 100 μέχρι 400.',
     },
     extra: {
       limit: {
@@ -21,7 +23,7 @@ const FIELDS: FieldSpec[] = [
   },
 ];
 
-export const WithInvalidImageDimension = () => (
+export const WithInvalidImageDimension = (_: any) => (
   <FormBuilder
     fields={FIELDS}
     onSubmit={(data) => {

package/src/inputs/ImageInput/__stories__/logo.d.ts

@@ -0,0 +1,4 @@
+declare module '*.png' {
+  const value: any;
+  export default value;
+}

package/src/inputs/ImageInput/doc.mdx

@@ -0,0 +1,23 @@
+---
+title: Image Input
+---
+ 
+# Image input
+
+
+
+Input element of type `image` defines an image as a submit button, i.e. submit buttons that take the form of an image rather than text.
+
+## How to use
+
+### Default
+
+<code src="@digigov/form/inputs/ImageInput/__stories__/Default.tsx" />
+
+### Display with max size
+
+<code src="@digigov/form/inputs/ImageInput/__stories__/MaxSize.tsx" />
+
+### Display with min and max image dimensions
+
+<code src="@digigov/form/inputs/ImageInput/__stories__/WithInvalidImageDimension.tsx" />

package/src/inputs/ImageInput/index.test.tsx

@@ -0,0 +1,36 @@
+import React from 'react';
+import { test, expect } from '@playwright/experimental-ct-react';
+import TestVariant from '@digigov/ui/utils/TestVariant'
+import { Default } from '@digigov/form/inputs/ImageInput/__stories__/Default';
+import { MaxSize } from '@digigov/form/inputs/ImageInput/__stories__/MaxSize';
+import { WithInitialValues } from '@digigov/form/inputs/ImageInput/__stories__/WithInitialValues';
+import { WithInvalidImageDimension } from '@digigov/form/inputs/ImageInput/__stories__/WithInvalidImageDimension';
+
+test('renders the All ImageInput variants', async ({ mount, page }) => {
+  await mount(
+    
+  <div>
+    <TestVariant title="Default">
+      <Default />
+    </TestVariant>
+    <TestVariant title="MaxSize">
+      <MaxSize />
+    </TestVariant>
+    <TestVariant title="WithInitialValues">
+      <WithInitialValues />
+    </TestVariant>
+    <TestVariant title="WithInvalidImageDimension">
+      <WithInvalidImageDimension />
+    </TestVariant>
+  </div>
+  )
+  await page.evaluate(() => document.fonts.ready);
+
+  // Move the mouse to the top-left corner to avoid random hover issues
+  await page.mouse.move(0, 0);
+
+
+  const screenshot = await page.screenshot({ fullPage: true, animations: 'disabled' });
+  expect(screenshot).toMatchSnapshot();
+});
+  

package/src/inputs/ImageInput/index.tsx

@@ -1,14 +1,15 @@
-import React, { useState, useCallback } from 'react';
-import { UncontrolledFieldProps } from '@digigov/form/Field/types';
-import FileUpload from '@digigov/react-core/FileUpload';
-import FileUploadContainer from '@digigov/react-core/FileUploadContainer';
-import CoreHint from '@digigov/react-core/Hint';
-import Button, { ButtonGroup } from '@digigov/ui/form/Button';
+import React, { useRef, useState, useEffect, useCallback } from 'react';
+import type { UseFormReturn } from 'react-hook-form';
+import type { UncontrolledFieldProps } from '@digigov/form/Field/types';
+import { omit } from '@digigov/form/utils';
+import { Button, ButtonGroup } from '@digigov/ui/form/Button';
+import { FileUpload, FileUploadContainer } from '@digigov/ui/form/FileUpload';
 import { useTranslation } from '@digigov/ui/i18n';
-import Paragraph from '@digigov/ui/typography/Paragraph';
-
+import { Hint } from '@digigov/ui/typography/Hint';
+import { Paragraph } from '@digigov/ui/typography/Paragraph';
+import { Base } from '@digigov/ui/utils/Base';
 export interface ImageProps {
-  src?: any;
+  src: string;
 }
 
 export interface Limit {
@@ -20,8 +21,20 @@ export interface Limit {
 }
 
 export const Image: React.FC<ImageProps> = React.memo(function Image({ src }) {
-  return <img src={src} className="ds-image--ratio" />;
+  return <Base as="img" src={src} className="ds-image--ratio" />;
 });
+
+interface ImageInputDefaultValue {
+  filename: string;
+  src: string;
+}
+
+const blobToFileList = (blob: Blob, fileName: string): FileList => {
+  const file = new File([blob], fileName, { type: 'image/jpeg' });
+  const dataTransfer = new DataTransfer();
+  dataTransfer.items.add(file);
+  return dataTransfer.files;
+};
 export interface ImageInputProps extends Omit<UncontrolledFieldProps, 'extra'> {
   extra?: {
     className?: string;
@@ -30,28 +43,40 @@ export interface ImageInputProps extends Omit<UncontrolledFieldProps, 'extra'> {
     limit?: Limit;
   };
   reset: (values?: any) => void;
+  resetField: UseFormReturn['resetField'];
   onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+  defaultValue?: ImageInputDefaultValue | null;
+  value: any;
 }
 
 export const ImageInput: React.FC<ImageInputProps> = React.forwardRef(
   function ImageInput(
-    { name, extra = {}, disabled, onChange, reset, ...props },
+    { name, disabled, onChange, defaultValue, value, resetField, ...props },
     ref: any
   ) {
+    const imageRef = useRef(ref?.current);
     const { t } = useTranslation();
-    const [selectedImage, setSelectedImage] = useState<File | null>(null);
-    const [imageUrl, setImageUrl] = useState<string | null>(null);
+    const currentValue: ImageInputDefaultValue | null =
+      defaultValue || value || null;
+    const [selectedImage, setSelectedImage] = useState<
+      File | ImageInputDefaultValue | null
+    >(currentValue);
+    const [imageUrl, setImageUrl] = useState<string | null>(
+      currentValue?.src || null
+    );
+
     const handleImageChange = useCallback(
       (e: React.ChangeEvent<HTMLInputElement>) => {
         e.preventDefault();
         const target = e.target as HTMLInputElement;
         const selectedFile = target.files?.[0];
-
         if (selectedFile) {
           setSelectedImage(selectedFile);
           setImageUrl(URL.createObjectURL(selectedFile));
         }
-        onChange(e);
+        onChange(
+          target.files as unknown as React.ChangeEvent<HTMLInputElement>
+        );
       },
       [selectedImage]
     );
@@ -59,50 +84,78 @@ export const ImageInput: React.FC<ImageInputProps> = React.forwardRef(
     const handleDeleteImage = useCallback(
       (event) => {
         event.preventDefault();
-        reset({ [name]: '' });
+        resetField(name);
         setSelectedImage(null);
-        setImageUrl('');
+        setImageUrl(null);
       },
-      [selectedImage]
+      [resetField, name]
     );
 
+    useEffect(() => {
+      // This is to fill the input with the default value (image)
+      if (defaultValue?.src && imageRef.current) {
+        fetch(defaultValue?.src)
+          .then((response) => response.blob())
+          .then((blob) => {
+            const fileList = blobToFileList(blob, defaultValue.filename);
+            imageRef.current.files = fileList;
+            const fileChangeEvent = new Event('change', { bubbles: true });
+            imageRef.current.dispatchEvent(fileChangeEvent);
+            return;
+          })
+          .catch((error) => console.error('Error fetching image:', error));
+      }
+    }, [defaultValue, imageRef]);
+
     return (
-      <>
-        <FileUploadContainer>
-          {selectedImage !== null ? (
-            <>
-              <Paragraph>
-                <b>{t('upload.image')}:</b> {`${selectedImage?.name}`}
-              </Paragraph>
-            </>
-          ) : (
-            <CoreHint className="ds-dashed--border">
-              {t('upload.no_image')}
-            </CoreHint>
-          )}
+      <FileUploadContainer>
+        {selectedImage !== null ? (
           <>
-            {selectedImage !== null && <Image src={imageUrl} />}
-            <ButtonGroup marginTop={2}>
-              {selectedImage !== null && (
-                <Button variant="link" onClick={handleDeleteImage}>
-                  {t('upload.reset_file')}
-                </Button>
-              )}
-              <FileUpload
-                ref={ref}
-                hasFiles={selectedImage !== null}
-                name={name}
-                disabled={disabled}
-                accept="image/*"
-                onChange={handleImageChange}
-                {...{ ...props, required: undefined, type: 'file' }}
-              >
-                {t('upload.choose_image')}
-              </FileUpload>
-            </ButtonGroup>
+            <Paragraph>
+              <Base as="b">{t('upload.image')}:</Base>{' '}
+              <em>
+                {`${(selectedImage as File)?.name || (selectedImage as ImageInputDefaultValue)?.filename}`}
+              </em>
+            </Paragraph>
           </>
-        </FileUploadContainer>
-      </>
+        ) : (
+          <Hint className="ds-dashed--border">{t('upload.no_image')}</Hint>
+        )}
+        {imageUrl !== null && selectedImage !== null && (
+          <Image src={imageUrl} />
+        )}
+        {!disabled && (
+          <ButtonGroup marginTop={2}>
+            <FileUpload
+              ref={imageRef}
+              hasFiles={selectedImage !== null}
+              name={name}
+              id={name}
+              disabled={disabled}
+              accept="image/*"
+              onChange={handleImageChange}
+              {...{
+                ...omit(props, ['Field', 'reset', 'error']),
+                required: undefined,
+                type: 'file',
+              }}
+            >
+              {selectedImage
+                ? t('upload.change_image')
+                : t('upload.choose_image')}
+            </FileUpload>
+            {selectedImage !== null && (
+              <Button
+                color="warning"
+                variant="link"
+                onClick={handleDeleteImage}
+              >
+                {t('upload.reset_file')}
+              </Button>
+            )}
+          </ButtonGroup>
+        )}
+      </FileUploadContainer>
     );
   }
 );

package/src/inputs/Input/Input.stories.js

@@ -1,16 +1,22 @@
 import Input from '@digigov/form/inputs/Input';
+import doc from './doc.mdx?raw';
 export default {
   title: 'Digigov Form/inputs/Input',
   component: Input,
+  tags: ['autodocs'],
+  markdown: doc,
   displayName: 'Input',
 };
-export * from '@digigov/form/inputs/Input/__stories__/Default';
-export * from '@digigov/form/inputs/Input/__stories__/Integer';
-export * from '@digigov/form/inputs/Input/__stories__/Boolean';
-export * from '@digigov/form/inputs/Input/__stories__/PhoneNumber';
-export * from '@digigov/form/inputs/Input/__stories__/LandlineNumber';
-export * from '@digigov/form/inputs/Input/__stories__/MobilePhone';
-export * from '@digigov/form/inputs/Input/__stories__/AFM';
-export * from '@digigov/form/inputs/Input/__stories__/IBAN';
-export * from '@digigov/form/inputs/Input/__stories__/PostalCode';
-export * from '@digigov/form/inputs/Input/__stories__/TextWithCharacterLimit';
+export { String } from '@digigov/form/inputs/Input/__stories__/String';
+export { StringWithTrimValidation } from '@digigov/form/inputs/Input/__stories__/StringWithTrimValidation';
+export { Integer } from '@digigov/form/inputs/Input/__stories__/Integer';
+export { Boolean } from '@digigov/form/inputs/Input/__stories__/Boolean';
+export { PhoneNumber } from '@digigov/form/inputs/Input/__stories__/PhoneNumber';
+export { LandlineNumber } from '@digigov/form/inputs/Input/__stories__/LandlineNumber';
+export { MobilePhone } from '@digigov/form/inputs/Input/__stories__/MobilePhone';
+export { AFM } from '@digigov/form/inputs/Input/__stories__/AFM';
+export { AMKA } from '@digigov/form/inputs/Input/__stories__/AMKA';
+export { IBAN } from '@digigov/form/inputs/Input/__stories__/IBAN';
+export { Email } from '@digigov/form/inputs/Input/__stories__/Email';
+export { PostalCode } from '@digigov/form/inputs/Input/__stories__/PostalCode';
+export { TextWithLimit } from '@digigov/form/inputs/Input/__stories__/TextWithLimit';

package/src/inputs/Input/__stories__/AFM.tsx

@@ -2,7 +2,7 @@ import React from 'react';
 import FormBuilder, { Field } from '@digigov/form';
 import { Button } from '@digigov/ui/form/Button';
 
-export const AFM = () => (
+export const AFM = (_: any) => (
   <FormBuilder
     onSubmit={(data) => {
       console.log(data);

package/src/inputs/Input/__stories__/AMKA.tsx

@@ -0,0 +1,23 @@
+import React from 'react';
+import FormBuilder, { Field } from '@digigov/form';
+import { Button } from '@digigov/ui/form/Button';
+
+export const AMKA = () => (
+  <FormBuilder
+    onSubmit={(data) => {
+      console.log(data);
+    }}
+  >
+    <Field
+      key="amka"
+      name="amka"
+      type="amka"
+      label={{
+        primary: 'Αριθμός μητρώου κοινωνικής ασφάλισης',
+      }}
+      required
+    />
+    <Button type="submit">Συνέχεια</Button>
+  </FormBuilder>
+);
+export default AMKA;

package/src/inputs/Input/__stories__/Boolean.tsx

@@ -2,7 +2,7 @@ import React from 'react';
 import FormBuilder, { Field } from '@digigov/form';
 import { Button } from '@digigov/ui/form/Button';
 
-export const Boolean = () => (
+export const Boolean = (_: any) => (
   <FormBuilder
     onSubmit={(data) => {
       console.log(data);