@digigov/form 2.0.0-2a26e869 → 2.0.0-32ae417f

package/src/Questions/doc.mdx

@@ -14,6 +14,7 @@ import {
   TableDataCell,
 } from '@digigov/react-core';
 
+# Questions
 
 Question pages are used to ask users meaningful questions needed by your
 GOV.GR service, or even gather data about their persona or their application
@@ -46,7 +47,7 @@ import { Field } from '@digigov/form';
 const steps = [
   {
     name: 'residency',
-    title: 'Where do you live?',
+    title: 'Που μένετε;',
     fields: [
       {
         key: 'countries',
@@ -56,25 +57,25 @@ const steps = [
           options: [
             {
               label: {
-                primary: 'Greece',
+                primary: 'Ελλάδα',
               },
               value: 'greece',
             },
             {
               label: {
-                primary: 'Cyprus',
+                primary: 'Κύπρος',
               },
               value: 'cyprus',
             },
             {
               label: {
-                primary: 'European Union',
+                primary: 'Ευρωπαϊκή Ένωση',
               },
               value: 'eu',
             },
             {
               label: {
-                primary: 'United States of America',
+                primary: 'Ηνωμένες Πολιτείες της Αμερικής',
               },
               value: 'usa',
             },
@@ -85,12 +86,12 @@ const steps = [
   },
   {
     name: 'dob',
-    title: 'When is your birthday?',
+    title: 'Ποια είναι ημερομηνία γέννησής σας;',
     fields: [
       {
         key: 'dob',
         label: {
-          primary: 'Birthday',
+          primary: 'Ημερομηνία γέννησης',
         },
         type: 'date',
         required: true,
@@ -184,7 +185,7 @@ object. The most basic properties are the following:
 ```json pure title="step-name.json"
 {
   "name": "name",
-  "title": "What is your name?",
+  "title": "Ποιο είναι το όνομά σας;",
   "fields": [
     {
       "key": "name",
@@ -210,7 +211,7 @@ the next `step`.
 const steps = [
   {
     name: 'age',
-    title: 'What is your age?',
+    title: 'Ποια είναι η ηλικία σας?',
     fields: [
       {
         key: 'age',
@@ -226,13 +227,13 @@ const steps = [
   },
   {
     name: 'citizen-underage',
-    title: 'Are you a student?',
+    title: 'Είστε μαθητής;',
     fields: [ ... ]
   },
   {
     // highlight-next-line
     name: 'citizen-adult',
-    title: 'Are you currently employed?',
+    title: 'Εργάζεστε;',
     fields: [
       {
         key: 'citizen-underage-employed',
@@ -242,11 +243,11 @@ const steps = [
           options: [
             {
               label: {primary: "Yes"},
-              value: 'yes',
+              value: 'Ναι',
             },
             {
               label: {primary: "No"},
-              value: 'no',
+              value: 'ΌΧι',
             }
           ]
         }
@@ -280,7 +281,7 @@ import TranslatorsHeader from 'translators-landing/components/TranslatorsHeader'
 const steps = [
   {
     name: 'age',
-    title: 'What is your age?',
+    title: 'Ποια είναι η ηλικία σας;',
     fields: [
       {
         key: 'age',
@@ -294,7 +295,7 @@ const steps = [
   },
   {
     name: 'citizen-underage',
-    title: 'Are you a student?',
+    title: 'Είστε μαθητής;',
     fields: [
       {
         key: 'citizen-underage-student',
@@ -303,11 +304,11 @@ const steps = [
         extra: {
           options: [
             {
-              label: { primary: 'Yes' },
+              label: { primary: 'Ναι' },
               value: 'yes',
             },
             {
-              label: { primary: 'No' },
+              label: { primary: 'Όχι' },
               value: 'no',
             },
           ],
@@ -317,7 +318,7 @@ const steps = [
   },
   {
     name: 'citizen-adult',
-    title: 'Are you currently employed?',
+    title: 'Εργάζεστε;',
     fields: [
       {
         key: 'citizen-adult-employed',
@@ -326,11 +327,11 @@ const steps = [
         extra: {
           options: [
             {
-              label: { primary: 'Yes' },
+              label: { primary: 'Ναι' },
               value: 'yes',
             },
             {
-              label: { primary: 'No' },
+              label: { primary: 'Όχι' },
               value: 'no',
             },
           ],
@@ -389,24 +390,3 @@ export default function Index() {
   );
 }
 ```
-
-## Prop types
-
-<TableContainer>
-  <Table>
-    <TableHead>
-      <TableRow>
-        <TableHeadCell>Περίοδος</TableHeadCell>
-        <TableHeadCell>Κανονικό ποσό</TableHeadCell>
-        <TableHeadCell>Μειωμένο ποσό</TableHeadCell>
-      </TableRow>
-    </TableHead>
-    <TableBody>
-      <TableRow>
-        <TableDataCell>Πρώτες 6 εβδομάδες </TableDataCell>
-        <TableDataCell> €109.80 / εβδομάδα</TableDataCell>
-        <TableDataCell> €69.80 / εβδομάδα</TableDataCell>
-      </TableRow>
-    </TableBody>
-  </Table>
-</TableContainer>

package/src/Questions/index.test.tsx

@@ -14,6 +14,10 @@ test('renders the All Questions variants', async ({ mount, page }) => {
   )
   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/doc.mdx

@@ -1,16 +1,16 @@
 ---
 id: Introduction
-title: Digigov Form
-sidebar_label: Introduction to Digigov Form
 ---
 
+# Digigov form
+
 Digigov Form is an off-the-shelf solution for managing web forms using
 Reactjs. It supports flexible and multi-step forms and easy-to-use validation.
 This page will guide you through everything you need to create accessible and
 dynamic forms that can handle all sorts of user inputs.
 
 <img
-  src="/img/form.svg"
+  src="/tmp/form.svg"
   style={{ margin: '3rem 0', maxWidth: '450px', width: '60%' }}
 />
 
@@ -30,18 +30,33 @@ will be able to save via an JSON API.
 The `@digigov/form` NPM package contains React components and validators. The
 library uses basic, semantically correct HTML5 input fields.
 
-It adds dynamic control, interactivity and validations to the core input
-components implemented in `@digigov/react-core`. Styling is provided by
-`@digigov/css` library following the [GOV.GR design
-system](https://guide.services.gov.gr).
+### 📦 Installation
+
+```sh
+yarn add @digigov/form
+
+```
+
+Or using npm:
+
+```sh
+npm install i @digigov/form
 
-Digigov Form uses two main libraries internally. The first is [React Hook
-Form](https://www.react-hook-form.com/) which helps us manage the form state and
-perform actions and mutations on it. The second is
-[Yup](https://github.com/jquense/yup) and it is used to validate form data. It
+```
+
+`digigov/form` is a **form management solution** which adds dynamic control while simplifies handling user input, based on:
+
+✅ [React Hook Form](https://www.react-hook-form.com/) which helps us manage the form state and
+perform actions and mutations on it.
+
+🛠️ [Yup](https://github.com/jquense/yup) and it is used to validate form data. It
 interfaces with React Hook Form right out of the box, but also enables us to
 define custom validation types such as AMKA, AFM etc.
 
+🔄 [Multi-step](/components/@digigov/form/Questions) forms for complex workflows.
+
+🔗 [digigov/form](/components/@digigov/form/FormBuilder) components for a consistent UI.
+
 Some basic functionalites of `@digigov/form` will be presented in the following
 sections and also we are going to guide you through some more advanced topics
 such as internationalisation, custom data validation etc.

package/src/inputs/AutoCompleteInput/AutoComplete.stories.js

@@ -1,7 +1,10 @@
 import AutoComplete from '@digigov/form/inputs/AutoCompleteInput';
+import doc from './doc.mdx?raw';
 export default {
   title: 'Digigov Form/inputs/AutoCompleteInput',
   component: AutoComplete,
+  tags: ['autodocs'],
+  markdown: doc,
   displayName: 'AutoCompleteInput',
 };
 export { Default } from '@digigov/form/inputs/AutoCompleteInput/__stories__/Default';

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

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

package/src/inputs/AutoCompleteInput/__stories__/Multiple.tsx

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

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

@@ -18,6 +18,10 @@ test('renders the All AutoCompleteInput variants', async ({ mount, page }) => {
   )
   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/AutoCompleteInput/index.tsx

@@ -90,6 +90,7 @@ export const AutoCompleteInput: React.FC<AutoCompleteInputProps> = ({
         ...props,
         reset: undefined,
         required: undefined,
+        Field: undefined,
       }}
       name={name}
       id={`${name}-id`}

package/src/inputs/Checkboxes/Checkboxes.stories.js

@@ -1,7 +1,10 @@
 import Checkboxes from '@digigov/form/inputs/Checkboxes';
+import doc from './doc.mdx?raw';
 export default {
   title: 'Digigov Form/inputs/Checkboxes',
   component: Checkboxes,
+  tags: ['autodocs'],
+  markdown: doc,
   displayName: 'Checkboxes',
 };
 export { Default } from '@digigov/form/inputs/Checkboxes/__stories__/Default';

package/src/inputs/Checkboxes/__stories__/Conditional.tsx

@@ -84,7 +84,7 @@ const fields: FieldSpec[] = [
   },
 ];
 
-export const Conditional = () => (
+export const Conditional = (_: any) => (
   <FormBuilder
     onSubmit={(data) => {
       console.log(data);

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

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

package/src/inputs/Checkboxes/__stories__/WithDivider.tsx

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

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

@@ -22,6 +22,10 @@ test('renders the All Checkboxes variants', async ({ mount, page }) => {
   )
   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/Checkboxes/index.tsx

@@ -32,14 +32,10 @@ export const Checkboxes: React.FC<CheckboxesProps> = ({
   const handleChange =
     (optionValue, idx, show) =>
     (evt): void => {
-      let newValue;
+      let newValue: any = [];
       if (evt.currentTarget.checked) {
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
         newValue = value.concat([optionValue]);
       } else {
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
         newValue = value.filter((val) => val !== optionValue);
       }
       if (show && show.length > 0) {
@@ -75,6 +71,7 @@ export const Checkboxes: React.FC<CheckboxesProps> = ({
             <CheckboxItem
               key={`${name}.${index}`}
               name={`${name}.${v}`}
+              id={`${name}.${v}`}
               value={v}
               disabled={disabled || optionDisabled}
               checked={value?.includes(v)}
@@ -84,6 +81,7 @@ export const Checkboxes: React.FC<CheckboxesProps> = ({
                 ...props,
                 reset: undefined,
                 defaultValue: undefined,
+                error: undefined,
                 onBlur: undefined,
                 required: undefined,
                 'aria-describedby': undefined,

package/src/inputs/DateInput/DateInput.stories.js

@@ -1,7 +1,14 @@
 import DateInput from '@digigov/form/inputs/DateInput';
+import doc from './doc.mdx?raw';
 export default {
   title: 'Digigov Form/inputs/DateInput',
   component: DateInput,
+  tags: ['autodocs'],
+  markdown: doc,
   displayName: 'DateInput',
 };
 export { Default } from '@digigov/form/inputs/DateInput/__stories__/Default';
+export { WithDefaultValue } from '@digigov/form/inputs/DateInput/__stories__/WithDefaultValue';
+export { WithWrongDefaultValue } from '@digigov/form/inputs/DateInput/__stories__/WithWrongDefaultValue';
+export { WithInitialValue } from '@digigov/form/inputs/DateInput/__stories__/WithInitialValue';
+export { WithWrongInitialValue } from '@digigov/form/inputs/DateInput/__stories__/WithWrongInitialValue';

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

@@ -14,7 +14,7 @@ const fields = [
   } as const,
 ];
 
-export const Default = () => (
+export const Default = (_: any) => (
   <FormBuilder onSubmit={() => console.log('kati')}>
     {fields.map(({ key, ...field }) => {
       return <Field {...field} name={key} key={key} />;

package/src/inputs/DateInput/__stories__/WithDefaultValue.tsx

@@ -0,0 +1,26 @@
+import React from 'react';
+import FormBuilder, { Field } from '@digigov/form';
+import { Button } from '@digigov/ui/form/Button';
+
+const fields = [
+  {
+    key: 'date_example',
+    type: 'date',
+    required: true,
+    defaultValue: '05/11/2020',
+    label: {
+      primary: 'Πότε εκδόθηκε το διαβατήριο σας;',
+      secondary: 'Για παράδειγμα, 05 11 2020',
+    },
+  } as const,
+];
+
+export const WithDefaultValue = (_: any) => (
+  <FormBuilder onSubmit={(data) => console.log(data)}>
+    {fields.map(({ key, ...field }) => {
+      return <Field {...field} name={key} key={key} />;
+    })}
+    <Button type="submit">Συνέχεια</Button>
+  </FormBuilder>
+);
+export default WithDefaultValue;

package/src/inputs/DateInput/__stories__/WithInitialValue.tsx

@@ -0,0 +1,28 @@
+import React from 'react';
+import FormBuilder, { Field } from '@digigov/form';
+import { Button } from '@digigov/ui/form/Button';
+
+const fields = [
+  {
+    key: 'date_example',
+    type: 'date',
+    required: true,
+    label: {
+      primary: 'Πότε εκδόθηκε το διαβατήριο σας;',
+      secondary: 'Για παράδειγμα, 05 11 2020',
+    },
+  } as const,
+];
+
+export const WithInitialValue = (_: any) => (
+  <FormBuilder
+    initial={{ date_example: '05/01/2020' }}
+    onSubmit={(data) => console.log(data)}
+  >
+    {fields.map(({ key, ...field }) => {
+      return <Field {...field} name={key} key={key} />;
+    })}
+    <Button type="submit">Συνέχεια</Button>
+  </FormBuilder>
+);
+export default WithInitialValue;

package/src/inputs/DateInput/__stories__/WithWrongDefaultValue.tsx

@@ -0,0 +1,26 @@
+import React from 'react';
+import FormBuilder, { Field } from '@digigov/form';
+import { Button } from '@digigov/ui/form/Button';
+
+const fields = [
+  {
+    key: 'date_example',
+    type: 'date',
+    required: true,
+    defaultValue: '5/1/2020',
+    label: {
+      primary: 'Πότε εκδόθηκε το διαβατήριο σας;',
+      secondary: 'Για παράδειγμα, 05 11 2020',
+    },
+  } as const,
+];
+
+export const WithWrongDefaultValue = (_: any) => (
+  <FormBuilder onSubmit={(data) => console.log(data)}>
+    {fields.map(({ key, ...field }) => {
+      return <Field {...field} name={key} key={key} />;
+    })}
+    <Button type="submit">Συνέχεια</Button>
+  </FormBuilder>
+);
+export default WithWrongDefaultValue;

package/src/inputs/DateInput/__stories__/WithWrongInitialValue.tsx

@@ -0,0 +1,28 @@
+import React from 'react';
+import FormBuilder, { Field } from '@digigov/form';
+import { Button } from '@digigov/ui/form/Button';
+
+const fields = [
+  {
+    key: 'date_example',
+    type: 'date',
+    required: true,
+    label: {
+      primary: 'Πότε εκδόθηκε το διαβατήριο σας;',
+      secondary: 'Για παράδειγμα, 05 11 2020',
+    },
+  } as const,
+];
+
+export const WithWrongInitialValue = (_: any) => (
+  <FormBuilder
+    initial={{ date_example: '5/1/2020' }}
+    onSubmit={(data) => console.log(data)}
+  >
+    {fields.map(({ key, ...field }) => {
+      return <Field {...field} name={key} key={key} />;
+    })}
+    <Button type="submit">Συνέχεια</Button>
+  </FormBuilder>
+);
+export default WithWrongInitialValue;

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

@@ -2,6 +2,10 @@ 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/DateInput/__stories__/Default';
+import { WithDefaultValue } from '@digigov/form/inputs/DateInput/__stories__/WithDefaultValue';
+import { WithInitialValue } from '@digigov/form/inputs/DateInput/__stories__/WithInitialValue';
+import { WithWrongDefaultValue } from '@digigov/form/inputs/DateInput/__stories__/WithWrongDefaultValue';
+import { WithWrongInitialValue } from '@digigov/form/inputs/DateInput/__stories__/WithWrongInitialValue';
 
 test('renders the All DateInput variants', async ({ mount, page }) => {
   await mount(
@@ -10,10 +14,26 @@ test('renders the All DateInput variants', async ({ mount, page }) => {
     <TestVariant title="Default">
       <Default />
     </TestVariant>
+    <TestVariant title="WithDefaultValue">
+      <WithDefaultValue />
+    </TestVariant>
+    <TestVariant title="WithInitialValue">
+      <WithInitialValue />
+    </TestVariant>
+    <TestVariant title="WithWrongDefaultValue">
+      <WithWrongDefaultValue />
+    </TestVariant>
+    <TestVariant title="WithWrongInitialValue">
+      <WithWrongInitialValue />
+    </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();
 });