envoc-form 5.0.9 → 6.0.1-1

package/src/Form/LegacyFormBasedPreventNavigation.tsx

@@ -1,77 +0,0 @@
-import type { History, Blocker, Transition } from 'history';
-import { useEffect } from 'react';
-// see: https://gist.github.com/rmorse/426ffcc579922a82749934826fa9f743
-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 = 'Changes you made may not be saved.',
-  preventNavigate,
-  navigator,
-}: FormBasedPreventNavigationProps) {
-  useEffect(() => {
-    if (!preventNavigate) {
-      return;
-    }
-    let unblock = () => {};
-    const 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) {
-      const blocker: Blocker = (tx) => {
-        if (window.confirm(promptMessage)) {
-          tx.retry();
-        }
-      };
-      unblock = navigator.block((tx: Transition) => {
-        const autoUnblockingTx = {
-          ...tx,
-          retry() {
-            // 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);
-      });
-    } else {
-      //https://gist.github.com/MarksCode/64e438c82b0b2a1161e01c88ca0d0355
-      navigator.push = (...args: Parameters<typeof push>) => {
-        if (window.confirm(promptMessage)) {
-          push(...args);
-        }
-      };
-    }
-
-    window.addEventListener('beforeunload', beforeUnload);
-    return () => {
-      unblock();
-      navigator.push = push;
-      window.removeEventListener('beforeunload', beforeUnload);
-    };
-
-    function beforeUnload(e: BeforeUnloadEvent) {
-      e.preventDefault();
-      e.returnValue = promptMessage;
-    }
-  }, [preventNavigate, promptMessage, navigator]);
-
-  return null;
-}

package/src/Form/NewFormBasedPreventNavigation.tsx

@@ -1,59 +0,0 @@
-import type { History, Blocker, Transition } from 'history';
-import { useEffect } from 'react';
-import {
-  Navigator as BaseNavigator,
-  unstable_usePrompt as usePrompt,
-} 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 = 'Changes you made may not be saved.',
-  preventNavigate,
-  navigator,
-}: FormBasedPreventNavigationProps) {
-  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.
-  useEffect(() => {
-    if (!preventNavigate) {
-      return;
-    }
-    let unblock = () => {};
-    const push = navigator.push;
-
-    navigator.push = (...args: Parameters<typeof push>) => {
-      if (window.confirm(promptMessage)) {
-        push(...args);
-      }
-    };
-
-    window.addEventListener('beforeunload', beforeUnload);
-    return () => {
-      unblock();
-      navigator.push = push;
-      window.removeEventListener('beforeunload', beforeUnload);
-    };
-
-    function beforeUnload(e: BeforeUnloadEvent) {
-      e.preventDefault();
-      e.returnValue = promptMessage;
-    }
-  }, [preventNavigate, promptMessage, navigator]);
-
-  return null;
-}

package/src/Form/ServerErrorContext.ts

@@ -1,18 +0,0 @@
-import React from 'react';
-
-export interface ServerErrors {
-  [path: string]: string;
-}
-export interface ServerErrorContextProps {
-  errors: ServerErrors;
-  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 const ServerErrorContext = React.createContext<ServerErrorContextProps>({
-  errors: {},
-  getError: (path: string) => {
-    return undefined;
-  },
-  setError: (path: string, errorMessage: string | undefined) => {},
-});

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

@@ -1,10 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`FormTestBase has matching snapshot 1`] = `
-<DocumentFragment>
-  <form
-    action="#"
-    class="envoc-form-form"
-  />
-</DocumentFragment>
-`;

package/src/FormActions.tsx

@@ -1,47 +0,0 @@
-import { FormDefaults } from './FormDefaults';
-import { useFormikContext } from 'formik';
-import SubmitFormButton from './SubmitFormButton';
-
-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) {
-  const { isSubmitting } = useFormikContext();
-  return (
-    <>
-      <SubmitFormButton
-        className={FormDefaults.cssClassPrefix + 'form-actions'}
-        allowPristineSubmit={allowPristineSubmit}
-        disabled={disabled}
-      />
-      <button
-        type="button"
-        className={
-          FormDefaults.cssClassPrefix +
-          'form-actions ' +
-          FormDefaults.cssClassPrefix +
-          'cancel-form-button'
-        }
-        disabled={isSubmitting || disabled}
-        onClick={handleCancel || goBack}>
-        Cancel
-      </button>
-    </>
-  );
-  function goBack() {
-    window.history.back();
-  }
-}

package/src/FormDefaults.ts

@@ -1,2 +0,0 @@
-/** `envoc-form-` CSS class prefix */
-export const FormDefaults = { cssClassPrefix: 'envoc-form-' };

package/src/Group.tsx

@@ -1,62 +0,0 @@
-import { clsx } from 'clsx';
-import FieldErrorScrollTarget from './Field/FieldErrorScrollTarget';
-import { InjectedFieldProps } from './Field/InjectedFieldProps';
-import { FormDefaults } from './FormDefaults';
-
-export interface GroupProps extends InjectedFieldProps<any> {
-  /** Extra class names to apply. */
-  className?: string;
-
-  children: React.ReactNode;
-
-  /** Simple text label before the input. */
-  label?: string;
-
-  /** 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. */
-export default function Group({
-  className,
-  children,
-  label,
-  helpText,
-  meta,
-  input,
-  disabled,
-  required,
-}: GroupProps) {
-  return (
-    <div
-      className={clsx(className, FormDefaults.cssClassPrefix + 'group', {
-        [FormDefaults.cssClassPrefix + 'invalid']: meta.error,
-        [FormDefaults.cssClassPrefix + 'disabled']: disabled,
-        [FormDefaults.cssClassPrefix + 'required']: required,
-      })}>
-      <FieldErrorScrollTarget />
-      {meta.warning && (
-        <div className={FormDefaults.cssClassPrefix + 'warning'}>
-          {meta.warning}
-        </div>
-      )}
-      <label htmlFor={input.id}>{label}</label>
-      {children}
-      {meta.error && (
-        <div
-          id={`${input.id}-error`}
-          className={FormDefaults.cssClassPrefix + 'error'}>
-          {meta.error}
-        </div>
-      )}
-      {helpText && (
-        <div className={FormDefaults.cssClassPrefix + 'help'}>{helpText}</div>
-      )}
-    </div>
-  );
-}

package/src/Input/CheckboxGroup.tsx

@@ -1,60 +0,0 @@
-import { clsx } from 'clsx';
-import FieldErrorScrollTarget from '../Field/FieldErrorScrollTarget';
-import { FormDefaults } from '../FormDefaults';
-import { GroupProps } from '../Group';
-
-export interface CheckboxGroupProps extends GroupProps {
-  labelOnLeft?: boolean;
-}
-
-/** Contains standard field bits like a label, helper text, error scroll target, validation message container, etc. */
-export default function CheckboxGroup({
-  className,
-  children,
-  label,
-  helpText,
-  meta,
-  input,
-  disabled,
-  required,
-  labelOnLeft,
-}: CheckboxGroupProps) {
-  return (
-    <div
-      className={clsx(className, FormDefaults.cssClassPrefix + 'group', {
-        [FormDefaults.cssClassPrefix + 'invalid']: meta.error,
-        [FormDefaults.cssClassPrefix + 'disabled']: disabled,
-        [FormDefaults.cssClassPrefix + 'required']: required,
-      })}>
-      <FieldErrorScrollTarget />
-      {meta.warning && (
-        <div className={FormDefaults.cssClassPrefix + 'warning'}>
-          {meta.warning}
-        </div>
-      )}
-      <div className={FormDefaults.cssClassPrefix + 'checkbox-group-input'}>
-        {labelOnLeft ? (
-          <>
-            <label htmlFor={input.id}>{label}</label>
-            {children}
-          </>
-        ) : (
-          <>
-            {children}
-            <label htmlFor={input.id}>{label}</label>
-          </>
-        )}
-      </div>
-      {meta.error && (
-        <div
-          id={`${input.id}-error`}
-          className={FormDefaults.cssClassPrefix + 'error'}>
-          {meta.error}
-        </div>
-      )}
-      {helpText && (
-        <div className={FormDefaults.cssClassPrefix + 'help'}>{helpText}</div>
-      )}
-    </div>
-  );
-}

package/src/Input/CheckboxInputGroup.tsx

@@ -1,78 +0,0 @@
-import React, { LegacyRef } from 'react';
-import { clsx } from 'clsx';
-import CheckboxGroup from './CheckboxGroup';
-import { InputGroupProps } from './InputGroup';
-import { FormDefaults } from '../FormDefaults';
-
-export interface CheckboxInputGroupProps
-  extends Omit<
-    InputGroupProps<boolean | undefined | null>,
-    'onChange' | 'type' | 'value'
-  > {
-  labelOnLeft?: boolean;
-}
-
-function CheckboxInputGroup(
-  {
-    input,
-    meta,
-    disabled,
-    label,
-    required,
-    helpText,
-    className,
-    labelOnLeft,
-    ...rest
-  }: CheckboxInputGroupProps,
-  ref: LegacyRef<HTMLInputElement>
-) {
-  return (
-    <CheckboxGroup
-      input={input}
-      meta={meta}
-      disabled={disabled}
-      required={required}
-      label={label}
-      helpText={helpText}
-      labelOnLeft={labelOnLeft}
-      className={clsx(
-        className,
-        FormDefaults.cssClassPrefix + 'checkbox-group',
-        { 'label-on-left': labelOnLeft },
-        { 'label-on-right': !labelOnLeft }
-      )}>
-      <input
-        {...rest}
-        type="checkbox"
-        aria-invalid={!!meta.error}
-        aria-errormessage={!!meta.error ? `${input.name}-error` : undefined}
-        className={clsx(
-          className,
-          FormDefaults.cssClassPrefix + 'checkbox-group'
-        )}
-        checked={input.value === true}
-        onChange={(e) => {
-          input.onChange(e.target.checked);
-        }}
-        disabled={disabled}
-        required={required}
-        onBlur={input.onBlur}
-        id={input.id}
-        name={input.name}
-        ref={ref}
-      />
-    </CheckboxGroup>
-  );
-}
-
-/** Standard checkbox input. Value defaults to `undefined` with no user input and no initial values.
- *
- *  If the user should be required to decide yes / no before submission, consider using `BooleanSelectGroup`.
- *
- *  If the user should be required to check the box before submission, use the `required` prop.
- */
-const CheckboxInputGroupWithRef = React.forwardRef(
-  CheckboxInputGroup
-) as React.ComponentType<CheckboxInputGroupProps>;
-
-export default CheckboxInputGroupWithRef;

package/src/Input/IconInputGroup.tsx

@@ -1,54 +0,0 @@
-import React, { LegacyRef } from 'react';
-import { clsx } from 'clsx';
-import InputGroupWithRef, { InputGroupProps } from './InputGroup';
-import { FormDefaults } from '../FormDefaults';
-
-// TODO: make className tailwind-able instead of css. make it typeof string ????
-// or should we just give a div a className and let each project decide? (this seems to be the patern)
-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;
-}
-
-function IconInputGroup(
-  { icon, className, ...rest }: IconInputGroupProps,
-  ref: LegacyRef<HTMLInputElement>
-) {
-  const { input } = rest;
-
-  return (
-    <>
-      <InputGroupWithRef
-        icon={icon}
-        ref={ref}
-        className={clsx(
-          className,
-          FormDefaults.cssClassPrefix + 'icon-input-group'
-        )}
-        value={input.value ?? ''}
-        onChange={(e) => {
-          if (!e.target.value) {
-            input.onChange(undefined);
-          } else {
-            input.onChange(e.target.value);
-          }
-        }}
-        {...rest}
-      />
-    </>
-  );
-}
-
-/** Input group with an icon. */
-const IconInputGroupWithRef = React.forwardRef(
-  IconInputGroup
-) as React.ComponentType<IconInputGroupProps>;
-
-export default IconInputGroupWithRef;

package/src/Input/InputGroup.tsx

@@ -1,69 +0,0 @@
-import React, { ChangeEventHandler, LegacyRef } from 'react';
-import { clsx } from 'clsx';
-import { InjectedFieldProps } from '../Field/InjectedFieldProps';
-import { FormDefaults } from '../FormDefaults';
-import Group, { GroupProps } from '../Group';
-
-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 | null | undefined;
-  icon?: React.ReactNode;
-}
-
-function InputGroup<TValue>(
-  {
-    input,
-    meta,
-    label,
-    helpText,
-    className,
-    required,
-    disabled,
-    onChange,
-    value,
-    icon,
-    type,
-    ...rest
-  }: InputGroupProps<TValue>,
-  ref: LegacyRef<HTMLInputElement>
-) {
-  return (
-    <Group
-      input={input}
-      meta={meta}
-      required={required}
-      disabled={disabled}
-      label={label}
-      helpText={helpText}
-      className={clsx(className, FormDefaults.cssClassPrefix + 'input-group')}>
-      {icon}
-      <input
-        {...input}
-        {...rest}
-        aria-invalid={!!meta.error}
-        aria-errormessage={!!meta.error ? `${input.name}-error` : undefined}
-        value={value ?? ''}
-        onChange={onChange}
-        ref={ref}
-        className={clsx(className, FormDefaults.cssClassPrefix + 'input-group')}
-        disabled={disabled}
-        type={disabled ? 'text' : type}
-      />
-    </Group>
-  );
-}
-
-/** Generic controlled `<input/>` wrapped by a `<Group/>` */
-const InputGroupWithRef = React.forwardRef(InputGroup) as typeof InputGroup;
-
-export default InputGroupWithRef;

package/src/Input/MoneyInputGroup.tsx

@@ -1,47 +0,0 @@
-import React, { LegacyRef } from 'react';
-import { clsx } from 'clsx';
-import InputGroup, { InputGroupProps } from './InputGroup';
-import { FormDefaults } from '../FormDefaults';
-
-export interface MoneyInputGroupProps
-  extends Omit<
-    InputGroupProps<number | undefined | null>,
-    'onChange' | 'type' | 'value'
-  > {
-  /** Custom parsing function when the value changes. */
-  parseFunc?: typeof parseInt | typeof parseFloat;
-}
-
-function MoneyInputGroup(
-  { parseFunc, className, ...rest }: MoneyInputGroupProps,
-  ref: LegacyRef<HTMLInputElement>
-) {
-  const effectiveParse = parseFunc ?? parseFloat;
-  const { input } = rest;
-
-  return (
-    <InputGroup
-      ref={ref}
-      step={0.01}
-      min={0}
-      {...rest}
-      type="number"
-      className={clsx(className, FormDefaults.cssClassPrefix + 'money-group')}
-      value={input.value || ''}
-      onChange={(e) => {
-        if (!e.target.value) {
-          input.onChange(undefined);
-        } else {
-          input.onChange(effectiveParse(e.target.value));
-        }
-      }}
-    />
-  );
-}
-
-/** Input group for inputting money. */
-const MoneyInputGroupWithRef = React.forwardRef(
-  MoneyInputGroup
-) as React.FunctionComponent<MoneyInputGroupProps>;
-
-export default MoneyInputGroupWithRef;

package/src/Input/NumberInputGroup.tsx

@@ -1,45 +0,0 @@
-import React, { LegacyRef } from 'react';
-import { clsx } from 'clsx';
-import InputGroup, { InputGroupProps } from './InputGroup';
-import { FormDefaults } from '../FormDefaults';
-
-export interface NumberInputGroupProps
-  extends Omit<
-    InputGroupProps<number | undefined | null>,
-    'onChange' | 'type' | 'value'
-  > {
-  /** Custom parsing function when the value changes. */
-  parseFunc?: typeof parseInt | typeof parseFloat;
-}
-
-function NumberInputGroup(
-  { parseFunc, className, ...rest }: NumberInputGroupProps,
-  ref: LegacyRef<HTMLInputElement>
-) {
-  const effectiveParse = parseFunc ?? parseFloat;
-  const { input } = rest;
-
-  return (
-    <InputGroup
-      ref={ref}
-      {...rest}
-      type="number"
-      className={clsx(className, FormDefaults.cssClassPrefix + 'number-group')}
-      value={input.value || ''}
-      onChange={(e) => {
-        if (!e.target.value) {
-          input.onChange(undefined);
-        } else {
-          input.onChange(effectiveParse(e.target.value));
-        }
-      }}
-    />
-  );
-}
-
-/** Standard number input group. By default allows for float values. */
-const NumberInputGroupWithRef = React.forwardRef(
-  NumberInputGroup
-) as React.ComponentType<NumberInputGroupProps>;
-
-export default NumberInputGroupWithRef;

package/src/Input/PhoneNumberInputGroup.tsx

@@ -1,45 +0,0 @@
-import React, { LegacyRef } from 'react';
-import { clsx } from 'clsx';
-import InputGroup, { InputGroupProps } from './InputGroup';
-import { FormDefaults } from '../FormDefaults';
-import { phoneNumber } from '../Normalization/normalizers';
-
-export interface PhoneNumberInputGroupProps
-  extends Omit<
-    InputGroupProps<string | undefined | null>,
-    'onChange' | 'type' | 'value'
-  > {}
-function PhoneNumberInputGroup(
-  { className, ...rest }: PhoneNumberInputGroupProps,
-  ref: LegacyRef<HTMLInputElement>
-) {
-  const { input } = rest;
-  return (
-    <InputGroup
-      ref={ref}
-      autoComplete="tel-national"
-      {...rest}
-      type="text"
-      className={clsx(
-        className,
-        FormDefaults.cssClassPrefix + 'phone-number-group'
-      )}
-      value={input.value ?? ''}
-      onChange={(e) => {
-        if (!e.target.value) {
-          input.onChange(undefined);
-        } else {
-          input.onChange(phoneNumber(e.target.value));
-        }
-      }}
-    />
-  );
-}
-/**A standard phone number input. Will display to the user in `+XXX XXX-XXX-XXXX` format as the number is being inputted.
- * The data will get sent in the same format as displayed. Uses `normalizers.phoneNumber`.
- * @default autoComplete="tel-national"
- */
-const PhoneNumberInputGroupWithRef = React.forwardRef(
-  PhoneNumberInputGroup
-) as React.ComponentType<PhoneNumberInputGroupProps>;
-export default PhoneNumberInputGroupWithRef;