BA: updates utils package v1.3.0

silverlogic · Oct 3, 2023 · f88f789 · f88f789
1 parent e24a122
commit f88f789
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 13 deletions.
diff --git a/packages/utils/CHANGELOG.md b/packages/utils/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @baseapp-frontend/utils
 
+## 1.3.0
+
+### Minor Changes
+
+- Update `withController` so it passes a `helperText` and an `error` prop to the component. So it fits better the MUI's error display dynamic.
+
 ## 1.2.2
 
 ### Patch Changes

diff --git a/packages/utils/functions/form/withController/__tests__/withController.test.tsx b/packages/utils/functions/form/withController/__tests__/withController.test.tsx
@@ -23,7 +23,7 @@ describe('withController', () => {
 
   it('should pass down the correct props', () => {
     const { queryByText } = render(
-      <WrappedComponent name="test" someProp="prop" control={{}} enableError />,
+      <WrappedComponent name="test" someProp="prop" control={{}} error />,
     )
     const testComponent = queryByText('Test')
 

diff --git a/packages/utils/functions/form/withController/index.tsx b/packages/utils/functions/form/withController/index.tsx
@@ -5,14 +5,20 @@ import { Controller } from 'react-hook-form'
 import { WithControllerProps } from './types'
 
 function withController<T>(Component: FC<T>) {
-  return ({ name, control, ...props }: WithControllerProps<T>) => {
+  return ({ name, control, helperText, ...props }: WithControllerProps<T>) => {
     if (control) {
       return (
         <Controller
           name={name}
           control={control}
           render={({ field, fieldState }) => (
-            <Component {...field} error={fieldState.error} name={name} {...(props as any)} />
+            <Component
+              {...field}
+              error={!!fieldState.error}
+              name={name}
+              helperText={helperText || (!!fieldState.error && fieldState.error?.message)}
+              {...(props as any)}
+            />
           )}
         />
       )

diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@baseapp-frontend/utils",
   "description": "Util functions, constants and types.",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "main": "./dist/index.ts",
   "module": "./dist/index.mjs",
   "scripts": {

diff --git a/packages/utils/types/form.ts b/packages/utils/types/form.ts
@@ -1,19 +1,12 @@
-import { Control, ControllerProps, FieldError, FieldValues } from 'react-hook-form'
+import { Control, ControllerProps, FieldValues } from 'react-hook-form'
 
 import { RequireAllOrNone } from './typescript'
 
-export interface IFormControl extends Pick<ControllerProps, 'name'> {
-  control?: Control<FieldValues[string]>
-  error?: FieldError
-  enableError?: boolean
-}
-
 export type ControlProps = RequireAllOrNone<{
   control?: Control<FieldValues[string]>
   name?: ControllerProps<FieldValues>['name']
 }>
 
 export type FormControl = ControlProps & {
-  error?: FieldError
-  enableError?: boolean
+  helperText?: any
 }