envoc-form 4.0.1-11 → 4.0.1-12

package/lib/Input/InputGroup.d.ts

@@ -6,7 +6,7 @@ export interface InputGroupProps<TValue> extends InjectedFieldProps<TValue>, Omi
     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

@@ -30,10 +30,10 @@ var react_1 = __importDefault(require("react"));
 var classnames_1 = __importDefault(require("classnames"));
 var FormDefaults_1 = require("../FormDefaults");
 var Group_1 = __importDefault(require("../Group"));
-/** generic controlled <input/> wrapped by a 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 !== null && value !== void 0 ? 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 | 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 | 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

@@ -3,5 +3,6 @@ import { InputGroupProps } from './InputGroup';
 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

@@ -43,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 @@
+/** 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

@@ -4,4 +4,5 @@ import { SelectGroupPropsHelper } from './SelectGroupPropsHelper';
 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

@@ -2,7 +2,9 @@
 import { SelectGroupPropsHelper } from './SelectGroupPropsHelper';
 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 | 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> {
@@ -14,9 +16,13 @@ interface OptionsUseServiceResult<TValue> {
     error?: any;
 }
 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

@@ -31,6 +31,7 @@ var classnames_1 = __importDefault(require("classnames"));
 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;

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.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

@@ -4,5 +4,6 @@ import { GroupProps } from '../Group';
 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

@@ -30,11 +30,11 @@ var react_1 = __importDefault(require("react"));
 var classnames_1 = __importDefault(require("classnames"));
 var FormDefaults_1 = require("../FormDefaults");
 var Group_1 = __importDefault(require("../Group"));
-/** generic controlled <textarea/> wrapped by a 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: (_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,5 +1,6 @@
 import { ValidationFunction } from './ValidationFunction';
 export declare const required: (value: any) => "Required" | 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;
@@ -11,5 +12,7 @@ export declare const minCount: (count: number) => (value: {
 }[] | 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) {

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-11",
+  "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-11",
+    "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

@@ -23,6 +23,16 @@ interface AddressDto {
   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,8 +8,6 @@ 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 | null>,
     Omit<
@@ -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,

package/src/DatePicker/StringDateOnlyPickerGroup.tsx

@@ -4,6 +4,11 @@ import { DatePickerHelper } from './DatePickerHelper';
 export interface StringDateOnlyPickerGroupProps
   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

@@ -3,6 +3,12 @@ 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
 ) {

package/src/Field/Field.tsx

@@ -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>
 ) {