envoc-form 4.0.1-10 → 4.0.1-12

package/lib/SubmitFormButton.d.ts

@@ -1,7 +1,10 @@
 import React from 'react';
 export interface SubmitFormButtonProps extends Omit<React.HTMLProps<HTMLButtonElement>, 'type'> {
+    /** Allow the form to be submitted without any changes. By default this is not allowed. */
     allowPristineSubmit?: boolean;
+    /** Text to display on the button. Default text is 'Submit'. */
     children?: React.ReactNode;
 }
-declare const _default: React.ComponentType<SubmitFormButtonProps>;
+declare const _default: React.FunctionComponent<SubmitFormButtonProps>;
+/** Generic submit button for forms. */
 export default _default;

package/lib/SubmitFormButton.js

@@ -41,4 +41,5 @@ function SubmitFormButton(_a, ref) {
                 ? "You haven't made any changes"
                 : '', className: (0, classnames_1.default)(FormDefaults_1.FormDefaults.cssClassPrefix + 'submit-form-button', className) }, { children: children || 'Submit' })));
 }
+/** Generic submit button for forms. */
 exports.default = react_1.default.forwardRef(SubmitFormButton);

package/lib/TextArea/TextAreaGroup.d.ts

@@ -1,8 +1,9 @@
 import React from 'react';
 import { InjectedFieldProps } from '../Field/InjectedFieldProps';
 import { GroupProps } from '../Group';
-export interface TextAreaGroupProps extends InjectedFieldProps<string | undefined>, Omit<React.HTMLProps<HTMLTextAreaElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'> {
+export interface TextAreaGroupProps extends InjectedFieldProps<string | undefined | null>, Omit<React.HTMLProps<HTMLTextAreaElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'> {
     icon?: React.ReactNode;
 }
+/** Generic controlled `<textarea/>` wrapped by a `<Group/>` */
 declare const TextAreaGroupWithRef: React.ComponentType<TextAreaGroupProps>;
 export default TextAreaGroupWithRef;

package/lib/TextArea/TextAreaGroup.js

@@ -28,12 +28,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = __importDefault(require("react"));
 var classnames_1 = __importDefault(require("classnames"));
-var Group_1 = __importDefault(require("../Group"));
 var FormDefaults_1 = require("../FormDefaults");
-/** generic controlled <textarea/> wrapped by a Group */
+var Group_1 = __importDefault(require("../Group"));
 function TextAreaGroup(_a, ref) {
+    var _b;
     var input = _a.input, meta = _a.meta, label = _a.label, helpText = _a.helpText, className = _a.className, required = _a.required, disabled = _a.disabled, icon = _a.icon, rest = __rest(_a, ["input", "meta", "label", "helpText", "className", "required", "disabled", "icon"]);
-    return ((0, jsx_runtime_1.jsxs)(Group_1.default, __assign({ input: input, meta: meta, required: required, disabled: disabled, label: label, helpText: helpText, className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'text-area-group') }, { children: [icon, (0, jsx_runtime_1.jsx)("textarea", __assign({}, input, rest, { value: input.value, onChange: function (val) { return input.onChange(val.target.value); }, ref: ref, className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'text-area-group') }))] })));
+    return ((0, jsx_runtime_1.jsxs)(Group_1.default, __assign({ input: input, meta: meta, required: required, disabled: disabled, label: label, helpText: helpText, className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'text-area-group') }, { children: [icon, (0, jsx_runtime_1.jsx)("textarea", __assign({}, input, rest, { value: (_b = input.value) !== null && _b !== void 0 ? _b : '', onChange: function (val) { return input.onChange(val.target.value); }, ref: ref, className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'text-area-group') }))] })));
 }
+/** Generic controlled `<textarea/>` wrapped by a `<Group/>` */
 var TextAreaGroupWithRef = react_1.default.forwardRef(TextAreaGroup);
 exports.default = TextAreaGroupWithRef;

package/lib/Validation/validators.d.ts

@@ -1,15 +1,18 @@
 import { ValidationFunction } from './ValidationFunction';
 export declare const required: (value: any) => "Required" | undefined;
-export declare const length: (len: number) => (value: string | number | undefined) => string | undefined;
-export declare const integer: (val: string | number | undefined) => "Must be a whole number" | undefined;
-export declare const maxLength: (len: number) => (value: string | number | undefined) => string | undefined;
+/** Asserts that the value is a certain number of characters. numbers are coerced to a string */
+export declare const length: (len: number) => (value: string | number | undefined | null) => string | undefined;
+export declare const integer: (val: string | number | undefined | null) => "Must be a whole number" | undefined;
+export declare const maxLength: (len: number) => (value: string | number | undefined | null) => string | undefined;
 export declare const maxCount: (count: number) => (value: {
     isDeleted?: boolean;
-}[] | undefined) => string | undefined;
+}[] | undefined | null) => string | undefined;
 export declare const minCount: (count: number) => (value: {
     isDeleted?: boolean;
-}[] | undefined) => string | undefined;
-export declare const maxValue: (max: number) => (value: number | undefined) => string | undefined;
-export declare const minValue: (min: number) => (value: number | undefined) => string | undefined;
-export declare const zipCode: (value: string | undefined) => "Invalid ZIP Code" | undefined;
+}[] | undefined | null) => string | undefined;
+export declare const maxValue: (max: number) => (value: number | undefined | null) => string | undefined;
+export declare const minValue: (min: number) => (value: number | undefined | null) => string | undefined;
+/** Validate for a ZIP Code. Accepts formats: ##### and #####-#### */
+export declare const zipCode: (value: string | undefined | null) => "Invalid ZIP Code" | undefined;
+/** One of the validators provided must be true. */
 export declare const any: <TValue>(validatorList: ValidationFunction<TValue>[]) => (value: TValue) => string | undefined;

package/lib/Validation/validators.js

@@ -11,7 +11,7 @@ var required = function (value) {
             : 'Required';
 };
 exports.required = required;
-//asserts that the value is a certain number of characters. numbers are coerced to a string
+/** Asserts that the value is a certain number of characters. numbers are coerced to a string */
 var length = function (len) { return function (value) {
     var hasError = getLengthOfValue(value) !== len;
     return !hasError ? undefined : "Length must be ".concat(len);
@@ -51,13 +51,14 @@ var minValue = function (min) { return function (value) {
     return !hasError ? undefined : "Minimum value ".concat(min, " not met");
 }; };
 exports.minValue = minValue;
+/** Validate for a ZIP Code. Accepts formats: ##### and #####-#### */
 var zipCode = function (value) {
     return value && !/^[0-9]{5}(?:-[0-9]{4})?$/.test(value)
         ? 'Invalid ZIP Code'
         : undefined;
 };
 exports.zipCode = zipCode;
-//one of the validators provided must be true
+/** One of the validators provided must be true. */
 var any = function (validatorList) {
     return function (value) {
         if (validatorList.length === 0 || !value) {
@@ -68,6 +69,9 @@ var any = function (validatorList) {
 };
 exports.any = any;
 function getLengthOfValue(value) {
+    if (value === null) {
+        return 0;
+    }
     switch (typeof value) {
         case 'undefined':
             return 0;

package/lib/index.d.ts

@@ -7,7 +7,7 @@ export type { ConfirmBaseFormProps } from './ConfirmBaseForm/ConfirmBaseForm';
 export { default as ConfirmDeleteForm } from './ConfirmDeleteForm/ConfirmDeleteForm';
 export type { ConfirmDeleteFormProps } from './ConfirmDeleteForm/ConfirmDeleteForm';
 export { default as DatePickerGroup } from './DatePicker/DatePickerGroup';
-export type { DatePickerGroupProps as DatePickerGroupProps } from './DatePicker/DatePickerGroup';
+export type { DatePickerGroupProps } from './DatePicker/DatePickerGroup';
 export { convertToTimeZoneInsensitiveISOString } from './DatePicker/DatePickerGroup';
 export type { DatePickerHelper } from './DatePicker/DatePickerHelper';
 export { default as StringDatePickerGroup } from './DatePicker/StringDatePickerGroup';
@@ -34,12 +34,12 @@ export type { FormBuilderProp, FormProps } from './Form/Form';
 export { ServerErrorContext } from './Form/ServerErrorContext';
 export type { ServerErrorContextProps, ServerErrors, } from './Form/ServerErrorContext';
 export { default as FormActions } from './FormActions';
-export type { FormActionsProps as FormActionsProps } from './FormActions';
+export type { FormActionsProps } from './FormActions';
 export { default as StandardFormActions } from './StandardFormActions';
-export type { StandardFormActionsProps as StandardFormActionsProps } from './StandardFormActions';
+export type { StandardFormActionsProps } from './StandardFormActions';
 export { FormDefaults } from './FormDefaults';
 export { default as Group } from './Group';
-export type { GroupProps as GroupProps } from './Group';
+export type { GroupProps } from './Group';
 export { default as IconInputGroup } from './Input/IconInputGroup';
 export type { IconInputGroupProps } from './Input/IconInputGroup';
 export { default as InputGroup } from './Input/InputGroup';

package/lib/setupTests.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';

package/lib/setupTests.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("@testing-library/jest-dom/extend-expect");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "envoc-form",
-  "version": "4.0.1-10",
+  "version": "4.0.1-12",
   "description": "Envoc form components",
   "keywords": [
     "react-component",
@@ -23,11 +23,12 @@
     "es"
   ],
   "scripts": {
-    "build": "yarn verify-imports && yarn build:esm && yarn build:cjs && yarn build:css",
+    "build": "yarn verify-imports && yarn build:esm && yarn build:cjs && yarn build:css && yarn build:docs",
     "rebuild": "rimraf ./{dist,es,lib} && yarn build",
     "build:esm": "cross-env BABEL_ENV=esm-dir tsc -p tsconfig.esm.json",
     "build:css": "sass src/styles.scss dist/css/envoc-form-styles.css",
     "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:docs": "yarn rimraf README.md && yarn typedoc --options typedoc.json src/index.ts && npx concat-md --decrease-title-levels --dir-name-as-title docs > README.md && cls && yarn rimraf docs",
     "verify-imports": "node ../../scripts/check-for-scss-imports.js envoc-form",
     "start": "webpack serve --config ./webpack.demo.config.js",
     "test": "cross-env SKIP_PREFLIGHT_CHECK=true react-scripts test --watchAll=false",
@@ -37,12 +38,12 @@
     "axios": "^0.21.1",
     "classnames": "^2.3.1",
     "date-fns": "^2.22.1",
-    "envoc-request": "^4.0.1-10",
+    "envoc-request": "^4.0.1-12",
     "lru-cache": "^6.0.0",
     "prop-types": "^15.7.2",
     "react-date-picker": "^8.2.0",
     "react-dropzone": "^11.3.4",
-    "react-router": "^6.2.1",
+    "react-router": "^6.14.1",
     "react-select": "^5.2.2",
     "react-textarea-autosize": "^8.3.3",
     "react-toastify": "^7.0.4",
@@ -65,6 +66,7 @@
     "@testing-library/user-event": "^12.7.1",
     "@types/jest": "^26.0.24",
     "@types/react": "^16.9.56",
+    "@types/testing-library__jest-dom": "5.14.5",
     "@types/smoothscroll-polyfill": "^0.3.1",
     "@types/uuid": "^8.3.2",
     "babel-loader": "^8.2.2",
@@ -79,7 +81,7 @@
     "jest-junit": "~12.2.0",
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
-    "react-router-dom": "^6.2.1",
+    "react-router-dom": "^6.14.1",
     "react-scripts": "^4.0.3",
     "rimraf": "~3.0.2",
     "sass": "^1.35.2",
@@ -91,7 +93,8 @@
     "ts-loader": "^9.2.8",
     "typescript": "^4.6.3",
     "typedoc-plugin-markdown": "~3.10.3",
-    "typedoc": "~0.21.4"
+    "typedoc": "~0.21.4",
+    "concat-md": "~0.3.5"
   },
   "peerDependencies": {
     "@babel/runtime": "^7.14.6",

package/src/AddressInput/AddressInput.tsx

@@ -16,13 +16,23 @@ export interface AddressInputProps {
 }
 
 interface AddressDto {
-  address1?: string;
-  address2?: string;
-  zipCode?: string;
-  city?: string;
-  state?: string;
+  address1?: string | null;
+  address2?: string | null;
+  zipCode?: string | null;
+  city?: string | null;
+  state?: string | null;
 }
 
+/**
+ * Collection of `<Field/>`s for inputting an address. Includes:
+ * ```txt
+ * Address 1
+ * Address 2
+ * City
+ * State
+ * Zip
+ * ```
+ */
 export default function AddressInput({
   fieldBuilder: { Field },
   name,

package/src/AddressInput/__snapshots__/AddressInput.test.tsx.snap

@@ -19,6 +19,7 @@ exports[`AddressInput has matching snapshot 1`] = `
         Address 1
       </label>
       <input
+        aria-invalid="false"
         class="envoc-form-string-group envoc-form-input-group"
         id="normalAddressInput.address1"
         name="normalAddressInput.address1"
@@ -39,6 +40,7 @@ exports[`AddressInput has matching snapshot 1`] = `
         Address 2
       </label>
       <input
+        aria-invalid="false"
         class="envoc-form-string-group envoc-form-input-group"
         id="normalAddressInput.address2"
         name="normalAddressInput.address2"
@@ -59,6 +61,7 @@ exports[`AddressInput has matching snapshot 1`] = `
         City
       </label>
       <input
+        aria-invalid="false"
         class="envoc-form-string-group envoc-form-input-group"
         id="normalAddressInput.city"
         name="normalAddressInput.city"
@@ -168,6 +171,7 @@ exports[`AddressInput has matching snapshot 1`] = `
         Zip
       </label>
       <input
+        aria-invalid="false"
         class="envoc-form-string-group envoc-form-input-group"
         id="normalAddressInput.zipCode"
         name="normalAddressInput.zipCode"

package/src/ConfirmBaseForm/ConfirmBaseForm.tsx

@@ -6,16 +6,30 @@ import { FormDefaults } from '../FormDefaults';
 // TODO: change the style prop type to Tailwind type (does this exist before Tailwind 3.1 ???), or
 // should this just be type 'string'
 export interface ConfirmBaseFormProps {
+  /** Function to run when cancel button is clicked. */
   handleCancel?: MouseEventHandler<HTMLButtonElement>;
+  /** Axios request upon confirmation */
   request: useAxiosRequestProps;
   style?: React.CSSProperties;
+  /** `<h3/>` title text on top of the form. */
   title?: string;
+  /** Custom confirm button text.
+   * @defaultValue `Confirm`
+   */
   confirmButtonText?: string;
+  /** CSS class for the buttons. */
   confirmButtonClass?: string;
+  /** Any components to be rendered in between the title and the buttons. */
   children?: React.ReactNode;
 }
 
 // TODO: ask about how we should use 'children'
+/**
+ * Confimation dialog. Navigates to a different route to allow the user to either confirm or cancel an action.
+ * Commonly used for confirming delete and archive.
+ *
+ * See `<ConfirmDeleteForm/>` if the confirmation is specifically for deletion.
+ */
 export default function ConfirmBaseForm({
   handleCancel,
   request,

package/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx

@@ -9,14 +9,27 @@ import { FormDefaults } from '../FormDefaults';
 
 export interface ConfirmDeleteFormProps
   extends Pick<ConfirmBaseFormProps, 'style'> {
+  /** Url to navigate to on success. */
   successUrl?: string;
+  /** Form name (key) to apply the confirmation on. */
   form: string;
+  /** Custom message to display.
+   * @defaultValue `Are you sure you want to delete this?`
+   */
   title?: string;
+  /** Custom function when the axios request succeeds. */
   handleComplete?: Function;
+  /** Custom function when the axios request fails. */
   handleError?: Function;
+  /** Any components to be rendered in between the title and the buttons. */
   children?: React.ReactNode;
 }
 
+/**
+ * Deletion confirmation. Navigates to a different route to allow the user to either confirm or cancel an action.
+ *
+ * Wraps `<ConfirmBaseForm/>`.
+ */
 export default function ConfirmDeleteForm({
   successUrl,
   form,

package/src/DatePicker/DatePicker.test.tsx

@@ -4,7 +4,7 @@ import StringDatePickerGroup from './StringDatePickerGroup';
 import FormTestBase from '../__Tests__/FormTestBase';
 
 //hack so the datepicker internals don't complain about this not existing in the context of jest
-HTMLCanvasElement.prototype.getContext = () => {};
+HTMLCanvasElement.prototype.getContext = () => null;
 
 describe('IconInputGroup', () => {
   it('renders without crashing', () => {

package/src/DatePicker/DatePickerGroup.tsx

@@ -8,10 +8,8 @@ import { InjectedFieldProps } from '../Field/InjectedFieldProps';
 import { FormDefaults } from '../FormDefaults';
 import Group, { GroupProps } from '../Group';
 
-// Docs for react-date-picker https://www.npmjs.com/package/react-date-picker
-
 export interface DatePickerGroupProps<T>
-  extends InjectedFieldProps<T | undefined>,
+  extends InjectedFieldProps<T | undefined | null>,
     Omit<
       DatePickerProps,
       keyof InjectedFieldProps<T> | 'name' | 'value' | 'className'
@@ -20,6 +18,11 @@ export interface DatePickerGroupProps<T>
   convert: (arg: Date) => T;
 }
 
+/**
+ * Field for inputting dates. Uses `<Group/>` and `<DatePicker/>`.
+ *
+ * Uses [react-date-picker](https://www.npmjs.com/package/react-date-picker)
+ */
 export default function DatePickerGroup<T>({
   input,
   meta,
@@ -34,10 +37,14 @@ export default function DatePickerGroup<T>({
   const [displayDate, setDisplayDate] = useState<Date | null>(null);
 
   useEffect(() => {
-    if (input.value != null) {
-      setDisplayDate(new Date(`${input.value}T00:00:00.000`));
-    } else {
+    if (!input.value) {
       setDisplayDate(null);
+    } else if (typeof input.value === 'string') {
+      if (input.value.indexOf('T') === -1) {
+        setDisplayDate(new Date(`${input.value}T00:00:00.000`));
+      } else {
+        setDisplayDate(new Date(input.value));
+      }
     }
   }, [setDisplayDate, input.value]);
 

package/src/DatePicker/StringDateOnlyPickerGroup.tsx

@@ -1,9 +1,14 @@
-import { DatePickerHelper } from './DatePickerHelper';
 import DatePickerGroup from './DatePickerGroup';
+import { DatePickerHelper } from './DatePickerHelper';
 
 export interface StringDateOnlyPickerGroupProps
-  extends DatePickerHelper<string | undefined> {}
+  extends DatePickerHelper<string | undefined | null> {}
 
+/**
+ * Date picker input that consumes and outputs as a date only string in ISO format `YYYY-MM-DD`.
+ *
+ * Default display to the user is in `MM/DD/YYYY` format.
+ */
 export default function StringDatePickerGroup(
   props: StringDateOnlyPickerGroupProps
 ) {

package/src/DatePicker/StringDatePickerGroup.tsx

@@ -2,7 +2,13 @@ import DatePickerGroup from './DatePickerGroup';
 import { DatePickerHelper } from './DatePickerHelper';
 
 export interface StringDatePickerGroupProps
-  extends DatePickerHelper<string | undefined> {}
+  extends DatePickerHelper<string | undefined | null> {}
+
+/**
+ * Date picker input that consumes and outputs as a date only string in ISO format `YYYY-MM-DDTHH:mm:ss.sssZ` or `±YYYYYY-MM-DDTHH:mm:ss.sssZ`
+ *
+ * If you need `YYYY-MM-DD` format use `<StringDateOnlyPickerGroup/>`.
+ */
 export default function StringDatePickerGroup(
   props: StringDatePickerGroupProps
 ) {

package/src/Field/Field.tsx

@@ -14,7 +14,7 @@ export type RenderComponent<
   TValue,
   TRenderComponent extends ElementType
 > = Partial<ComponentProps<TRenderComponent>> extends Partial<
-  InjectedFieldProps<TValue | undefined>
+  InjectedFieldProps<TValue | undefined | null>
 >
   ? TRenderComponent
   : never;
@@ -23,7 +23,7 @@ export type RenderComponentProps<
   TValue,
   TRenderComponent extends ElementType
 > = Partial<ComponentProps<TRenderComponent>> extends Partial<
-  InjectedFieldProps<TValue | undefined>
+  InjectedFieldProps<TValue | undefined | null>
 >
   ? ComponentProps<TRenderComponent>
   : never;
@@ -34,14 +34,19 @@ export type FieldProps<
   TProp extends keyof TForm,
   TRenderComponent extends ElementType
 > = {
+  /** Name of the field. Used on submission. */
   name: TProp; // somewhat duplicated from useStandardFormInputProps but better for autocomplete
+  /** Component to be rendered. Usually this is a type of input group e.g. `<StringInputGroup/>` */
   Component: RenderComponent<TForm[TProp], TRenderComponent>;
-
+  /** Id of the field. */
   id?: string;
+  /** Whether the field should be disabled. */
   disabled?: boolean;
+  /** Client side validation functions */
   validate?:
     | ValidationFunction<TForm[TProp]>
     | ValidationFunction<TForm[TProp]>[];
+  /** Function to modify the field value without making the form dirty. (e.g. phone number) */
   normalize?: NormalizationFunction<TForm[TProp]>;
 } & Omit<
   RenderComponentProps<TForm[TProp], TRenderComponent>,

package/src/Field/FieldErrorScrollTarget.tsx

@@ -1,6 +1,7 @@
 import { useContext } from 'react';
 import { FieldNameContext } from './FieldNameContext';
 
+/** Hidden `<div/>` that acts as an anchor to scroll to when a form error occurs. */
 export default function FieldErrorScrollTarget() {
   const name = useContext(FieldNameContext);
   if (!name) {

package/src/Field/StandAloneInput.tsx

@@ -9,8 +9,11 @@ export type StandAloneInputProps<
   TValue,
   TRenderComponent extends ElementType
 > = {
+  /** Component to render inside of the field. */
   Component: RenderComponent<TValue, TRenderComponent>;
+  /** Value of the field. */
   value: TValue;
+  /** Function to change the value of the field. */
   onChange: (arg: TValue) => void;
 } & Omit<
   RenderComponentProps<TValue, TRenderComponent>,
@@ -21,6 +24,7 @@ export type StandAloneInputProps<
   | 'validate'
 >;
 
+/** The stand alone version of `<Field/>`. Can use a type of input component outside of a `<Form/>`. */
 export default function StandAloneInput<TValue, TComponent extends ElementType>(
   props: StandAloneInputProps<TValue, TComponent>
 ) {

package/src/Field/useStandardField.ts

@@ -8,14 +8,19 @@ import { NormalizationFunction } from '../Normalization/NormalizationFunction';
 import { ValidationFunction } from '../Validation/ValidationFunction';
 
 export interface useStandardFieldProps<TValue> {
+  /** Id of the field. */
   id?: string;
+  /** Name of the field. */
   name: string;
+  /** Whether the field should be disabled. */
   disabled?: boolean;
+  /** Function to validate the field. */
   validate?: ValidationFunction<TValue> | ValidationFunction<TValue>[];
+  /** Function to modify the field value without making the form dirty. (e.g. phone number) */
   normalize?: NormalizationFunction<TValue>;
 }
 
-// provides a consistent way to deal with all form fields (non array)
+/** Provides a consistent way to deal with all form fields (non array). */
 export default function useStandardField<TValue>({
   id: providedId,
   name: providedName,
@@ -51,7 +56,7 @@ export default function useStandardField<TValue>({
     disabled: disabled,
     validate: callAllValidators,
   });
-  const { setFieldValue, isSubmitting } = useFormikContext();
+  const { setFieldTouched, setFieldValue, isSubmitting } = useFormikContext();
 
   const touched =
     formikMeta.touched !== false && formikMeta.touched !== undefined;
@@ -59,14 +64,13 @@ export default function useStandardField<TValue>({
     if (!touched && isSubmitting) {
       // because we do not always register all fields up front.
       // e.g. formik expects even a 'create' form to have all fields given, at least, blank values
-      // that seems to be how it touches on submit:
-      // see: https://codesandbox.io/s/formik-example-4n7n8 vs https://codesandbox.io/s/formik-example-kttk5
-      // note in particular the change in line 24
-      // thus, we manually touch all fields here by calling onBlur
-      // there is a "setFieldTouched" from useFormikContext but it doesn't appear to work on field arrays
-      handleBlur();
+      // It looks like this was going to be a thing: https://github.com/jaredpalmer/formik/issues/691
+      // Formik appears to not have an active maintainer: https://github.com/jaredpalmer/formik/discussions/3526
+      // We previously had a different fix in place using handleBlur, but it was causing an infinite update cycle.
+      // This was noted as existing, but there was a note about it not working for FieldArray (this does appear to work in my testing with FieldArray)
+      setFieldTouched(name);
     }
-  });
+  }, [isSubmitting, name, setFieldTouched, touched]);
 
   // these are the props we expect consumers of this hook to pass directly to the input (or other control)
   const resultInput: CustomFieldInputProps<TValue> = {

package/src/FieldArray/FieldArray.tsx

@@ -3,17 +3,21 @@ import classNames from 'classnames';
 import Field, { FieldProps } from '../Field/Field';
 import { FieldNameContext } from '../Field/FieldNameContext';
 import useStandardFormInput from '../Field/useStandardField';
-import { ValidationFunction } from '../Validation/ValidationFunction';
 import { FormDefaults } from '../FormDefaults';
+import { ValidationFunction } from '../Validation/ValidationFunction';
 
 export type FieldArrayProps<
   TForm extends object,
   TProp extends keyof TForm
-> = TForm[TProp] extends Array<any> | undefined
+> = TForm[TProp] extends Array<any> | undefined | null
   ? {
+      /** Name of the field, used on submission. If using codegen this must be the provided dto. */
       name: TProp;
+      /** Label of the field. */
       label?: string;
+      /** Whether the field should be disabled. */
       disabled?: boolean;
+      /** Function to validate the value. */
       validate?:
         | ValidationFunction<TForm[TProp]>
         | ValidationFunction<TForm[TProp]>[];
@@ -23,8 +27,8 @@ export type FieldArrayProps<
     }
   : never;
 
-export type ArrayFormBuilderProp<TValue extends Array<any> | undefined> =
-  TValue extends Array<infer TForm> | undefined
+export type ArrayFormBuilderProp<TValue extends Array<any> | undefined | null> =
+  TValue extends Array<infer TForm> | undefined | null
     ? TForm extends object
       ? {
           Field: <
@@ -41,6 +45,11 @@ export type ArrayFormBuilderProp<TValue extends Array<any> | undefined> =
       : never
     : never;
 
+/**
+ * An array of fields that allows the user to add multiple instances of the same field.
+ *
+ * Includes "Add Item" and "Remove Item" buttons to allow the user to speicify the number of fields.
+ */
 export default function FieldArray<
   TForm extends object,
   TProp extends keyof TForm
@@ -52,7 +61,7 @@ export default function FieldArray<
   children,
   ...rest
 }: FieldArrayProps<TForm, TProp>) {
-  const [input, meta] = useStandardFormInput<TForm[TProp]>({
+  const [input] = useStandardFormInput<TForm[TProp]>({
     name: String(name),
     validate: validate,
     disabled: disabled,

package/src/File/FileGroup.tsx

@@ -2,17 +2,18 @@ import React, { ComponentType, LegacyRef } from 'react';
 import classNames from 'classnames';
 import FileList from './FileList';
 import { InjectedFieldProps } from '../Field/InjectedFieldProps';
-import Group, { GroupProps } from '../Group';
 import { FormDefaults } from '../FormDefaults';
+import Group, { GroupProps } from '../Group';
 
 export interface FileGroupProps
   // note: file props are of type "any" with the current type generation
-  extends InjectedFieldProps<any | undefined>,
+  extends InjectedFieldProps<any | undefined | null>,
     Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'>,
     Omit<
       React.HTMLProps<HTMLInputElement>,
       keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'
     > {
+  /** Allow multiple files to be uploaded. */
   multiple?: boolean | undefined;
 }
 
@@ -76,6 +77,7 @@ function FileGroup(
   );
 }
 
+/** File upload input group.  */
 const FileGroupWithRef = React.forwardRef(
   FileGroup
 ) as ComponentType<FileGroupProps>;

package/src/File/FileList.tsx

@@ -1,8 +1,8 @@
 import { FormDefaults } from '../FormDefaults';
 
 export interface FileListProps {
-  files?: File | File[] | undefined;
-  rejectedFiles?: File | File[] | undefined;
+  files?: File | File[] | undefined | null;
+  rejectedFiles?: File | File[] | undefined | null;
 }
 export default function FileList({ files, rejectedFiles }: FileListProps) {
   return (