envoc-form 4.0.1-10 → 4.0.1-12

package/lib/Form/FormBasedPreventNavigation.js

@@ -1,56 +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;
-        }
-        // 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
-        var blocker = function (tx) {
-            if (window.confirm(promptMessage)) {
-                tx.retry();
-            }
-        };
-        var 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(autoUnblockingTx);
-        });
-        window.addEventListener('beforeunload', beforeUnload);
-        return function () {
-            unblock();
-            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

@@ -1,9 +1,12 @@
 import React from 'react';
 import { InputGroupProps } from './InputGroup';
-export interface IconInputGroupProps extends Omit<InputGroupProps<string | undefined>, 'onChange' | 'type' | 'value'> {
+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

@@ -31,9 +31,10 @@ var classnames_1 = __importDefault(require("classnames"));
 var InputGroup_1 = __importDefault(require("./InputGroup"));
 var FormDefaults_1 = require("../FormDefaults");
 function IconInputGroup(_a, ref) {
+    var _b;
     var icon = _a.icon, className = _a.className, rest = __rest(_a, ["icon", "className"]);
     var input = rest.input;
-    return ((0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: (0, jsx_runtime_1.jsx)(InputGroup_1.default, __assign({ icon: icon, ref: ref, className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'icon-input-group'), value: input.value || '', onChange: function (e) {
+    return ((0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: (0, jsx_runtime_1.jsx)(InputGroup_1.default, __assign({ icon: icon, ref: ref, className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'icon-input-group'), value: (_b = input.value) !== null && _b !== void 0 ? _b : '', onChange: function (e) {
                 if (!e.target.value) {
                     input.onChange(undefined);
                 }
@@ -42,5 +43,6 @@ function IconInputGroup(_a, ref) {
                 }
             } }, rest)) }));
 }
+/** Input group with an icon. */
 var IconInputGroupWithRef = react_1.default.forwardRef(IconInputGroup);
 exports.default = IconInputGroupWithRef;

package/lib/Input/InputGroup.d.ts

@@ -1,12 +1,12 @@
 import React, { ChangeEventHandler, LegacyRef } from 'react';
 import { InjectedFieldProps } from '../Field/InjectedFieldProps';
 import { GroupProps } from '../Group';
-export interface InputGroupProps<TValue> extends InjectedFieldProps<TValue>, Omit<React.HTMLProps<HTMLInputElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'> {
+export interface InputGroupProps<TValue> extends InjectedFieldProps<TValue>, Omit<React.HTMLProps<HTMLInputElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label' | 'value'>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'> {
     onChange: ChangeEventHandler<HTMLInputElement>;
-    value: string | number;
+    value: string | number | null | undefined;
     icon?: React.ReactNode;
 }
-/** generic controlled <input/> wrapped by a Group */
 declare function InputGroup<TValue>({ input, meta, label, helpText, className, required, disabled, onChange, value, icon, ...rest }: InputGroupProps<TValue>, ref: LegacyRef<HTMLInputElement>): JSX.Element;
+/** Generic controlled `<input/>` wrapped by a `<Group/>` */
 declare const InputGroupWithRef: typeof InputGroup;
 export default InputGroupWithRef;

package/lib/Input/InputGroup.js

@@ -28,12 +28,12 @@ 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 <input/> wrapped by a Group */
+var Group_1 = __importDefault(require("../Group"));
 function InputGroup(_a, ref) {
     var input = _a.input, meta = _a.meta, label = _a.label, helpText = _a.helpText, className = _a.className, required = _a.required, disabled = _a.disabled, onChange = _a.onChange, value = _a.value, icon = _a.icon, rest = __rest(_a, ["input", "meta", "label", "helpText", "className", "required", "disabled", "onChange", "value", "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 + 'input-group') }, { children: [icon, (0, jsx_runtime_1.jsx)("input", __assign({}, input, rest, { value: value, onChange: onChange, ref: ref, className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'input-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 + 'input-group') }, { children: [icon, (0, jsx_runtime_1.jsx)("input", __assign({}, input, rest, { "aria-invalid": !!meta.error, "aria-errormessage": !!meta.error ? "".concat(input.name, "-error") : undefined, value: value !== null && value !== void 0 ? value : '', onChange: onChange, ref: ref, className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'input-group') }))] })));
 }
+/** Generic controlled `<input/>` wrapped by a `<Group/>` */
 var InputGroupWithRef = react_1.default.forwardRef(InputGroup);
 exports.default = InputGroupWithRef;

package/lib/Input/MoneyInputGroup.d.ts

@@ -1,7 +1,9 @@
 import React from 'react';
 import { InputGroupProps } from './InputGroup';
-export interface MoneyInputGroupProps extends Omit<InputGroupProps<number | undefined>, 'onChange' | 'type' | 'value'> {
+export interface MoneyInputGroupProps extends Omit<InputGroupProps<number | undefined | null>, 'onChange' | 'type' | 'value'> {
+    /** Custom parsing function when the value changes. */
     parseFunc?: typeof parseInt | typeof parseFloat;
 }
+/** Input group for inputting money. */
 declare const MoneyInputGroupWithRef: React.FunctionComponent<MoneyInputGroupProps>;
 export default MoneyInputGroupWithRef;

package/lib/Input/MoneyInputGroup.js

@@ -43,5 +43,6 @@ function MoneyInputGroup(_a, ref) {
             }
         } })));
 }
+/** Input group for inputting money. */
 var MoneyInputGroupWithRef = react_1.default.forwardRef(MoneyInputGroup);
 exports.default = MoneyInputGroupWithRef;

package/lib/Input/NumberInputGroup.d.ts

@@ -1,7 +1,9 @@
 import React from 'react';
 import { InputGroupProps } from './InputGroup';
-export interface NumberInputGroupProps extends Omit<InputGroupProps<number | undefined>, 'onChange' | 'type' | 'value'> {
+export interface NumberInputGroupProps extends Omit<InputGroupProps<number | undefined | null>, 'onChange' | 'type' | 'value'> {
+    /** Custom parsing function when the value changes. */
     parseFunc?: typeof parseInt | typeof parseFloat;
 }
+/** Standard number input group. By default allows for float values. */
 declare const NumberInputGroupWithRef: React.ComponentType<NumberInputGroupProps>;
 export default NumberInputGroupWithRef;

package/lib/Input/NumberInputGroup.js

@@ -43,5 +43,6 @@ function NumberInputGroup(_a, ref) {
             }
         } })));
 }
+/** Standard number input group. By default allows for float values. */
 var NumberInputGroupWithRef = react_1.default.forwardRef(NumberInputGroup);
 exports.default = NumberInputGroupWithRef;

package/lib/Input/StringInputGroup.d.ts

@@ -1,7 +1,8 @@
 import React from 'react';
 import { InputGroupProps } from './InputGroup';
-export interface StringInputGroupProps extends Omit<InputGroupProps<string | undefined>, 'onChange' | 'type' | 'value'> {
+export interface StringInputGroupProps extends Omit<InputGroupProps<string | undefined | null>, 'onChange' | 'type' | 'value'> {
     type?: 'color' | 'email' | 'search' | 'tel' | 'text' | 'url' | 'password' | 'textarea';
 }
+/** Standard string input group. */
 declare const StringInputGroupWithRef: React.ComponentType<StringInputGroupProps>;
 export default StringInputGroupWithRef;

package/lib/Input/StringInputGroup.js

@@ -31,9 +31,10 @@ var classnames_1 = __importDefault(require("classnames"));
 var InputGroup_1 = __importDefault(require("./InputGroup"));
 var FormDefaults_1 = require("../FormDefaults");
 function StringInputGroup(_a, ref) {
+    var _b;
     var className = _a.className, rest = __rest(_a, ["className"]);
     var input = rest.input;
-    return ((0, jsx_runtime_1.jsx)(InputGroup_1.default, __assign({ ref: ref }, rest, { className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'string-group'), value: input.value || '', onChange: function (e) {
+    return ((0, jsx_runtime_1.jsx)(InputGroup_1.default, __assign({ ref: ref }, rest, { className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'string-group'), value: (_b = input.value) !== null && _b !== void 0 ? _b : '', onChange: function (e) {
             if (!e.target.value) {
                 input.onChange(undefined);
             }
@@ -42,5 +43,6 @@ function StringInputGroup(_a, ref) {
             }
         } })));
 }
+/** Standard string input group. */
 var StringInputGroupWithRef = react_1.default.forwardRef(StringInputGroup);
 exports.default = StringInputGroupWithRef;

package/lib/Normalization/normalizers.d.ts

@@ -1,2 +1,4 @@
-export declare const phoneNumber: (value: string | undefined) => string | undefined;
-export declare const zipCode: (value: string | undefined) => string | undefined;
+/** Normalizer for converting a string into a valid phone number. */
+export declare const phoneNumber: (value: string | undefined | null) => string | undefined;
+/** Normalizer for converting a string into a valid zip code. Allows for XXXXX and XXXXX-XXXX format. */
+export declare const zipCode: (value: string | undefined | null) => string | undefined;

package/lib/Normalization/normalizers.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.zipCode = exports.phoneNumber = void 0;
+/** Normalizer for converting a string into a valid phone number. */
 var phoneNumber = function (value) {
     if (!value) {
         return undefined;
@@ -22,6 +23,7 @@ var phoneNumber = function (value) {
     return onlyNums;
 };
 exports.phoneNumber = phoneNumber;
+/** Normalizer for converting a string into a valid zip code. Allows for XXXXX and XXXXX-XXXX format. */
 var zipCode = function (value) {
     if (!value) {
         return undefined;

package/lib/Select/BooleanSelectGroup.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="react" />
 import { SelectOption } from './SelectGroup';
 import { SelectGroupPropsHelper } from './SelectGroupPropsHelper';
-export interface BooleanSelectGroupProps extends Omit<SelectGroupPropsHelper<boolean>, 'options'> {
+export interface BooleanSelectGroupProps extends Omit<SelectGroupPropsHelper<boolean | undefined | null>, 'options'> {
     options?: SelectOption<boolean>[];
 }
+/** A `<SelectGroup/>` dropdown with two options. Default options are 'Yes' and 'No' with values of `true` and `false`. */
 export declare function BooleanSelectGroup(props: BooleanSelectGroupProps): JSX.Element;

package/lib/Select/BooleanSelectGroup.js

@@ -27,6 +27,7 @@ var booleanOptions = [
         value: false,
     },
 ];
+/** A `<SelectGroup/>` dropdown with two options. Default options are 'Yes' and 'No' with values of `true` and `false`. */
 function BooleanSelectGroup(props) {
     var _a;
     return ((0, jsx_runtime_1.jsx)(SelectGroup_1.default, __assign({ multiple: false }, props, { options: (_a = props.options) !== null && _a !== void 0 ? _a : booleanOptions })));

package/lib/Select/NumberSelectGroup.d.ts

@@ -1,8 +1,10 @@
 /// <reference types="react" />
 import { SelectGroupPropsHelper } from './SelectGroupPropsHelper';
-export interface MultiNumberSelectGroupProps extends SelectGroupPropsHelper<number[]> {
+export interface MultiNumberSelectGroupProps extends SelectGroupPropsHelper<number[] | undefined | null> {
 }
+/** A `<SelectGroup/>` dropdown with values as numbers. Many options can be selected at a time. */
 export declare function MultiNumberSelectGroup(props: MultiNumberSelectGroupProps): JSX.Element;
-export interface SingleNumberSelectGroupProps extends SelectGroupPropsHelper<number> {
+export interface SingleNumberSelectGroupProps extends SelectGroupPropsHelper<number | undefined | null> {
 }
+/** A `<SelectGroup/>` dropdown with values as numbers. Only one option can be selected at a time. */
 export declare function SingleNumberSelectGroup(props: SingleNumberSelectGroupProps): JSX.Element;

package/lib/Select/NumberSelectGroup.js

@@ -17,10 +17,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SingleNumberSelectGroup = exports.MultiNumberSelectGroup = void 0;
 var jsx_runtime_1 = require("react/jsx-runtime");
 var SelectGroup_1 = __importDefault(require("./SelectGroup"));
+/** A `<SelectGroup/>` dropdown with values as numbers. Many options can be selected at a time. */
 function MultiNumberSelectGroup(props) {
     return (0, jsx_runtime_1.jsx)(SelectGroup_1.default, __assign({ multiple: true }, props));
 }
 exports.MultiNumberSelectGroup = MultiNumberSelectGroup;
+/** A `<SelectGroup/>` dropdown with values as numbers. Only one option can be selected at a time. */
 function SingleNumberSelectGroup(props) {
     return (0, jsx_runtime_1.jsx)(SelectGroup_1.default, __assign({ multiple: false }, props));
 }

package/lib/Select/SelectGroup.d.ts

@@ -2,7 +2,9 @@
 import { InjectedFieldProps } from '../Field/InjectedFieldProps';
 import { GroupProps } from '../Group';
 export interface SelectOption<TValue> {
+    /** Value for the select. This will be sent to the API. */
     value: (TValue extends Array<infer P> ? P : TValue) | undefined;
+    /** Label for the select. This is displayed to the user. */
     label: string;
 }
 interface OptionsApiResult<TValue> {
@@ -13,10 +15,14 @@ interface OptionsUseServiceResult<TValue> {
     resp?: Partial<SelectOption<TValue>>[] | OptionsApiResult<TValue> | null;
     error?: any;
 }
-export interface SelectGroupProps<TValue> extends InjectedFieldProps<TValue | undefined>, Omit<GroupProps, 'input' | 'meta' | 'children'> {
+export interface SelectGroupProps<TValue> extends InjectedFieldProps<TValue | undefined | null>, Omit<GroupProps, 'input' | 'meta' | 'children'> {
+    /** Options for the dropdown. Includes the label and value. */
     options: SelectOption<TValue>[] | OptionsUseServiceResult<TValue>;
+    /** Whether the user should be able to have multiple values selected. */
     multiple: TValue extends Array<any> ? true : false;
+    /** Text diplayed when no value is selected. */
     placeholder?: string;
 }
+/** Generic select dropdown. Uses [react-select](https://react-select.com/home). */
 export default function SelectGroup<TValue>({ input, meta, className, required, disabled, options, multiple, placeholder, ...rest }: SelectGroupProps<TValue>): JSX.Element;
 export {};

package/lib/Select/SelectGroup.js

@@ -28,9 +28,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var react_select_1 = __importDefault(require("react-select"));
 var classnames_1 = __importDefault(require("classnames"));
-var Group_1 = __importDefault(require("../Group"));
 var FormDefaults_1 = require("../FormDefaults");
+var Group_1 = __importDefault(require("../Group"));
 // TODO: we could also name this "ReactSelectGroup" or similar but the types are strongly defined now so kept the names consistent
+/** Generic select dropdown. Uses [react-select](https://react-select.com/home). */
 function SelectGroup(_a) {
     var _b;
     var input = _a.input, meta = _a.meta, className = _a.className, required = _a.required, disabled = _a.disabled, options = _a.options, multiple = _a.multiple, placeholder = _a.placeholder, rest = __rest(_a, ["input", "meta", "className", "required", "disabled", "options", "multiple", "placeholder"]);

package/lib/Select/StringSelectGroup.d.ts

@@ -2,7 +2,9 @@
 import { SelectGroupPropsHelper } from './SelectGroupPropsHelper';
 export interface MultiStringSelectGroupProps extends SelectGroupPropsHelper<string[]> {
 }
+/** A `<SelectGroup/>` dropdown with values as strings. Multiple options can be selected at a time. */
 export declare function MultiStringSelectGroup(props: MultiStringSelectGroupProps): JSX.Element;
 export interface SingleStringSelectGroupProps extends SelectGroupPropsHelper<string> {
 }
+/** A `<SelectGroup/>` dropdown with the value as a string. Only one option can be selected at a time. */
 export declare function SingleStringSelectGroup(props: SingleStringSelectGroupProps): JSX.Element;

package/lib/Select/StringSelectGroup.js

@@ -17,10 +17,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SingleStringSelectGroup = exports.MultiStringSelectGroup = void 0;
 var jsx_runtime_1 = require("react/jsx-runtime");
 var SelectGroup_1 = __importDefault(require("./SelectGroup"));
+/** A `<SelectGroup/>` dropdown with values as strings. Multiple options can be selected at a time. */
 function MultiStringSelectGroup(props) {
     return (0, jsx_runtime_1.jsx)(SelectGroup_1.default, __assign({ multiple: true }, props));
 }
 exports.MultiStringSelectGroup = MultiStringSelectGroup;
+/** A `<SelectGroup/>` dropdown with the value as a string. Only one option can be selected at a time. */
 function SingleStringSelectGroup(props) {
     return (0, jsx_runtime_1.jsx)(SelectGroup_1.default, __assign({ multiple: false }, props));
 }

package/lib/StandardFormActions.d.ts

@@ -1,6 +1,11 @@
 import { MouseEventHandler } from 'react';
 export interface StandardFormActionsProps {
+    /** 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?: MouseEventHandler<HTMLButtonElement>;
 }
+/** Standard submit and cancel buttons. */
 export default function StandardFormActions({ allowPristineSubmit, handleCancel, }: StandardFormActionsProps): JSX.Element;

package/lib/StandardFormActions.js

@@ -19,6 +19,7 @@ var classnames_1 = __importDefault(require("classnames"));
 var formik_1 = require("formik");
 var SubmitFormButton_1 = __importDefault(require("./SubmitFormButton"));
 var FormDefaults_1 = require("./FormDefaults");
+/** Standard submit and cancel buttons. */
 function StandardFormActions(_a) {
     var allowPristineSubmit = _a.allowPristineSubmit, handleCancel = _a.handleCancel;
     var isSubmitting = (0, formik_1.useFormikContext)().isSubmitting;