Feature ever 14024 rover UI form component alfa

example/src/App.js

@@ -27,6 +27,7 @@ import {
   InputTime,
   Typography,
   Modal,
+  Form,
   // IMPORT_INJECTOR
 } from '@cision/rover-ui';
 
@@ -424,6 +425,10 @@ const App = () => {
         </Typography>
       </Section>
 
+      <Section title="Form">
+        <Form />
+      </Section>
+
       <Section title="Modal">
         <div>
           <Button modifiers={['primary']} onClick={() => setIsModalOpen(true)}>

rover-ui-wendigolabs.iml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

src/components/Form/Form.test.tsx

@@ -0,0 +1,218 @@
+import React from 'react';
+import { render, fireEvent, act } from '@testing-library/react';
+
+import Form from './index';
+import { FormProps, FormContext } from './Form';
+
+const defaultProps = {
+  className: 'some_classname',
+  initialValues: {
+    textInput: '',
+    radioInput: false,
+    checkboxInput: false,
+  },
+  validationSchema: {},
+  onSubmit: jest.fn(),
+};
+
+interface DefaultPropsType extends FormProps {
+  onCustom?: {
+    fieldName: string;
+    callback: () => string;
+  };
+}
+
+const renderForm = (props: DefaultPropsType = defaultProps) =>
+  render(
+    <Form {...defaultProps} {...props}>
+      <FormContext.Consumer>
+        {(context) => {
+          const {
+            formState,
+            values,
+            handleChange,
+            handleBlur,
+            handleCustom,
+          } = context as FormContext;
+          return (
+            <>
+              <pre data-testid="form-data">
+                {JSON.stringify({ values, formState })}
+              </pre>
+              {formState?.submitError && (
+                <div>{formState.submitError.message}</div>
+              )}
+              <input
+                data-testid="text-input"
+                type="text"
+                name="textInput"
+                value={values.textInput as string}
+                onChange={handleChange}
+                onBlur={handleBlur}
+              />
+              <input
+                data-testid="radio-input"
+                type="radio"
+                name="radioInput"
+                onChange={handleChange}
+                checked={values.radioInput as boolean}
+              />
+              <input
+                data-testid="checkbox-input"
+                type="checkbox"
+                name="checkboxInput"
+                onChange={handleChange}
+                checked={values.checkboxInput as boolean}
+              />
+              {props.onCustom && (
+                <button
+                  type="submit"
+                  data-testid="custom-button"
+                  onClick={
+                    handleCustom(
+                      props.onCustom.fieldName,
+                      props.onCustom.callback
+                    ) as any
+                  }
+                >
+                  Evolve it!
+                </button>
+              )}
+              <button data-testid="submit-button" type="submit">
+                Submit
+              </button>
+            </>
+          );
+        }}
+      </FormContext.Consumer>
+    </Form>
+  );
+
+describe('<Form />', () => {
+  it.skip('handles inputs', () => {
+    const { getByTestId } = renderForm();
+    const someText = { target: { value: 'some text' } };
+    const textInput = getByTestId('text-input') as HTMLInputElement;
+    const radioInput = getByTestId('radio-input') as HTMLInputElement;
+    const checkboxInput = getByTestId('checkbox-input') as HTMLInputElement;
+
+    fireEvent.change(textInput, someText);
+    fireEvent.click(radioInput);
+    fireEvent.click(checkboxInput);
+
+    const { values } = JSON.parse(getByTestId('form-data').innerHTML);
+
+    expect(textInput.value).toEqual(someText.target.value);
+    expect(values.textInput).toEqual(someText.target.value);
+
+    expect(radioInput.checked).toEqual(true);
+    expect(values.radioInput).toEqual('on'); // this is odd
+
+    expect(checkboxInput.checked).toEqual(true);
+    expect(values.checkboxInput).toEqual(true);
+  });
+
+  it.skip('handles blur events', () => {
+    const { getByTestId } = renderForm();
+    const textInput = getByTestId('text-input');
+
+    fireEvent.blur(textInput);
+
+    const { formState } = JSON.parse(getByTestId('form-data').innerHTML);
+
+    expect(formState?.touched.textInput).toEqual(true);
+  });
+
+  it.skip('handles custom events', () => {
+    const { getByTestId } = renderForm({
+      onCustom: {
+        fieldName: 'textInput',
+        callback: () => 'raichu',
+      },
+    });
+
+    const someText = { target: { value: 'pikachu' } };
+    const textInput = getByTestId('text-input') as HTMLInputElement;
+    fireEvent.change(textInput, someText);
+
+    const customBtn = getByTestId('custom-button');
+    fireEvent.click(customBtn);
+
+    const { values } = JSON.parse(getByTestId('form-data').innerHTML);
+
+    expect(textInput.value).toEqual('raichu');
+    expect(values.textInput).toEqual('raichu');
+  });
+
+  it.skip('validates inputs', async () => {
+    const { getByTestId } = renderForm({
+      validationSchema: {
+        textInput: {
+          nonBidoof: {
+            message: 'anything but bidoof',
+            validator: (value) => value !== 'bidoof',
+          },
+        },
+      },
+    });
+    const textInput = getByTestId('text-input');
+
+    fireEvent.change(textInput, { target: { value: 'bidoof' } });
+
+    const { formState } = JSON.parse(getByTestId('form-data').innerHTML);
+
+    expect(formState?.validationErrors.textInput).toEqual(
+      'anything but bidoof'
+    );
+  });
+
+  it.skip('handles successful submit with all form values', async () => {
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    const { getByTestId } = renderForm({ onSubmit });
+    const submitBtn = getByTestId('submit-button');
+    const formData = getByTestId('form-data');
+
+    // assert isSubmitting false
+    const { formState: initialFormState } = JSON.parse(formData.innerHTML);
+    expect(initialFormState.isSubmitting).toEqual(false);
+
+    await act(async () => {
+      fireEvent.click(submitBtn);
+    });
+
+    // assert isSubmitting false when done
+    const { formState: finalFormState } = JSON.parse(formData.innerHTML);
+    expect(finalFormState.isSubmitting).toEqual(false);
+
+    // using hoisting to get access to getByTestId and onSubmit
+    async function onSubmit(values) {
+      // assert isSubmitting true while running
+      const { formState: intermediateFormState } = JSON.parse(
+        formData.innerHTML
+      );
+      expect(values).toEqual(defaultProps.initialValues);
+      await Promise.resolve(() =>
+        expect(intermediateFormState.isSubmitting).toEqual(true)
+      );
+    }
+  });
+
+  it.skip('handles errors in onSubmit prop', async () => {
+    const { getByTestId, queryByText } = renderForm({
+      onSubmit: () => {
+        throw new Error('Error in user defined onSubmit prop');
+      },
+    });
+    const submitBtn = getByTestId('submit-button');
+    const formData = getByTestId('form-data');
+
+    const { formState: initialFormState } = JSON.parse(formData.innerHTML);
+    expect(initialFormState.submitError).toEqual(null);
+
+    await act(async () => {
+      fireEvent.click(submitBtn);
+    });
+
+    expect(queryByText('Error in user defined onSubmit prop')).toBeTruthy();
+  });
+});