@digigov/form 2.0.0-0edebf87 → 2.0.0-2177f152

package/src/Questions/{index.mdx → doc.mdx}

@@ -14,14 +14,11 @@ import {
   TableDataCell,
 } from '@digigov/react-core';
 
-import LeadText from '@site/src/components/LeadText';
 
-<LeadText>
-  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
-  status. Use step questions to make bigger forms less scary and easier to fill
-  out.
-</LeadText>
+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
+status. Use step questions to make bigger forms less scary and easier to fill
+out.
 
 ## Introduction to Question pages
 
@@ -41,7 +38,7 @@ Even if users struggle through to the end of a form and answer honestly, if it
 more work than they expected, they’ll be annoyed about it. That's the exact
 opposite of our goals of making concise, easy-to-use services.
 
-```jsx live
+```jsx
 import React from 'react';
 import Questions, { Step, StepForm, StepTitle } from '@digigov/form/Questions';
 import { Field } from '@digigov/form';
@@ -87,11 +84,11 @@ const steps = [
     ],
   },
   {
-    name: 'bod',
+    name: 'dob',
     title: 'When is your birthday?',
     fields: [
       {
-        key: 'bod',
+        key: 'dob',
         label: {
           primary: 'Birthday',
         },
@@ -117,10 +114,10 @@ export default function Index() {
           <Field name="countries" />
         </StepForm>
       </Step>
-      <Step name="bod">
+      <Step name="dob">
         <StepTitle />
         <StepForm submitButton={true}>
-          <Field name="bod" />
+          <Field name="dob" />
         </StepForm>
       </Step>
     </Questions>
@@ -159,7 +156,7 @@ its subsequent subcomponents that you customise as needed, like the step title,
 description or form. You can also add components that are not form-specific,
 adding paragraphs or other custom components.
 
-```jsx
+```jsx pure
 <Questions name="example" steps={steps} onSubmit={(data) => doSomething(data)}>
   {/* more steps could be rendered here ... */}
   <Step name="age">
@@ -184,7 +181,7 @@ object. The most basic properties are the following:
 - `fields` - an array that describes each input field that will be rendered in
   the `StepForm`. Each fields implements the `FieldSpec` interface as a JSON object.
 
-```json title="step-name.json"
+```json pure title="step-name.json"
 {
   "name": "name",
   "title": "What is your name?",
@@ -209,7 +206,7 @@ basic branching between each step. The `nextStep` property will need to be a
 function that will take the form state as an argument and will return the key of
 the next `step`.
 
-```json title="next-step.json"
+```json pure title="next-step.json"
 const steps = [
   {
     name: 'age',
@@ -263,7 +260,7 @@ For example, you may use a form to determine if citizens are adults or not, and
 we want to ask users different questions according to their persona. We can use
 a branch between the `age` step and the other two steps.
 
-```jsx live
+```jsx
 import React from 'react';
 import GovGRFooter from '@digigov/ui/govgr/Footer';
 import Header from '@digigov/ui/app/Header';

package/src/Questions/index.spec.tsx

@@ -1,9 +1,13 @@
 import * as React from 'react';
-import { mount } from 'enzyme';
+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 = [
   {
@@ -44,7 +48,7 @@ const steps = [
 
 it('renders the Questions', () => {
   expect(
-    mount(
+    render(
       <Questions
         name={'example'}
         onSubmit={(data): void => {
@@ -67,6 +71,6 @@ it('renders the Questions', () => {
           </StepForm>
         </Step>
       </Questions>
-    )
+    ).baseElement
   ).toMatchSnapshot();
 });

package/src/Questions/index.test.tsx

@@ -0,0 +1,21 @@
+import React from 'react';
+import { test, expect } from '@playwright/experimental-ct-react';
+import { Default } from '@digigov/form/Questions/__stories__/Default';
+import TestVariant from '@digigov/ui/utils/TestVariant';
+
+test('renders the All Questions variants', async ({ mount, page }) => {
+  await mount(
+    <div>
+      <TestVariant title="Default">
+        <Default />
+      </TestVariant>
+    </div>
+  );
+  await page.evaluate(() => document.fonts.ready);
+
+  const screenshot = await page.screenshot({
+    fullPage: true,
+    animations: 'disabled',
+  });
+  expect(screenshot).toMatchSnapshot();
+});

package/src/Questions/types.tsx

@@ -13,6 +13,7 @@ export interface QuestionsInterface {
   initialData?: any;
   localDraft?: boolean;
   errorLabels?: Record<string, string>;
+  children?: React.ReactNode;
 }
 
 export interface QuestionsContextInterface {

package/src/create-simple-form.mdx

@@ -4,12 +4,8 @@ title: Create a simple Digigov Form
 sidebar_label: Creating simple forms
 ---
 
-import LeadText from '@site/src/components/LeadText';
-
-<LeadText>
-  This guide walks through building a simple form page, complete with validation
-  and data serialisation.
-</LeadText>
+This guide walks through building a simple form page, complete with validation
+and data serialisation.
 
 ## What we are building
 

package/src/{index.mdx → doc.mdx}

@@ -4,14 +4,10 @@ title: Digigov Form
 sidebar_label: Introduction to Digigov Form
 ---
 
-import LeadText from '@site/src/components/LeadText';
-
-<LeadText>
-  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.
-</LeadText>
+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"

package/src/index.ts

@@ -1,3 +1,6 @@
-export * from '@digigov/form/internal';
+export { default as Field } from '@digigov/form/Field';
+export { default as Fieldset } from '@digigov/form/Fieldset';
+export * from '@digigov/form/inputs/Label';
 import FormBuilder from '@digigov/form/FormBuilder';
+export * from '@digigov/form/types';
 export default FormBuilder;

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

@@ -4,5 +4,5 @@ export default {
   component: AutoComplete,
   displayName: 'AutoCompleteInput',
 };
-export * from '@digigov/form/inputs/AutoCompleteInput/__stories__/Default';
-export * from '@digigov/form/inputs/AutoCompleteInput/__stories__/Multiple';
+export { Default } from '@digigov/form/inputs/AutoCompleteInput/__stories__/Default';
+export { Multiple } from '@digigov/form/inputs/AutoCompleteInput/__stories__/Multiple';

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

@@ -4,13 +4,7 @@ import FormBuilder from '@digigov/form/FormBuilder';
 import { FieldSpec } from '@digigov/form/types';
 import Button from '@digigov/ui/form/Button';
 
-const results = [
-  'Αμερική',
-  'Ασία',
-  'Αυστραλία',
-  'Αφρική',
-  'Ευρώπη',
-];
+const results = ['Αμερική', 'Ασία', 'Αυστραλία', 'Αφρική', 'Ευρώπη'];
 
 const fields: FieldSpec[] = [
   {
@@ -36,7 +30,6 @@ const fields: FieldSpec[] = [
 const initialValues = {};
 
 export const Default = () => (
-
   <FormBuilder
     fields={fields}
     onSubmit={(data) => {
@@ -49,6 +42,5 @@ export const Default = () => (
     ))}
     <Button type="submit">Submit</Button>
   </FormBuilder>
-
 );
-export default Default;
+export default Default;

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

@@ -4,13 +4,7 @@ import FormBuilder from '@digigov/form/FormBuilder';
 import { FieldSpec } from '@digigov/form/types';
 import Button from '@digigov/ui/form/Button';
 
-const results = [
-  'Αμερική',
-  'Ασία',
-  'Αυστραλία',
-  'Αφρική',
-  'Ευρώπη',
-];
+const results = ['Αμερική', 'Ασία', 'Αυστραλία', 'Αφρική', 'Ευρώπη'];
 
 const fields: FieldSpec[] = [
   {
@@ -20,7 +14,6 @@ const fields: FieldSpec[] = [
     type: 'choice:multiple',
     extra: {
       component: 'AutoComplete',
-      multiple: true,
       options: results.map((r) => {
         return {
           label: {

package/{cjs/inputs/AutoCompleteInput/index.mdx → src/inputs/AutoCompleteInput/doc.mdx}

@@ -11,19 +11,8 @@ options as the users type and also let them select an option from the list.
 
 ### Default
 
-<Story
-  packageName="@digigov/form"
-  component="inputs/AutoCompleteInput"
-  story="Default.tsx"
-/>
+<code src="@digigov/form/inputs/AutoCompleteInput/__stories__/Default.tsx" />
 
 ### Display multiple values
 
-<Story
-  packageName="@digigov/form"
-  component="inputs/AutoCompleteInput"
-  story="Multiple.tsx"
-/>
-
-
-
+<code src="@digigov/form/inputs/AutoCompleteInput/__stories__/Multiple.tsx" />

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

@@ -0,0 +1,25 @@
+import React from 'react';
+import { test, expect } from '@playwright/experimental-ct-react';
+import { Default } from '@digigov/form/inputs/AutoCompleteInput/__stories__/Default';
+import { Multiple } from '@digigov/form/inputs/AutoCompleteInput/__stories__/Multiple';
+import TestVariant from '@digigov/ui/utils/TestVariant';
+
+test('renders the All AutoCompleteInput variants', async ({ mount, page }) => {
+  await mount(
+    <div>
+      <TestVariant title="Default">
+        <Default />
+      </TestVariant>
+      <TestVariant title="Multiple">
+        <Multiple />
+      </TestVariant>
+    </div>
+  );
+  await page.evaluate(() => document.fonts.ready);
+
+  const screenshot = await page.screenshot({
+    fullPage: true,
+    animations: 'disabled',
+  });
+  expect(screenshot).toMatchSnapshot();
+});

package/src/inputs/AutoCompleteInput/index.tsx

@@ -1,11 +1,12 @@
 import React, { useCallback } from 'react';
 import { ControlledFieldProps } from '@digigov/form/Field/types';
 import { FieldOptionProps } from '@digigov/form/inputs/Label';
-import { Hint } from '@digigov/react-core/Hint';
-import UIAutoComplete, {
+import {
+  AutoComplete,
   AutoCompleteProps as UIAutoCompleteProps,
 } from '@digigov/ui/form/AutoComplete';
-
+import { Hint } from '@digigov/ui/typography/Hint';
+import { Base } from '@digigov/ui/utils/Base';
 export interface AutoCompleteInputExtra
   extends Omit<
     UIAutoCompleteProps,
@@ -16,7 +17,7 @@ export interface AutoCompleteInputExtra
     | 'onConfirm'
     | 'dropdownArrow'
   > {
-  options: Array<FieldOptionProps>;
+  options: FieldOptionProps[];
 }
 
 export interface AutoCompleteInputProps
@@ -28,39 +29,43 @@ export interface AutoCompleteInputProps
 
 export const AutoCompleteInput: React.FC<AutoCompleteInputProps> = ({
   name,
-  extra: { options, multiple },
+  type,
+  extra: { options },
   onChange,
   value,
-  error,
   ...props
 }) => {
-  const suggest = useCallback(function suggest(
-    query: string,
-    syncResults: (options: any[]) => void
-  ): void {
-    syncResults(
-      query
-        ? options.filter(function (option) {
-          return (
-            `${option.value} ${option.label?.primary || ''} ${option.label?.secondary || ''
-              }`
-              .toLowerCase()
-              .indexOf(query.toLowerCase()) !== -1
-          );
-        })
-        : options
-    );
-  },
-    [options]);
+  const suggest = useCallback(
+    function suggest(
+      query: string,
+      syncResults: (options: any[]) => void
+    ): void {
+      syncResults(
+        query
+          ? options.filter(function (option) {
+              return (
+                `${option.value} ${option.label?.primary || ''} ${
+                  option.label?.secondary || ''
+                }`
+                  .toLowerCase()
+                  .indexOf(query.toLowerCase()) !== -1
+              );
+            })
+          : options
+      );
+    },
+    [options]
+  );
 
   return (
-    <UIAutoComplete
-      multiple={multiple}
+    <AutoComplete
+      multiple={type === 'choice:multiple' ? true : false}
       source={suggest}
       onConfirm={(value) => {
         if (Array.isArray(value)) {
-          const selectedValues = value.map(item => item.value);
-          selectedValues.length > 0 ? onChange(selectedValues) : onChange(undefined);
+          const selectedValues = value.map((item) => item.value);
+          if (selectedValues.length > 0) onChange(selectedValues);
+          else onChange(undefined);
         } else {
           onChange(value.value);
         }
@@ -68,10 +73,10 @@ export const AutoCompleteInput: React.FC<AutoCompleteInputProps> = ({
       templates={{
         suggestion({ label, value }) {
           return (
-            <div>
+            <Base as="div">
               {(label && label.primary && label.primary) || value}
               {label && label.secondary && <Hint>{label.secondary}</Hint>}
-            </div>
+            </Base>
           );
         },
         inputValue: (option) => {
@@ -86,10 +91,11 @@ export const AutoCompleteInput: React.FC<AutoCompleteInputProps> = ({
         reset: undefined,
         required: undefined,
       }}
+      name={name}
       id={`${name}-id`}
       defaultValue={value}
     />
   );
 };
 
-export default AutoCompleteInput;
+export default AutoCompleteInput;

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

@@ -4,6 +4,6 @@ export default {
   component: Checkboxes,
   displayName: 'Checkboxes',
 };
-export * from '@digigov/form/inputs/Checkboxes/__stories__/Default';
-export * from '@digigov/form/inputs/Checkboxes/__stories__/WithDivider';
-export * from '@digigov/form/inputs/Checkboxes/__stories__/Conditional';
+export { Default } from '@digigov/form/inputs/Checkboxes/__stories__/Default';
+export { WithDivider } from '@digigov/form/inputs/Checkboxes/__stories__/WithDivider';
+export { Conditional } from '@digigov/form/inputs/Checkboxes/__stories__/Conditional';

package/src/inputs/Checkboxes/{index.mdx → doc.mdx}

@@ -10,24 +10,14 @@ Checkboxes are used to let a user select one or more options of a limited number
 
 ### Default
 
-<Story
-  packageName="@digigov/form"
-  component="inputs/Checkboxes"
-  story="Default.tsx"
-/>
+<code src="@digigov/form/inputs/Checkboxes/__stories__/Default.tsx" />
+
 
 ### Conditional
 
-<Story
-  packageName="@digigov/form"
-  component="inputs/Checkboxes"
-  story="Conditional.tsx"
-/>
+<code src="@digigov/form/inputs/Checkboxes/__stories__/Conditional.tsx" />
+
 
 ### With divider
 
-<Story
-  packageName="@digigov/form"
-  component="inputs/Checkboxes"
-  story="WithDivider.tsx"
-/>
+<code src="@digigov/form/inputs/Checkboxes/__stories__/WithDivider.tsx" />

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

@@ -0,0 +1,29 @@
+import React from 'react';
+import { test, expect } from '@playwright/experimental-ct-react';
+import { Conditional } from '@digigov/form/inputs/Checkboxes/__stories__/Conditional';
+import { Default } from '@digigov/form/inputs/Checkboxes/__stories__/Default';
+import { WithDivider } from '@digigov/form/inputs/Checkboxes/__stories__/WithDivider';
+import TestVariant from '@digigov/ui/utils/TestVariant';
+
+test('renders the All Checkboxes variants', async ({ mount, page }) => {
+  await mount(
+    <div>
+      <TestVariant title="Conditional">
+        <Conditional />
+      </TestVariant>
+      <TestVariant title="Default">
+        <Default />
+      </TestVariant>
+      <TestVariant title="WithDivider">
+        <WithDivider />
+      </TestVariant>
+    </div>
+  );
+  await page.evaluate(() => document.fonts.ready);
+
+  const screenshot = await page.screenshot({
+    fullPage: true,
+    animations: 'disabled',
+  });
+  expect(screenshot).toMatchSnapshot();
+});

package/src/inputs/Checkboxes/index.tsx

@@ -1,20 +1,22 @@
 import React, { useState } from 'react';
-import { Field } from '@digigov/form';
 import { ControlledFieldProps } from '@digigov/form/Field/types';
 import { FieldOptionProps } from '@digigov/form/inputs/Label';
-import { CheckboxConditional } from '@digigov/react-core/CheckboxConditional';
-import CoreCheckboxes from '@digigov/react-core/Checkbox';
-import CheckboxItem from '@digigov/react-core/CheckboxItem';
-import Hint from '@digigov/react-core/Hint';
+import {
+  Checkbox,
+  CheckboxItem,
+  CheckboxConditional,
+} from '@digigov/ui/form/Checkbox';
 import { useTranslation } from '@digigov/ui/i18n';
+import { Hint } from '@digigov/ui/typography/Hint';
 
 export interface CheckboxesProps
   extends Omit<ControlledFieldProps, 'extra' | 'value'> {
   value?: string[];
   extra: {
     className?: string;
-    options: Array<FieldOptionProps>;
+    options: FieldOptionProps[];
   };
+  fieldComponent: React.FC<Omit<ControlledFieldProps, 'value' | 'onChange'>>;
 }
 
 export const Checkboxes: React.FC<CheckboxesProps> = ({
@@ -23,37 +25,40 @@ export const Checkboxes: React.FC<CheckboxesProps> = ({
   value,
   extra: { options, className },
   disabled,
+  Field,
   ...props
 }) => {
   if (!value) value = [];
-  const handleChange = (optionValue, idx, show) => (evt): void => {
-    let newValue;
-    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) {
-      setChecked((items) =>
-        items.map((item, index) => (index === idx ? !item : item))
-      );
-    }
+  const handleChange =
+    (optionValue, idx, show) =>
+    (evt): void => {
+      let newValue;
+      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) {
+        setChecked((items) =>
+          items.map((item, index) => (index === idx ? !item : item))
+        );
+      }
 
-    // reset value to undefined instead of an empty array
-    // so the error state mechanism can throw validation errors
-    if (newValue.length === 0) newValue = undefined;
-    onChange(newValue);
-  };
+      // reset value to undefined instead of an empty array
+      // so the error state mechanism can throw validation errors
+      if (newValue.length === 0) newValue = undefined;
+      onChange(newValue);
+    };
   const { t } = useTranslation();
   const [checked, setChecked] = useState(
     Array<boolean>(options.length).fill(false)
   );
   return (
-    <CoreCheckboxes className={className}>
+    <Checkbox className={className}>
       {options.map(
         (
           {
@@ -69,7 +74,7 @@ export const Checkboxes: React.FC<CheckboxesProps> = ({
           <React.Fragment key={index}>
             <CheckboxItem
               key={`${name}.${index}`}
-              name={name}
+              name={`${name}.${v}`}
               value={v}
               disabled={disabled || optionDisabled}
               checked={value?.includes(v)}
@@ -89,7 +94,7 @@ export const Checkboxes: React.FC<CheckboxesProps> = ({
               {label && label.secondary && <Hint>{t(label.secondary)}</Hint>}
             </CheckboxItem>
 
-            {!!checked[index] && show && (
+            {!!checked[index] && show && Field && (
               <CheckboxConditional>
                 {show.map((fieldName) => (
                   <Field name={fieldName} key={fieldName} />
@@ -100,7 +105,7 @@ export const Checkboxes: React.FC<CheckboxesProps> = ({
           </React.Fragment>
         )
       )}
-    </CoreCheckboxes>
+    </Checkbox>
   );
 };
 

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

@@ -4,4 +4,4 @@ export default {
   component: DateInput,
   displayName: 'DateInput',
 };
-export * from '@digigov/form/inputs/DateInput/__stories__/Default';
+export { Default } from '@digigov/form/inputs/DateInput/__stories__/Default';