envoc-form 4.0.1-11 → 4.0.1-12

package/lib/DatePicker/StringDateOnlyPickerGroup.js

@@ -16,6 +16,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var DatePickerGroup_1 = __importDefault(require("./DatePickerGroup"));
+/**
+ * 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.
+ */
 function StringDatePickerGroup(props) {
     return (0, jsx_runtime_1.jsx)(DatePickerGroup_1.default, __assign({}, props, { convert: convertToDateOnly }));
 }

package/lib/DatePicker/StringDatePickerGroup.d.ts

@@ -2,4 +2,9 @@
 import { DatePickerHelper } from './DatePickerHelper';
 export interface StringDatePickerGroupProps 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): JSX.Element;

package/lib/DatePicker/StringDatePickerGroup.js

@@ -16,6 +16,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var DatePickerGroup_1 = __importDefault(require("./DatePickerGroup"));
+/**
+ * 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/>`.
+ */
 function StringDatePickerGroup(props) {
     return (0, jsx_runtime_1.jsx)(DatePickerGroup_1.default, __assign({}, props, { convert: convertToDateOnly }));
 }

package/lib/Field/Field.d.ts

@@ -6,11 +6,17 @@ export declare type RenderComponent<TValue, TRenderComponent extends ElementType
 export declare type RenderComponentProps<TValue, TRenderComponent extends ElementType> = Partial<ComponentProps<TRenderComponent>> extends Partial<InjectedFieldProps<TValue | undefined | null>> ? ComponentProps<TRenderComponent> : never;
 /** A specific Field instance to be rendered by the given TRenderComponent or by whatever default is reasonable */
 export declare type FieldProps<TForm extends object, TProp extends keyof TForm, TRenderComponent extends ElementType> = {
+    /** Name of the field. Used on submission. */
     name: TProp;
+    /** 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>, keyof InjectedFieldProps<TForm[TProp]>>;
 /**

package/lib/Field/FieldErrorScrollTarget.d.ts

@@ -1,2 +1,3 @@
 /// <reference types="react" />
+/** Hidden `<div/>` that acts as an anchor to scroll to when a form error occurs. */
 export default function FieldErrorScrollTarget(): JSX.Element | null;

package/lib/Field/FieldErrorScrollTarget.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = require("react");
 var FieldNameContext_1 = require("./FieldNameContext");
+/** Hidden `<div/>` that acts as an anchor to scroll to when a form error occurs. */
 function FieldErrorScrollTarget() {
     var name = (0, react_1.useContext)(FieldNameContext_1.FieldNameContext);
     if (!name) {

package/lib/Field/StandAloneInput.d.ts

@@ -2,8 +2,12 @@ import { ElementType } from 'react';
 import { RenderComponent, RenderComponentProps } from './Field';
 import { InjectedFieldProps } from './InjectedFieldProps';
 export declare 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>, keyof InjectedFieldProps<TValue> | 'value' | 'onChange' | 'normalize' | '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>): JSX.Element;

package/lib/Field/StandAloneInput.js

@@ -48,6 +48,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = require("react");
 var uuid = __importStar(require("uuid"));
+/** The stand alone version of `<Field/>`. Can use a type of input component outside of a `<Form/>`. */
 function StandAloneInput(props) {
     var Component = props.Component, value = props.value, onChange = props.onChange, disabled = props.disabled, rest = __rest(props, ["Component", "value", "onChange", "disabled"]);
     var handleChange = function (arg) {

package/lib/Field/useStandardField.d.ts

@@ -3,12 +3,18 @@ import { CustomFieldMetaProps } from './CustomFieldMetaProps';
 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). */
 export default function useStandardField<TValue>({ id: providedId, name: providedName, disabled, validate, normalize, }: useStandardFieldProps<TValue>): [
     CustomFieldInputProps<TValue>,
     CustomFieldMetaProps<TValue>

package/lib/Field/useStandardField.js

@@ -15,7 +15,7 @@ var react_1 = require("react");
 var formik_1 = require("formik");
 var FieldNameContext_1 = require("./FieldNameContext");
 var ServerErrorContext_1 = require("../Form/ServerErrorContext");
-// provides a consistent way to deal with all form fields (non array)
+/** Provides a consistent way to deal with all form fields (non array). */
 function useStandardField(_a) {
     var providedId = _a.id, providedName = _a.name, disabled = _a.disabled, validate = _a.validate, normalize = _a.normalize;
     // because the formik errors are evaluated all at the same time we need to keep server errors separate
@@ -39,20 +39,19 @@ function useStandardField(_a) {
         disabled: disabled,
         validate: callAllValidators,
     }), formikInput = _c[0], formikMeta = _c[1];
-    var _d = (0, formik_1.useFormikContext)(), setFieldValue = _d.setFieldValue, isSubmitting = _d.isSubmitting;
+    var _d = (0, formik_1.useFormikContext)(), setFieldTouched = _d.setFieldTouched, setFieldValue = _d.setFieldValue, isSubmitting = _d.isSubmitting;
     var touched = formikMeta.touched !== false && formikMeta.touched !== undefined;
     (0, react_1.useEffect)(function () {
         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)
     var resultInput = {
         name: formikInput.name,

package/lib/FieldArray/FieldArray.d.ts

@@ -2,9 +2,13 @@ import { ElementType } from 'react';
 import { FieldProps } from '../Field/Field';
 import { ValidationFunction } from '../Validation/ValidationFunction';
 export declare type FieldArrayProps<TForm extends object, TProp extends keyof TForm> = 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]>[];
     children: (formBuilder: ArrayFormBuilderProp<TForm[TProp]>) => JSX.Element;
 } : never;
@@ -12,4 +16,9 @@ export declare type ArrayFormBuilderProp<TValue extends Array<any> | undefined |
     Field: <TProp extends keyof TForm, TRenderComponent extends ElementType>(props: FieldProps<TForm, TProp, TRenderComponent>) => JSX.Element;
     FieldArray: <TProp extends keyof TForm>(props: FieldArrayProps<TForm, TProp>) => JSX.Element;
 } : 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>({ name, label, validate, disabled, children, ...rest }: FieldArrayProps<TForm, TProp>): JSX.Element;

package/lib/FieldArray/FieldArray.js

@@ -40,6 +40,11 @@ var Field_1 = __importDefault(require("../Field/Field"));
 var FieldNameContext_1 = require("../Field/FieldNameContext");
 var useStandardField_1 = __importDefault(require("../Field/useStandardField"));
 var FormDefaults_1 = require("../FormDefaults");
+/**
+ * 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.
+ */
 function FieldArray(_a) {
     var _b;
     var name = _a.name, label = _a.label, validate = _a.validate, disabled = _a.disabled, children = _a.children, rest = __rest(_a, ["name", "label", "validate", "disabled", "children"]);

package/lib/File/FileGroup.d.ts

@@ -2,7 +2,9 @@ import React from 'react';
 import { InjectedFieldProps } from '../Field/InjectedFieldProps';
 import { GroupProps } from '../Group';
 export interface FileGroupProps 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;
 }
+/** File upload input group.  */
 declare const FileGroupWithRef: React.ComponentType<FileGroupProps>;
 export default FileGroupWithRef;

package/lib/File/FileGroup.js

@@ -53,5 +53,6 @@ function FileGroup(_a, ref) {
                     }
                 }, value: undefined, ref: ref, type: "file", className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'file-group') })), (0, jsx_runtime_1.jsx)(FileList_1.default, { files: input.value })] })));
 }
+/** File upload input group.  */
 var FileGroupWithRef = react_1.default.forwardRef(FileGroup);
 exports.default = FileGroupWithRef;

package/lib/Form/FocusError.d.ts

@@ -1,5 +1,7 @@
 import { ServerErrorContextProps } from './ServerErrorContext';
 export interface FocusErrorProps {
+    /** Validation errors that have been received from the server. */
     serverErrors: ServerErrorContextProps;
 }
+/** Function to scroll to the field that has an error. */
 export default function FocusError(props: FocusErrorProps): null;

package/lib/Form/FocusError.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var react_1 = require("react");
 var formik_1 = require("formik");
 var smoothscroll_polyfill_1 = __importDefault(require("smoothscroll-polyfill"));
+/** Function to scroll to the field that has an error. */
 function FocusError(props) {
     var _a = (0, formik_1.useFormikContext)(), errors = _a.errors, isSubmitting = _a.isSubmitting, isValidating = _a.isValidating;
     smoothscroll_polyfill_1.default.polyfill();

package/lib/Form/Form.d.ts

@@ -8,18 +8,24 @@ export declare type FormBuilderProp<TForm extends object> = {
     FieldArray: <TProp extends keyof TForm>(props: FieldArrayProps<TForm, TProp>) => JSX.Element;
 };
 export interface FullFormProps<TForm extends object> {
+    /** The `<Field/>` and `<FieldArray/>` components. */
     children: (formBuilder: FormBuilderProp<TForm>) => JSX.Element;
+    /** Submission handler  */
     onSubmit: (formValues: TForm, formikBag: FormikHelpers<TForm>) => Promise<ValidatedApiResult>;
+    /** Submission handler for forms that use [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData).*/
     onFormDataSubmit: (formValues: FormData, formikBag: FormikHelpers<TForm>) => Promise<ValidatedApiResult>;
     className?: string;
     style?: CSSProperties;
+    /** Prevent the user from leaving the form if they have edited any field. This is presented as a JS `alert()`. */
     ignoreLostChanges?: boolean;
+    /** The intitial values of the form. */
     initialValues?: TForm;
 }
 declare type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
     [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
 }[Keys];
 export declare type FormProps<TForm extends object> = RequireAtLeastOne<FullFormProps<TForm>, 'onSubmit' | 'onFormDataSubmit'>;
+/** Define a form. Uses [formik](https://formik.org/docs/overview). Usually contains many `<Field/>` components. */
 declare function Form<TForm extends object>({ children, className, style, ignoreLostChanges, onSubmit, onFormDataSubmit, initialValues, ...props }: FormProps<TForm>): JSX.Element;
 declare namespace Form {
     var DisplayFormState: () => JSX.Element;

package/lib/Form/Form.js

@@ -37,6 +37,7 @@ var FieldArray_1 = __importDefault(require("../FieldArray/FieldArray"));
 var FormDefaults_1 = require("../FormDefaults");
 var objectContainsNonSerializableProperty_1 = __importDefault(require("../utils/objectContainsNonSerializableProperty"));
 var objectToFormData_1 = __importDefault(require("../utils/objectToFormData"));
+/** Define a form. Uses [formik](https://formik.org/docs/overview). Usually contains many `<Field/>` components. */
 function Form(_a) {
     var children = _a.children, className = _a.className, style = _a.style, ignoreLostChanges = _a.ignoreLostChanges, onSubmit = _a.onSubmit, onFormDataSubmit = _a.onFormDataSubmit, initialValues = _a.initialValues, props = __rest(_a, ["children", "className", "style", "ignoreLostChanges", "onSubmit", "onFormDataSubmit", "initialValues"]);
     // formik resets all error on each blur (with our settings)

package/lib/Form/FormBasedPreventNavigation.d.ts

@@ -1,5 +1,7 @@
+/// <reference types="react" />
 export interface FormBasedPreventNavigationProps {
     ignoreLostChanges?: boolean;
     promptMessage?: string;
 }
-export default function FormBasedPreventNavigation({ ignoreLostChanges, promptMessage, }: FormBasedPreventNavigationProps): null;
+/** Prevent the user from navigating away from a form if there are any changes. */
+export default function FormBasedPreventNavigation({ ignoreLostChanges, promptMessage, }: FormBasedPreventNavigationProps): JSX.Element;

package/lib/Form/FormBasedPreventNavigation.js

@@ -1,73 +1,26 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = require("react");
-// see: https://gist.github.com/rmorse/426ffcc579922a82749934826fa9f743
 var react_router_dom_1 = require("react-router-dom");
 var formik_1 = require("formik");
+var LegacyFormBasedPreventNavigation_1 = __importDefault(require("./LegacyFormBasedPreventNavigation"));
+var NewFormBasedPreventNavigation_1 = __importDefault(require("./NewFormBasedPreventNavigation"));
+/** Prevent the user from navigating away from a form if there are any changes. */
 function FormBasedPreventNavigation(_a) {
     var ignoreLostChanges = _a.ignoreLostChanges, _b = _a.promptMessage, promptMessage = _b === void 0 ? 'Changes you made may not be saved.' : _b;
     var _c = (0, formik_1.useFormikContext)(), dirty = _c.dirty, isSubmitting = _c.isSubmitting;
     var preventNavigate = !ignoreLostChanges && dirty && !isSubmitting;
     var navigator = (0, react_1.useContext)(react_router_dom_1.UNSAFE_NavigationContext).navigator;
-    (0, react_1.useEffect)(function () {
-        if (!preventNavigate) {
-            return;
-        }
-        var unblock = function () { };
-        var push = navigator.push;
-        // TODO: https://reactrouter.com/docs/en/v6/upgrading/v5#prompt-is-not-currently-supported
-        // this is a workaround until we get native support for prompt on navigate
-        if (navigator.block) {
-            var blocker_1 = function (tx) {
-                if (window.confirm(promptMessage)) {
-                    tx.retry();
-                }
-            };
-            unblock = navigator.block(function (tx) {
-                var autoUnblockingTx = __assign(__assign({}, tx), { retry: function () {
-                        // Automatically unblock the transition so it can play all the way
-                        // through before retrying it. TODO: Figure out how to re-enable
-                        // this block if the transition is cancelled for some reason.
-                        unblock();
-                        tx.retry();
-                    } });
-                blocker_1(autoUnblockingTx);
-            });
-        }
-        else {
-            //https://gist.github.com/MarksCode/64e438c82b0b2a1161e01c88ca0d0355
-            navigator.push = function () {
-                var args = [];
-                for (var _i = 0; _i < arguments.length; _i++) {
-                    args[_i] = arguments[_i];
-                }
-                if (window.confirm(promptMessage)) {
-                    push.apply(void 0, args);
-                }
-            };
-        }
-        window.addEventListener('beforeunload', beforeUnload);
-        return function () {
-            unblock();
-            navigator.push = push;
-            window.removeEventListener('beforeunload', beforeUnload);
-        };
-        function beforeUnload(e) {
-            e.preventDefault();
-            e.returnValue = promptMessage;
-        }
-    }, [preventNavigate, promptMessage, navigator]);
-    return null;
+    var isUsingDataRouter = navigator.location === undefined;
+    if (isUsingDataRouter) {
+        return ((0, jsx_runtime_1.jsx)(NewFormBasedPreventNavigation_1.default, { promptMessage: promptMessage, preventNavigate: preventNavigate, navigator: navigator }));
+    }
+    else {
+        return ((0, jsx_runtime_1.jsx)(LegacyFormBasedPreventNavigation_1.default, { promptMessage: promptMessage, preventNavigate: preventNavigate, navigator: navigator }));
+    }
 }
 exports.default = FormBasedPreventNavigation;

package/lib/Form/LegacyFormBasedPreventNavigation.d.ts

@@ -0,0 +1,17 @@
+import type { History } from 'history';
+import { Navigator as BaseNavigator } from 'react-router-dom';
+interface Navigator extends BaseNavigator {
+    block?: History['block'];
+}
+export interface FormBasedPreventNavigationProps {
+    promptMessage?: string;
+    preventNavigate: boolean;
+    navigator: Navigator;
+}
+/** Only use this if the project uses `<BrowserRouter/>` or any router that does not support the new
+ * [react-router Data API](https://reactrouter.com/en/main/routers/picking-a-router#using-v64-data-apis)
+ *
+ * Legacy function to prevent the user from navigating away from a form if there are any changes.
+ */
+export default function LegacyFormBasedPreventNavigation({ promptMessage, preventNavigate, navigator, }: FormBasedPreventNavigationProps): null;
+export {};

package/lib/Form/LegacyFormBasedPreventNavigation.js

@@ -0,0 +1,72 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var react_1 = require("react");
+/** Only use this if the project uses `<BrowserRouter/>` or any router that does not support the new
+ * [react-router Data API](https://reactrouter.com/en/main/routers/picking-a-router#using-v64-data-apis)
+ *
+ * Legacy function to prevent the user from navigating away from a form if there are any changes.
+ */
+function LegacyFormBasedPreventNavigation(_a) {
+    var _b = _a.promptMessage, promptMessage = _b === void 0 ? 'Changes you made may not be saved.' : _b, preventNavigate = _a.preventNavigate, navigator = _a.navigator;
+    (0, react_1.useEffect)(function () {
+        if (!preventNavigate) {
+            return;
+        }
+        var unblock = function () { };
+        var push = navigator.push;
+        // TODO: https://reactrouter.com/docs/en/v6/upgrading/v5#prompt-is-not-currently-supported
+        // this is a workaround until we get native support for prompt on navigate
+        if (navigator.block) {
+            var blocker_1 = function (tx) {
+                if (window.confirm(promptMessage)) {
+                    tx.retry();
+                }
+            };
+            unblock = navigator.block(function (tx) {
+                var autoUnblockingTx = __assign(__assign({}, tx), { retry: function () {
+                        // Automatically unblock the transition so it can play all the way
+                        // through before retrying it. TODO: Figure out how to re-enable
+                        // this block if the transition is cancelled for some reason.
+                        unblock();
+                        tx.retry();
+                    } });
+                blocker_1(autoUnblockingTx);
+            });
+        }
+        else {
+            //https://gist.github.com/MarksCode/64e438c82b0b2a1161e01c88ca0d0355
+            navigator.push = function () {
+                var args = [];
+                for (var _i = 0; _i < arguments.length; _i++) {
+                    args[_i] = arguments[_i];
+                }
+                if (window.confirm(promptMessage)) {
+                    push.apply(void 0, args);
+                }
+            };
+        }
+        window.addEventListener('beforeunload', beforeUnload);
+        return function () {
+            unblock();
+            navigator.push = push;
+            window.removeEventListener('beforeunload', beforeUnload);
+        };
+        function beforeUnload(e) {
+            e.preventDefault();
+            e.returnValue = promptMessage;
+        }
+    }, [preventNavigate, promptMessage, navigator]);
+    return null;
+}
+exports.default = LegacyFormBasedPreventNavigation;

package/lib/Form/NewFormBasedPreventNavigation.d.ts

@@ -0,0 +1,14 @@
+import type { History } from 'history';
+import { Navigator as BaseNavigator } from 'react-router-dom';
+interface Navigator extends BaseNavigator {
+    block?: History['block'];
+    location: Location;
+}
+interface FormBasedPreventNavigationProps {
+    promptMessage?: string;
+    preventNavigate: boolean;
+    navigator: Navigator;
+}
+/** Temporary function to allow backwards compatibility with routers that do not use the new Data API */
+export default function NewFormBasedPreventNavigation({ promptMessage, preventNavigate, navigator, }: FormBasedPreventNavigationProps): null;
+export {};

package/lib/Form/NewFormBasedPreventNavigation.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var react_1 = require("react");
+var react_router_dom_1 = require("react-router-dom");
+/** Temporary function to allow backwards compatibility with routers that do not use the new Data API */
+function NewFormBasedPreventNavigation(_a) {
+    var _b = _a.promptMessage, promptMessage = _b === void 0 ? 'Changes you made may not be saved.' : _b, preventNavigate = _a.preventNavigate, navigator = _a.navigator;
+    (0, react_router_dom_1.unstable_usePrompt)({
+        when: preventNavigate,
+        message: promptMessage,
+    });
+    // TODO: Once react-router fully supports usePrompt and when we do not want to support routers
+    // that do not support the react-router Data API we can remove this.
+    (0, react_1.useEffect)(function () {
+        if (!preventNavigate) {
+            return;
+        }
+        var unblock = function () { };
+        var push = navigator.push;
+        navigator.push = function () {
+            var args = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args[_i] = arguments[_i];
+            }
+            if (window.confirm(promptMessage)) {
+                push.apply(void 0, args);
+            }
+        };
+        window.addEventListener('beforeunload', beforeUnload);
+        return function () {
+            unblock();
+            navigator.push = push;
+            window.removeEventListener('beforeunload', beforeUnload);
+        };
+        function beforeUnload(e) {
+            e.preventDefault();
+            e.returnValue = promptMessage;
+        }
+    }, [preventNavigate, promptMessage, navigator]);
+    return null;
+}
+exports.default = NewFormBasedPreventNavigation;

package/lib/Form/ServerErrorContext.d.ts

@@ -7,4 +7,5 @@ export interface ServerErrorContextProps {
     getError: (path: string) => string | undefined;
     setError: (path: string, errorMessage: string | undefined) => void;
 }
+/** Context to store the API errors from the server for the form. */
 export declare const ServerErrorContext: React.Context<ServerErrorContextProps>;

package/lib/Form/ServerErrorContext.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ServerErrorContext = void 0;
 var react_1 = __importDefault(require("react"));
+/** Context to store the API errors from the server for the form. */
 exports.ServerErrorContext = react_1.default.createContext({
     errors: {},
     getError: function (path) {

package/lib/FormActions.d.ts

@@ -1,7 +1,13 @@
 /// <reference types="react" />
 export interface FormActionsProps {
+    /** Allow the form to be submitted without any changes. By default this is not allowed. */
     allowPristineSubmit?: boolean;
+    /** The cancel button's `onClick`.
+     * @defaultValue `window.history.back()`
+     */
     handleCancel?: () => void;
+    /** Whether both buttons should be disabled. */
     disabled?: boolean;
 }
+/** Standard cancel and submit buttons. */
 export default function FormActions({ allowPristineSubmit, handleCancel, disabled, }: FormActionsProps): JSX.Element;

package/lib/FormActions.js

@@ -18,6 +18,7 @@ var jsx_runtime_1 = require("react/jsx-runtime");
 var FormDefaults_1 = require("./FormDefaults");
 var formik_1 = require("formik");
 var SubmitFormButton_1 = __importDefault(require("./SubmitFormButton"));
+/** Standard cancel and submit buttons. */
 function FormActions(_a) {
     var allowPristineSubmit = _a.allowPristineSubmit, handleCancel = _a.handleCancel, disabled = _a.disabled;
     var isSubmitting = (0, formik_1.useFormikContext)().isSubmitting;

package/lib/FormDefaults.d.ts

@@ -1,3 +1,4 @@
+/** `envoc-form-` CSS class prefix */
 export declare const FormDefaults: {
     cssClassPrefix: string;
 };

package/lib/FormDefaults.js

@@ -1,4 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FormDefaults = void 0;
+/** `envoc-form-` CSS class prefix */
 exports.FormDefaults = { cssClassPrefix: 'envoc-form-' };

package/lib/Group.d.ts

@@ -1,14 +1,16 @@
 /// <reference types="react" />
 import { InjectedFieldProps } from './Field/InjectedFieldProps';
 export interface GroupProps extends InjectedFieldProps<any> {
+    /** Extra class names to apply. */
     className?: string;
     children: React.ReactNode;
-    /** simple text label before the input */
+    /** Simple text label before the input. */
     label?: string;
-    /** simple helper text after the input*/
+    /** Simple helper text after the input. */
     helpText?: string | React.ReactNode;
+    /** Whether the field should be disabled. */
     disabled?: boolean;
     required?: boolean;
 }
-/** contains standard field bits like a label, helper text, error scroll target, validation message container, etc */
+/** Contains standard field bits like a label, helper text, error scroll target, validation message container, etc. */
 export default function Group({ className, children, label, helpText, meta, input, disabled, required, }: GroupProps): JSX.Element;

package/lib/Group.js

@@ -18,7 +18,7 @@ var jsx_runtime_1 = require("react/jsx-runtime");
 var classnames_1 = __importDefault(require("classnames"));
 var FormDefaults_1 = require("./FormDefaults");
 var FieldErrorScrollTarget_1 = __importDefault(require("./Field/FieldErrorScrollTarget"));
-/** contains standard field bits like a label, helper text, error scroll target, validation message container, etc */
+/** Contains standard field bits like a label, helper text, error scroll target, validation message container, etc. */
 function Group(_a) {
     var _b;
     var className = _a.className, children = _a.children, label = _a.label, helpText = _a.helpText, meta = _a.meta, input = _a.input, disabled = _a.disabled, required = _a.required;
@@ -26,6 +26,6 @@ function Group(_a) {
             _b[FormDefaults_1.FormDefaults.cssClassPrefix + 'invalid'] = meta.error,
             _b[FormDefaults_1.FormDefaults.cssClassPrefix + 'disabled'] = disabled,
             _b[FormDefaults_1.FormDefaults.cssClassPrefix + 'required'] = required,
-            _b)) }, { children: [(0, jsx_runtime_1.jsx)(FieldErrorScrollTarget_1.default, {}), meta.warning && ((0, jsx_runtime_1.jsx)("div", __assign({ className: FormDefaults_1.FormDefaults.cssClassPrefix + 'warning' }, { children: meta.warning }))), (0, jsx_runtime_1.jsx)("label", __assign({ htmlFor: input.id }, { children: label })), children, meta.error && ((0, jsx_runtime_1.jsx)("div", __assign({ className: FormDefaults_1.FormDefaults.cssClassPrefix + 'error' }, { children: meta.error }))), helpText && ((0, jsx_runtime_1.jsx)("div", __assign({ className: FormDefaults_1.FormDefaults.cssClassPrefix + 'help' }, { children: helpText })))] })));
+            _b)) }, { children: [(0, jsx_runtime_1.jsx)(FieldErrorScrollTarget_1.default, {}), meta.warning && ((0, jsx_runtime_1.jsx)("div", __assign({ className: FormDefaults_1.FormDefaults.cssClassPrefix + 'warning' }, { children: meta.warning }))), (0, jsx_runtime_1.jsx)("label", __assign({ htmlFor: input.id }, { children: label })), children, meta.error && ((0, jsx_runtime_1.jsx)("div", __assign({ id: "".concat(input.id, "-error"), className: FormDefaults_1.FormDefaults.cssClassPrefix + 'error' }, { children: meta.error }))), helpText && ((0, jsx_runtime_1.jsx)("div", __assign({ className: FormDefaults_1.FormDefaults.cssClassPrefix + 'help' }, { children: helpText })))] })));
 }
 exports.default = Group;

package/lib/Input/IconInputGroup.d.ts

@@ -2,8 +2,11 @@ import React from 'react';
 import { InputGroupProps } from './InputGroup';
 export interface IconInputGroupProps extends Omit<InputGroupProps<string | undefined | null>, 'onChange' | 'type' | 'value'> {
     type?: 'color' | 'email' | 'search' | 'tel' | 'text' | 'url';
+    /** Icon to display on the input group. */
     icon: React.ReactNode;
+    /** Text to display after the input group to give more information to the user. */
     helpText?: string;
 }
+/** Input group with an icon. */
 declare const IconInputGroupWithRef: React.ComponentType<IconInputGroupProps>;
 export default IconInputGroupWithRef;

package/lib/Input/IconInputGroup.js

@@ -43,5 +43,6 @@ function IconInputGroup(_a, ref) {
                 }
             } }, rest)) }));
 }
+/** Input group with an icon. */
 var IconInputGroupWithRef = react_1.default.forwardRef(IconInputGroup);
 exports.default = IconInputGroupWithRef;