@digigov/form 2.0.0-6452adf3 → 2.0.0-66d7c5e2

package/src/MultiplicityField/index.test.tsx

@@ -34,6 +34,10 @@ test('renders the All MultiplicityField 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/MultiplicityField/index.tsx

@@ -1,9 +1,10 @@
 import React, { useState } from 'react';
-import { useFieldArray, UseFormReturn } from 'react-hook-form';
+import type { UseFormReturn } from 'react-hook-form';
+import { useFieldArray } from 'react-hook-form';
 import { FieldBaseContainer } from '@digigov/form/Field/FieldBaseContainer';
 import { FieldObject } from '@digigov/form/FieldObject';
 import { AddObjects } from '@digigov/form/MultiplicityField/add-objects';
-import {
+import type {
   MultiplicityProps,
   StashedObject,
 } from '@digigov/form/MultiplicityField/types';
@@ -31,6 +32,7 @@ export const Multiplicity: React.FC<MultiplicityProps> = ({
   setValue,
   getValues,
   unregister,
+  resetField,
   Field,
 }) => {
   const { fields, append, remove } = useFieldArray({
@@ -57,8 +59,10 @@ export const Multiplicity: React.FC<MultiplicityProps> = ({
           ? error
           : undefined
       }
+      hasError={formState.isSubmitted && !formState.isSubmitting && !!error}
       wrapper="fieldset"
       name={name}
+      register={register}
     >
       {stashedObjects.length > 0 ? (
         <div>
@@ -97,6 +101,7 @@ export const Multiplicity: React.FC<MultiplicityProps> = ({
         getValues={getValues}
         unregister={unregister}
         trigger={trigger}
+        resetField={resetField}
         clearErrors={clearErrors}
         Field={Field}
       />

package/src/MultiplicityField/types.ts

@@ -1,6 +1,8 @@
-import { ErrorOption, UseFormReturn } from 'react-hook-form';
-import { FieldSpec } from '@digigov/form/Field/types';
-import { ControlledFieldProps } from '@digigov/form/Field/types';
+import type { ErrorOption, UseFormReturn } from 'react-hook-form';
+import type {
+  FieldSpec,
+  ControlledFieldProps,
+} from '@digigov/form/Field/types';
 
 export interface MultiplicityProps
   extends Omit<ControlledFieldProps, 'value' | 'onChange' | 'error' | 'extra'> {
@@ -13,6 +15,7 @@ export interface MultiplicityProps
   setValue: UseFormReturn['setValue'];
   getValues: UseFormReturn['getValues'];
   unregister: UseFormReturn['unregister'];
+  resetField?: UseFormReturn['resetField'];
   error?: ErrorOption;
   extra?: Record<string, any>;
   label?: FieldSpec['label'];

package/src/Questions/Questions.stories.js

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

package/src/Questions/Questions.tsx

@@ -1,8 +1,8 @@
 import React, { useState, useEffect } from 'react';
 import { getNextStep } from '@digigov/form/Questions/getNextStep';
 import { QuestionsContext } from '@digigov/form/Questions/QuestionsContext';
-import { StepInterface } from '@digigov/form/Questions/Step/types';
-import { QuestionsInterface } from '@digigov/form/Questions/types';
+import type { StepInterface } from '@digigov/form/Questions/Step/types';
+import type { QuestionsInterface } from '@digigov/form/Questions/types';
 
 const isBrowser = typeof window !== 'undefined';
 
@@ -31,7 +31,7 @@ export const Questions: React.FC<QuestionsInterface> = ({
   useEffect(() => {
     if (forceStepName !== currentStep.name) {
       const forceStep = steps.find(({ name }) => name === forceStepName);
-      forceStep && setCurrentStep(forceStep);
+      if (forceStep) setCurrentStep(forceStep);
     }
   }, [forceStepName]);
   const localData =
@@ -42,16 +42,16 @@ export const Questions: React.FC<QuestionsInterface> = ({
   const submitStep = (stepName, stepData): void => {
     data[stepName] = stepData;
     if (localDraft) {
-      isBrowser &&
+      if (isBrowser)
         window.localStorage.setItem(`questions-${name}`, JSON.stringify(data));
     }
     if (onChange) {
-      onChange && onChange(data);
+      onChange(data);
     }
     setData(data);
     const nextStep = getNextStep(currentStep, steps, data);
     if (nextStep) {
-      onActiveStep && onActiveStep(nextStep);
+      if (onActiveStep) onActiveStep(nextStep);
       setCurrentStep(nextStep);
     } else {
       onSubmit(data);

package/src/Questions/QuestionsContext.tsx

@@ -1,5 +1,5 @@
 import { createContext } from 'react';
-import { QuestionsContextInterface } from '@digigov/form/Questions/types';
+import type { QuestionsContextInterface } from '@digigov/form/Questions/types';
 
 const defaultStep = { name: '' };
 export const QuestionsContext = createContext<QuestionsContextInterface>({

package/src/Questions/Step/Step.tsx

@@ -2,7 +2,7 @@ import React, { useContext, useState } from 'react';
 import { QuestionsContext } from '@digigov/form/Questions/QuestionsContext';
 import { StepArrayReview } from '@digigov/form/Questions/Step/StepArrayReview';
 import { StepContext } from '@digigov/form/Questions/Step/StepContext';
-import { StepInterface } from '@digigov/form/Questions/Step/types';
+import type { StepInterface } from '@digigov/form/Questions/Step/types';
 
 /**
  * The Step component accepts Step data as props

package/src/Questions/Step/StepArrayReview.tsx

@@ -5,8 +5,8 @@ import FormBuilder from '@digigov/form/FormBuilder';
 import Label from '@digigov/form/inputs/Label';
 import { QuestionsContext } from '@digigov/form/Questions/QuestionsContext';
 import { getAddMoreFields } from '@digigov/form/Questions/Step/getAddMoreFields';
-import { StepArrayReviewInterface } from '@digigov/form/Questions/Step/types';
-import { FieldSpec } from '@digigov/form/types';
+import type { StepArrayReviewInterface } from '@digigov/form/Questions/Step/types';
+import type { FieldSpec } from '@digigov/form/types';
 import PageTitleContainer, {
   PageTitleHeading,
 } from '@digigov/ui/app/PageTitleContainer';
@@ -37,7 +37,7 @@ export const StepArrayReview: React.FC<StepArrayReviewInterface> = (props) => {
       </PageTitleContainer>
       <SummaryList>
         {props.array.map(
-          (item: { [x: string]: React.ReactNode }, idx: number) => (
+          (item: Record<string, React.ReactNode>, idx: number) => (
             <SummaryListItem key={idx}>
               <SummaryListItemKey>
                 {t(primaryField.label.primary)}

package/src/Questions/Step/StepContext.tsx

@@ -1,5 +1,5 @@
 import { createContext } from 'react';
-import { StepInterface } from '@digigov/form/Questions/Step/types';
+import type { StepInterface } from '@digigov/form/Questions/Step/types';
 
 export const StepContext = createContext<StepInterface>({
   name: '',

package/src/Questions/Step/StepDescription.tsx

@@ -1,7 +1,8 @@
 import React, { useContext } from 'react';
 import { StepContext } from '@digigov/form/Questions/Step/StepContext';
 import { useTranslation } from '@digigov/ui/i18n';
-import Paragraph, { ParagraphProps } from '@digigov/ui/typography/Paragraph';
+import type { ParagraphProps } from '@digigov/ui/typography/Paragraph';
+import Paragraph from '@digigov/ui/typography/Paragraph';
 
 export interface StepDescriptionInterface extends ParagraphProps {
   description?: string;

package/src/Questions/Step/StepForm.tsx

@@ -1,10 +1,10 @@
 import React, { useContext } from 'react';
 import Field from '@digigov/form/Field';
-import { FieldProps } from '@digigov/form/Field/types';
+import type { FieldProps } from '@digigov/form/Field/types';
 import Fieldset from '@digigov/form/Fieldset';
 import FormBuilder from '@digigov/form/FormBuilder';
 import { StepContext } from '@digigov/form/Questions/Step/StepContext';
-import { FormBuilderProps } from '@digigov/form/types';
+import type { FormBuilderProps } from '@digigov/form/types';
 import Button from '@digigov/ui/form/Button';
 import { useTranslation } from '@digigov/ui/i18n';
 

package/src/Questions/Step/StepQuote.tsx

@@ -1,5 +1,6 @@
 import React from 'react';
-import Paragraph, { ParagraphProps } from '@digigov/ui/typography/Paragraph';
+import type { ParagraphProps } from '@digigov/ui/typography/Paragraph';
+import Paragraph from '@digigov/ui/typography/Paragraph';
 
 export const StepQuote: React.FC<ParagraphProps> = ({ children, ...props }) => {
   return <Paragraph {...props}>{children}</Paragraph>;

package/src/Questions/Step/StepTitle.tsx

@@ -6,7 +6,8 @@ import {
 } from '@digigov/ui/app/PageTitleContainer';
 import { useTranslation } from '@digigov/ui/i18n';
 import { BackLink } from '@digigov/ui/navigation/BackLink';
-import { Heading, HeadingProps } from '@digigov/ui/typography/Heading';
+import type { HeadingProps } from '@digigov/ui/typography/Heading';
+import { Heading } from '@digigov/ui/typography/Heading';
 import { HeadingCaption } from '@digigov/ui/typography/HeadingCaption';
 
 export interface StepTitleInterface {

package/src/Questions/Step/getAddMoreFields.tsx

@@ -1,5 +1,5 @@
-import { StepInterface } from '@digigov/form/Questions/Step/types';
-import { FieldSpec } from '@digigov/form/types';
+import type { StepInterface } from '@digigov/form/Questions/Step/types';
+import type { FieldSpec } from '@digigov/form/types';
 
 export const getAddMoreFields = (currentStep: StepInterface): FieldSpec[] => {
   return [

package/src/Questions/Step/types.tsx

@@ -1,4 +1,4 @@
-import { LabelProps } from '@digigov/form/inputs/Label';
+import type { LabelProps } from '@digigov/form/inputs/Label';
 
 export type StepType = 'object' | 'array';
 export type StepReviewAnswersType = 'positive' | 'negative';

package/src/Questions/__snapshots__/index.spec.tsx.snap

@@ -5,6 +5,7 @@ exports[`renders the Questions 1`] = `
   <div>
     <a
       class="ds-print-hidden ds-back-link"
+      href=""
       tabindex="0"
     >
       <svg
@@ -45,7 +46,7 @@ exports[`renders the Questions 1`] = `
       class="ds-form"
     >
       <div
-        class="ds-field xs:ds-grid__col-span-12"
+        class="ds-field ds-grid-item xs:ds-grid__col-span-12 sm:ds-grid__col-span-12 md:ds-grid__col-span-12 lg:ds-grid__col-span-12 xl:ds-grid__col-span-12"
       >
         <label
           class="ds-label"
@@ -64,6 +65,7 @@ exports[`renders the Questions 1`] = `
             aria-required="true"
             class="ds-input"
             data-type="string"
+            id="name"
             name="name"
             type="text"
           />

package/src/Questions/__stories__/Default.tsx

@@ -75,7 +75,7 @@ const steps = [
   },
 ];
 
-export function Default() {
+export function Default(_: any) {
   return (
     <BasicLayout>
       <Top>

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/getNextStep.tsx

@@ -1,4 +1,4 @@
-import { StepInterface } from '@digigov/form/Questions/Step/types';
+import type { StepInterface } from '@digigov/form/Questions/Step/types';
 
 export function getNextStep(
   currentStep: any,

package/src/Questions/index.spec.tsx

@@ -2,8 +2,12 @@ import * as React from 'react';
 import { render } from '@testing-library/react';
 
 import { Field } from '@digigov/form';
-import { Step, StepForm, StepQuote, StepTitle } from '@digigov/form/Questions';
-import Questions from '@digigov/form/Questions';
+import Questions, {
+  Step,
+  StepForm,
+  StepQuote,
+  StepTitle,
+} from '@digigov/form/Questions';
 
 const steps = [
   {
@@ -42,6 +46,14 @@ const steps = [
   },
 ];
 
+beforeAll(() => {
+  global.ResizeObserver = class ResizeObserver {
+    observe() {}
+    unobserve() {}
+    disconnect() {}
+  };
+});
+
 it('renders the Questions', () => {
   expect(
     render(

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/Questions/types.tsx

@@ -1,4 +1,4 @@
-import { StepInterface } from '@digigov/form/Questions/Step/types';
+import type { StepInterface } from '@digigov/form/Questions/Step/types';
 
 export interface QuestionsInterface {
   name: string;

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.