@availity/mui-controlled-form 0.2.5 → 0.3.0

package/src/lib/Select.stories.tsx

@@ -1,74 +1,107 @@
 import type { Meta, StoryObj } from '@storybook/react';
 import { ControlledSelect } from './Select';
-import { ControlledForm } from './ControlledForm';
 import { Button } from '@availity/mui-button';
-import { useFormContext } from 'react-hook-form';
 import { Paper } from '@availity/mui-paper';
 import { Typography } from '@availity/mui-typography';
 import { Grid } from '@availity/mui-layout';
 import { MenuItem } from '@availity/mui-menu';
 import { FormControl, FormLabel } from '@availity/mui-form-utils';
+import { AllControllerPropertiesCategorized, SelectPropsCategorized } from './Types';
+import { FormProvider, useForm } from '..';
 
 const meta: Meta<typeof ControlledSelect> = {
   title: 'Form Components/Controlled Form/ControlledSelect',
   component: ControlledSelect,
   tags: ['autodocs'],
+  argTypes: {...AllControllerPropertiesCategorized, ...SelectPropsCategorized},
+  parameters: {
+    controls: {
+      exclude: [
+        'className',
+        'defaultChecked',
+        'onError',
+        'ref',
+        'style',
+        'tabIndex'
+      ]
+    }
+  }
 };
 
 export default meta;
 
 export const _ControlledSelect: StoryObj<typeof ControlledSelect> = {
   render: (args) => {
-    const SubmittedValues = () => {
-      const {
-        getValues,
-        formState: { isSubmitSuccessful },
-      } = useFormContext();
+    const methods = useForm();
 
-      return isSubmitSuccessful ? (
-        <Paper sx={{ padding: '1.5rem', marginTop: '1.5rem' }}>
-          <Typography variant="h2">Submitted Values</Typography>
-          <pre>{JSON.stringify(getValues(), null, 2)}</pre>
-        </Paper>
-      ) : null;
-    };
+    return (
+      <FormProvider {...methods}>
+        <form onSubmit={methods.handleSubmit((data) => data)}>
+          <FormControl>
+            <FormLabel id={`${args.id}-label`}>{args.label}</FormLabel>
+            <ControlledSelect {...args} labelId={`${args.id}-label`}>
+              <MenuItem value={1}>Option 1</MenuItem>
+              <MenuItem value={2}>Option 2</MenuItem>
+              <MenuItem value={3}>Option 3</MenuItem>
+            </ControlledSelect>
+          </FormControl>
+          <Grid container direction="row" justifyContent="space-between" marginTop={1}>
+            <Button disabled={!methods?.formState?.isSubmitSuccessful} children="Reset" color="secondary" onClick={() => methods.reset()} />
+            <Button type="submit" disabled={methods?.formState?.isSubmitSuccessful} children="Submit" />
+          </Grid>
+          { methods?.formState?.isSubmitSuccessful ? (
+            <Paper sx={{ padding: '1.5rem', marginTop: '1.5rem' }}>
+              <Typography variant="h2">Submitted Values</Typography>
+              <pre data-testid="result">{JSON.stringify(methods.getValues(), null, 2)}</pre>
+            </Paper>
+          ) : null }
+        </form>
+      </FormProvider>
+    );
+  },
+  args: {
+    name: 'controlledSelect',
+    required: true,
+    rules: { required:'This is required.' },
+    label: 'Select Label',
+  },
+};
 
-    const Actions = () => {
-      const {
-        reset,
-        formState: { isSubmitSuccessful },
-      } = useFormContext();
-      return (
-        <Grid container direction="row" justifyContent="space-between" marginTop={1}>
-          <Button
-            disabled={!isSubmitSuccessful}
-            children="Reset"
-            color="secondary"
-            onClick={() => reset({ controlledSelect: undefined })}
-          />
-          <Button type="submit" disabled={isSubmitSuccessful} children="Submit" />
-        </Grid>
-      );
-    };
+export const _ControlledMultiSelect: StoryObj<typeof ControlledSelect> = {
+  render: (args) => {
+    const methods = useForm({values:{ [args.name]: [] }});
 
     return (
-      <ControlledForm values={{ controlledSelect: undefined }} onSubmit={(data) => data}>
-        <FormControl>
-          <FormLabel id={`${args.id}-label`}>{args.label}</FormLabel>
-          <ControlledSelect {...args} labelId={`${args.id}-label`}>
-            <MenuItem value={1}>Option 1</MenuItem>
-            <MenuItem value={2}>Option 2</MenuItem>
-            <MenuItem value={3}>Option 3</MenuItem>
-          </ControlledSelect>
-          <Actions />
-          <SubmittedValues />
-        </FormControl>
-      </ControlledForm>
+      <FormProvider {...methods}>
+        <form onSubmit={methods.handleSubmit((data) => data)}>
+          <FormControl>
+            <FormLabel id={`${args.id}-label`}>{args.label}</FormLabel>
+            <ControlledSelect {...args} labelId={`${args.id}-label`}>
+              <MenuItem value={1}>Option 1</MenuItem>
+              <MenuItem value={2}>Option 2</MenuItem>
+              <MenuItem value={3}>Option 3</MenuItem>
+              <MenuItem value={4}>Option 4</MenuItem>
+              <MenuItem value={5}>Option 5</MenuItem>
+              <MenuItem value={6}>Option 6</MenuItem>
+            </ControlledSelect>
+          </FormControl>
+          <Grid container direction="row" justifyContent="space-between" marginTop={1}>
+            <Button disabled={!methods?.formState?.isSubmitSuccessful} children="Reset" color="secondary" onClick={() => methods.reset()} />
+            <Button type="submit" disabled={methods?.formState?.isSubmitSuccessful} children="Submit" />
+          </Grid>
+          <Paper sx={{ padding: '1.5rem', marginTop: '1.5rem' }}>
+            <Typography variant="h2">Submitted Values</Typography>
+            <pre>{JSON.stringify(methods.getValues(), null, 2)}</pre>
+          </Paper>
+        </form>
+      </FormProvider>
     );
   },
   args: {
-    name: 'controlledSelect',
-    required: 'This is required.',
+    name: 'controlledMutliSelect',
+    required: true,
+    rules: { required:'This is required.' },
     label: 'Select Label',
+    multiple: true,
   },
 };

package/src/lib/Select.test.tsx

@@ -1,52 +1,24 @@
 import { render, fireEvent, waitFor } from '@testing-library/react';
-import { useFormContext } from 'react-hook-form';
 import { Paper } from '@availity/mui-paper';
 import { Typography } from '@availity/mui-typography';
 import { Grid } from '@availity/mui-layout';
 import { Button } from '@availity/mui-button';
-import { ControlledForm } from './ControlledForm';
 import { ControlledSelect } from './Select';
 import { MenuItem } from '@availity/mui-menu';
-
-const SubmittedValues = () => {
-  const {
-    getValues,
-    formState: { isSubmitSuccessful },
-  } = useFormContext();
-
-  return isSubmitSuccessful ? (
-    <Paper sx={{ padding: '1.5rem', marginTop: '1.5rem' }}>
-      <Typography variant="h2">Submitted Values</Typography>
-      <pre data-testid="result">{JSON.stringify(getValues(), null, 2)}</pre>
-    </Paper>
-  ) : null;
-};
-
-const Actions = () => {
-  const {
-    formState: { isSubmitSuccessful },
-  } = useFormContext();
-  return (
-    <Grid container direction="row" justifyContent="space-between">
-      <Button type="submit" disabled={isSubmitSuccessful} children="Submit" />
-    </Grid>
-  );
-};
+import { TestForm } from './UtilComponents';
 
 const onSubmit = jest.fn();
 
 describe('ControlledSelect', () => {
   test('should render the error styling if an error is returned', async () => {
     const screen = render(
-      <ControlledForm values={{ controlledSelect: undefined }} onSubmit={onSubmit}>
-        <ControlledSelect name="controlledSelect">
-          <MenuItem value={1}>Option 1</MenuItem>
-          <MenuItem value={2}>Option 2</MenuItem>
-          <MenuItem value={3}>Option 3</MenuItem>
-        </ControlledSelect>
-        <Actions />
-        <SubmittedValues />
-      </ControlledForm>
+      <TestForm UseFormOptions={{values: { controlledSelect: undefined }}} onSubmit={onSubmit}>
+          <ControlledSelect name="controlledSelect">
+            <MenuItem value={1}>Option 1</MenuItem>
+            <MenuItem value={2}>Option 2</MenuItem>
+            <MenuItem value={3}>Option 3</MenuItem>
+          </ControlledSelect>
+      </TestForm>
     );
 
     const dropdown = screen.getByRole('combobox');

package/src/lib/Select.tsx

@@ -1,52 +1,71 @@
 import { Select, SelectProps } from '@availity/mui-form-utils';
-import { useFormContext, RegisterOptions, FieldValues } from 'react-hook-form';
+import { RegisterOptions, FieldValues, Controller } from 'react-hook-form';
+import { ControllerProps, DeprecatedRulesProps } from './Types';
 
-export type ControlledSelectProps = Omit<SelectProps, 'error' | 'required'> & { name: string } & RegisterOptions<
-    FieldValues,
-    string
-  >;
+export type ControlledSelectProps = Omit<SelectProps,
+'onBlur' | 'onChange' | 'value' | 'name' | 'required'
+> & Pick<RegisterOptions<FieldValues, string>,
+'onBlur' | 'onChange' | 'value'
+> & ControllerProps
+//TODO v1 - remove deprecated props
+& Omit<DeprecatedRulesProps, 'required'> & {
+  /** If `true`, will add `aria-required` to `input`.
+   *
+   * @deprecated There has been a collision of properties. The boolean value
+   * to mark the input as required will remain in future versions, but the
+   * required object for `react-hook-form` has been moved to the `rules` prop.
+   */
+  required?: boolean | RegisterOptions['required'];
+};
 
 export const ControlledSelect = ({
   name,
-  required,
-  maxLength,
-  minLength,
+  defaultValue,
+  deps,
+  disabled,
   max,
+  maxLength,
   min,
+  minLength,
+  onBlur,
+  onChange,
   pattern,
+  required,
+  rules = {},
+  shouldUnregister,
   validate,
-  setValueAs,
-  disabled,
-  onChange,
-  onBlur,
   value,
-  shouldUnregister,
-  deps,
   ...rest
 }: ControlledSelectProps) => {
-  const { register, getFieldState } = useFormContext();
-
   return (
-    <Select
-      {...rest}
-      error={!!getFieldState(name).error}
-      required={typeof required === 'object' ? required.value : !!required}
-      {...register(name, {
-        required,
+    <Controller
+      name={name}
+      defaultValue={defaultValue}
+      disabled={disabled}
+      rules={{
+        required: typeof required === 'boolean' ? undefined : required,
         maxLength,
         minLength,
         max,
         min,
         pattern,
         validate,
-        setValueAs,
-        disabled,
         onChange,
         onBlur,
         value,
         shouldUnregister,
         deps,
-      })}
+        ...rules,
+      }}
+      shouldUnregister={shouldUnregister}
+      render={({ field, fieldState: { error } }) => (
+        <Select
+          {...rest}
+          {...field}
+          error={!!error}
+          required={!!required}
+        />
+      )}
     />
   );
 };

package/src/lib/TextField.stories.tsx

@@ -1,19 +1,22 @@
 import type { Meta, StoryObj } from '@storybook/react';
 import { ControlledTextField, ControlledTextFieldProps } from './TextField';
-import { ControlledForm } from './ControlledForm';
 import { Button } from '@availity/mui-button';
-import { useFormContext } from 'react-hook-form';
 import { Paper } from '@availity/mui-paper';
 import { Typography } from '@availity/mui-typography';
 import { Grid } from '@availity/mui-layout';
+import { AllControllerPropertiesCategorized, TextFieldPropsCategorized } from './Types';
+import { FormProvider, useForm } from '..';
 
 const meta: Meta<typeof ControlledTextField> = {
   title: 'Form Components/Controlled Form/ControlledTextField',
   component: ControlledTextField,
   tags: ['autodocs'],
   argTypes: {
+    ...AllControllerPropertiesCategorized,
+    ...TextFieldPropsCategorized,
     helperText: {
       type: 'string',
+      table: { category: 'Input Props' }
     },
   },
 };
@@ -22,46 +25,35 @@ export default meta;
 
 export const _ControlledTextField: StoryObj<typeof ControlledTextField> = {
   render: (args: ControlledTextFieldProps) => {
-    const SubmittedValues = () => {
-      const {
-        getValues,
-        formState: { isSubmitSuccessful },
-      } = useFormContext();
+    const methods = useForm({values:{ [args.name]: '' }});
 
-      return isSubmitSuccessful ? (
-        <Paper sx={{ padding: '1.5rem', marginTop: '1.5rem' }}>
-          <Typography variant="h2">Submitted Values</Typography>
-          <pre>{JSON.stringify(getValues(), null, 2)}</pre>
-        </Paper>
-      ) : null;
-    };
-
-    const Actions = () => {
-      const {
-        reset,
-        formState: { isSubmitSuccessful },
-      } = useFormContext();
-      return (
-        <Grid container direction="row" justifyContent="space-between" marginTop={1}>
-          <Button disabled={!isSubmitSuccessful} children="Reset" color="secondary" onClick={() => reset()} />
-          <Button type="submit" disabled={isSubmitSuccessful} children="Submit" />
-        </Grid>
-      );
-    };
     return (
-      <ControlledForm values={{ controlledTextField: undefined }} onSubmit={(data) => data}>
-        <ControlledTextField {...args} />
-        <Actions />
-        <SubmittedValues />
-      </ControlledForm>
+      <FormProvider {...methods}>
+        <form onSubmit={methods.handleSubmit((data) => data)}>
+          <ControlledTextField {...args} />
+          <Grid container direction="row" justifyContent="space-between" marginTop={1}>
+            <Button disabled={!methods?.formState?.isSubmitSuccessful} children="Reset" color="secondary" onClick={() => methods.reset()} />
+            <Button type="submit" disabled={methods?.formState?.isSubmitSuccessful} children="Submit" />
+          </Grid>
+          { methods?.formState?.isSubmitSuccessful ? (
+            <Paper sx={{ padding: '1.5rem', marginTop: '1.5rem' }}>
+              <Typography variant="h2">Submitted Values</Typography>
+              <pre data-testid="result">{JSON.stringify(methods.getValues(), null, 2)}</pre>
+            </Paper>
+          ) : null }
+        </form>
+      </FormProvider>
     );
   },
   args: {
     name: 'controlledTextField',
     helperText: 'This is some helper text',
     placeholder: 'Name',
-    required: 'This field is required.',
-    maxLength: { value: 10, message: 'Too long' },
+    required: true,
+    rules: {
+      required: 'This field is required.',
+      maxLength: { value: 10, message: 'Too long' }
+    },
     label: 'TextField Label',
   },
 };

package/src/lib/TextField.test.tsx

@@ -6,6 +6,7 @@ import { Grid } from '@availity/mui-layout';
 import { Button } from '@availity/mui-button';
 import { ControlledForm } from './ControlledForm';
 import { ControlledTextField } from './TextField';
+import { TestForm } from './UtilComponents';
 
 const SubmittedValues = () => {
   const {
@@ -33,11 +34,12 @@ const Actions = () => {
 };
 
 const onSubmit = jest.fn();
+const onSubmitDeprecated = jest.fn();
 
 describe('ControlledTextField', () => {
-  test('should render the error styling if an error is returned', async () => {
+  test('Deprecated Check: should render the error styling if an error is returned', async () => {
     const screen = render(
-      <ControlledForm values={{ controlledTextField: undefined }} onSubmit={(data) => data}>
+      <ControlledForm values={{ controlledTextField: undefined }} onSubmit={onSubmitDeprecated}>
         <ControlledTextField
           name="controlledTextField"
           helperText="This is some helper text"
@@ -59,14 +61,14 @@ describe('ControlledTextField', () => {
 
     fireEvent.click(screen.getByText('Submit'));
 
-    await waitFor(() => expect(onSubmit).toHaveBeenCalledTimes(0));
+    await waitFor(() => expect(onSubmitDeprecated).toHaveBeenCalledTimes(0));
 
     await waitFor(() => expect(screen.findByText('Too long')).toBeDefined());
   });
 
-  test('should render the error styling if an error is returned', async () => {
+  test('Deprecated Check: should render the error styling if an error is returned', async () => {
     const screen = render(
-      <ControlledForm values={{ controlledTextField: undefined }} onSubmit={onSubmit}>
+      <ControlledForm values={{ controlledTextField: undefined }} onSubmit={onSubmitDeprecated}>
         <ControlledTextField
           name="controlledTextField"
           helperText="This is some helper text"
@@ -88,6 +90,70 @@ describe('ControlledTextField', () => {
 
     fireEvent.click(screen.getByText('Submit'));
 
+    await waitFor(() => expect(onSubmitDeprecated).toHaveBeenCalledTimes(1));
+
+    const result = screen.getByTestId('result');
+    await waitFor(() => {
+      const formValues = JSON.parse(result.innerHTML).controlledTextField;
+      expect(formValues).toBe('Some Text');
+    });
+  });
+
+  test('should render the error styling if an error is returned', async () => {
+    const screen = render(
+      <TestForm UseFormOptions={{values: { controlledTextField: undefined }}} onSubmit={onSubmit}>
+        <ControlledTextField
+          name="controlledTextField"
+          helperText="This is some helper text"
+          placeholder="Name"
+          rules= {{
+            required:"This field is required.",
+            maxLength:{ value: 10, message: 'Too long' }
+
+          }}
+          inputProps={{
+            'data-testid': 'testTextField',
+          }}
+        />
+      </TestForm>
+    );
+
+    const input = screen.getByTestId('testTextField');
+
+    fireEvent.change(input, { target: { value: 'This is way too much text' } });
+
+    fireEvent.click(screen.getByText('Submit'));
+
+    await waitFor(() => expect(onSubmit).toHaveBeenCalledTimes(0));
+
+    await waitFor(() => expect(screen.findByText('Too long')).toBeDefined());
+  });
+
+  test('should not render the error styling if no error is returned', async () => {
+    const screen = render(
+      <TestForm UseFormOptions={{values: { controlledTextField: undefined }}} onSubmit={onSubmit}>
+        <ControlledTextField
+          name="controlledTextField"
+          helperText="This is some helper text"
+          placeholder="Name"
+          rules= {{
+            required:"This field is required.",
+            maxLength:{ value: 10, message: 'Too long' }
+
+          }}
+          inputProps={{
+            'data-testid': 'testTextField',
+          }}
+        />
+      </TestForm>
+    );
+
+    const input = screen.getByTestId('testTextField');
+
+    fireEvent.change(input, { target: { value: 'Some Text' } });
+
+    fireEvent.click(screen.getByText('Submit'));
+
     await waitFor(() => expect(onSubmit).toHaveBeenCalledTimes(1));
 
     const result = screen.getByTestId('result');

package/src/lib/TextField.tsx

@@ -1,65 +1,83 @@
 import { TextField, TextFieldProps } from '@availity/mui-textfield';
-import { useFormContext, RegisterOptions, FieldValues } from 'react-hook-form';
+import { RegisterOptions, FieldValues, Controller } from 'react-hook-form';
+import { ControllerProps, DeprecatedRulesProps } from './Types';
 
-export type ControlledTextFieldProps = Omit<TextFieldProps, 'required'> & {
-  name: string;
-} & RegisterOptions<FieldValues, string>;
+export type ControlledTextFieldProps = Omit<TextFieldProps,
+'onBlur' | 'onChange' | 'value' | 'name' | 'required'
+> & Pick<RegisterOptions<FieldValues, string>,
+'onBlur' | 'onChange' | 'value'
+> & ControllerProps
+//TODO v1 - remove deprecated props
+& Omit<DeprecatedRulesProps, 'required'> & {
+  /** If `true`, will add required asterisk to `label` and `aria-required` to `input`.
+   *
+   * @deprecated There has been a collision of properties. The boolean value
+   * to mark the input as required will remain in future versions, but the
+   * required object for `react-hook-form` has been moved to the `rules` prop.
+   */
+  required?: boolean | RegisterOptions['required'];
+};
 
 export const ControlledTextField = ({
   name,
+  defaultValue,
+  deps,
+  disabled,
   helperText,
-  required,
-  maxLength,
-  minLength,
   max,
+  maxLength,
   min,
+  minLength,
+  onBlur,
+  onChange,
   pattern,
+  required,
+  rules = {},
+  shouldUnregister,
   validate,
-  setValueAs,
-  disabled,
-  onChange,
-  onBlur,
   value,
-  shouldUnregister,
-  deps,
   ...rest
 }: ControlledTextFieldProps) => {
-  const { register, getFieldState } = useFormContext();
-
-  const errorMessage = getFieldState(name).error?.message;
-
   return (
-    <TextField
-      {...rest}
-      required={typeof required === 'object' ? required.value : !!required}
-      {...register(name, {
-        required,
+    <Controller
+      name={name}
+      defaultValue={defaultValue}
+      disabled={disabled}
+      rules={{
+        required: typeof required === 'boolean' ? undefined : required,
         maxLength,
         minLength,
         max,
         min,
         pattern,
         validate,
-        setValueAs,
-        disabled,
         onChange,
         onBlur,
         value,
         shouldUnregister,
         deps,
-      })}
-      error={!!getFieldState(name).error}
-      helperText={
-        errorMessage && typeof errorMessage === 'string' ? (
-          <>
-            {errorMessage}
-            <br />
-            {helperText}
-          </>
-        ) : (
-          helperText
-        )
-      }
+        ...rules,
+      }}
+      shouldUnregister={shouldUnregister}
+      render={({ field : {ref, ...field}, fieldState: { error } }) => (
+        <TextField
+          {...field}
+          {...rest}
+          inputRef={ref}
+          error={!!error}
+          helperText={
+            error?.message ? (
+              <>
+                {error.message}
+                <br />
+                {helperText}
+              </>
+            ) : (
+              helperText
+            )
+          }
+        />
+      )}
     />
   );
 };