Merge pull request #987 from rvsia/fieldProps

feat(renderer): introduce FieldProps

Author: Hyperkid123

packages/common/src/dual-list-select/dual-list-select.js

@@ -33,7 +33,9 @@ const DualListSelectCommon = (props) => {
 
   const { DualListSelect, ...rest } = useFieldApi({
     ...props,
-    isEqual: (current, initial) => isEqual([...(current || [])].sort(), [...(initial || [])].sort())
+    FieldProps: {
+      isEqual: (current, initial) => isEqual([...(current || [])].sort(), [...(initial || [])].sort())
+    }
   });
 
   const leftValues = rest.options

packages/mui-component-mapper/demo/index.js

@@ -12,7 +12,7 @@ import fieldArraySchema from './demo-schemas/field-array-schema';
 
 import Button from '@material-ui/core/Button';
 import wizardSchema from './demo-schemas/wizard-schema';
-import validatorTypes from '@data-driven-forms/react-form-renderer/dist/cjs/validator-types';
+import validatorTypes from '@data-driven-forms/react-form-renderer/validator-types';
 
 const theme = createMuiTheme({
   typography: {

packages/pf4-component-mapper/src/dual-list-select/dual-list-select.js

@@ -26,7 +26,9 @@ const DualList = (props) => {
     ...rest
   } = useFieldApi({
     ...props,
-    isEqual: (current, initial) => isEqual([...(current || [])].sort(), [...(initial || [])].sort())
+    FieldProps: {
+      isEqual: (current, initial) => isEqual([...(current || [])].sort(), [...(initial || [])].sort())
+    }
   });
 
   const [sortConfig, setSortConfig] = useState(() => ({ left: isSortable && 'asc', right: isSortable && 'asc' }));

packages/react-form-renderer/src/tests/form-renderer/render-form.test.js

@@ -1650,7 +1650,7 @@ describe('renderForm function', () => {
 
     expect(wrapper.find('label').text()).toEqual(label);
     expect(resolveProps).toHaveBeenCalledWith(
-      { label: 'standard label' },
+      { label: 'standard label', component: 'custom-component' },
       expect.objectContaining({ meta: expect.any(Object), input: expect.any(Object) }),
       expect.any(Object)
     );

packages/react-form-renderer/src/tests/form-renderer/use-field-api.test.js

@@ -215,4 +215,19 @@ describe('useFieldApi', () => {
     wrapper.update();
     expect(wrapper.find('input')).toHaveLength(1);
   });
+
+  it('omits FieldProps', () => {
+    const parse = jest.fn().mockImplementation((value) => value);
+    initialProps = {...initialProps, FieldProps: { parse }};
+
+    const wrapper = mount(<WrapperComponent {...initialProps} />);
+
+    expect(wrapper.find(Catcher).props().FieldProps).toEqual(undefined);
+    expect(parse.mock.calls).toHaveLength(0);
+
+    wrapper.find('input').simulate('change', { target: { value: 'ABC' } });
+    wrapper.update();
+
+    expect(parse.mock.calls).toHaveLength(1);
+  });
 });

packages/react-form-renderer/src/use-field-api/use-field-api.js

@@ -10,7 +10,7 @@ import composeValidators from './compose-validators';
 import isEqual from 'lodash/isEqual';
 
 const calculateInitialValue = (props) => {
-  if (Object.prototype.hasOwnProperty.call(props, 'initialValue') && Object.prototype.hasOwnProperty.call(props, 'dataType')) {
+  if (Object.prototype.hasOwnProperty.call(props, 'initialValue') && props.dataType) {
     return convertInitialValue(props.initialValue, props.dataType);
   }
 };
@@ -84,33 +84,57 @@ const createFieldProps = (name, formOptions) => {
   };
 };
 
-const useFieldApi = ({ name, initializeOnMount, component, render, validate, resolveProps, useWarnings, ...props }) => {
+const useFieldApi = ({
+  name,
+  resolveProps,
+  ...props
+}) => {
   const { validatorMapper, formOptions } = useContext(RendererContext);
   const [warning, setWarning] = useState();
 
-  const { validate: resolvePropsValidate, ...resolvedProps } = resolveProps
+  const resolvedProps = resolveProps
     ? resolveProps(props, createFieldProps(name, formOptions), formOptions) || {}
     : {};
 
-  const finalValidate = resolvePropsValidate || validate;
+  const combinedProps = { ...props, ...resolvedProps};
+  const {
+    initializeOnMount,
+    component,
+    render,
+    validate,
+    useWarnings,
+    clearOnUnmount,
+    dataType,
+    FieldProps,
+    ...rest
+  } = combinedProps;
 
   const [{ type, initialValue, validate: stateValidate, arrayValidator }, dispatch] = useReducer(
     reducer,
-    { props: { ...props, ...resolvedProps }, validate: finalValidate, component, validatorMapper, setWarning, useWarnings },
+    { props: combinedProps, validate, component, validatorMapper, setWarning, useWarnings },
     init
   );
 
   const mounted = useRef(false);
 
   const enhancedProps = {
-    type,
-    ...props,
-    ...resolvedProps,
+    dataType,
+    type: combinedProps.type,
+    ...(Object.prototype.hasOwnProperty.call(combinedProps, 'initialValue')
+      ? { initialValue: combinedProps.initialValue }
+      : {}
+    ),
+    ...(Object.prototype.hasOwnProperty.call(combinedProps, 'value')
+      ? { value: combinedProps.value }
+      : {}
+    ),
+    ...FieldProps,
+    ...(type ? { type } : {}),
     ...(initialValue ? { initialValue } : {}),
     ...(stateValidate ? { validate: stateValidate } : {})
   };
 
-  const fieldProps = useField(name, enhancedProps);
+  const field = useField(name, enhancedProps);
 
   /** Reinitilize type */
   useEffect(() => {
@@ -127,8 +151,8 @@ const useFieldApi = ({ name, initializeOnMount, component, render, validate, res
     if (mounted.current) {
       dispatch({
         type: 'setValidators',
-        validate: calculateValidate(enhancedProps, finalValidate, component, validatorMapper, setWarning, useWarnings),
-        arrayValidator: calculateArrayValidator(enhancedProps, finalValidate, component, validatorMapper)
+        validate: calculateValidate(enhancedProps, validate, component, validatorMapper, setWarning, useWarnings),
+        arrayValidator: calculateArrayValidator(enhancedProps, validate, component, validatorMapper)
       });
     }
     /**
@@ -137,7 +161,7 @@ const useFieldApi = ({ name, initializeOnMount, component, render, validate, res
      * Using stringify is acceptable here since the array is usually very small.
      * If we notice performance hit, we can implement custom hook with a deep equal functionality.
      */
-  }, [finalValidate ? JSON.stringify(finalValidate) : false, component, enhancedProps.dataType]);
+  }, [validate ? JSON.stringify(validate) : false, component, dataType]);
 
   /** Re-convert initialValue when changed */
   useEffect(() => {
@@ -150,7 +174,7 @@ const useFieldApi = ({ name, initializeOnMount, component, render, validate, res
         });
       }
     }
-  }, [enhancedProps.initialValue, enhancedProps.dataType]);
+  }, [enhancedProps.initialValue, dataType]);
 
   useEffect(() => {
     /**
@@ -161,33 +185,33 @@ const useFieldApi = ({ name, initializeOnMount, component, render, validate, res
       const value = Object.prototype.hasOwnProperty.call(enhancedProps, 'initialValue')
         ? enhancedProps.initialValue
         : formOptions.getFieldState(name).initial;
-      fieldProps.input.onChange(value);
+      field.input.onChange(value);
     }
-  }, [initializeOnMount, enhancedProps.initialValue, fieldProps.meta.initial, props.dataType]);
+  }, [initializeOnMount, enhancedProps.initialValue, field.meta.initial, dataType]);
 
   /**
    * Prepare deleted value of field
    */
-  const fieldClearedValue = Object.prototype.hasOwnProperty.call(props, 'clearedValue') ? props.clearedValue : formOptions.clearedValue;
+  const fieldClearedValue = Object.prototype.hasOwnProperty.call(rest, 'clearedValue') ? rest.clearedValue : formOptions.clearedValue;
 
   useEffect(
     () => {
       mounted.current = true;
-      if (fieldProps.input.type === 'file') {
-        formOptions.registerInputFile(fieldProps.input.name);
+      if (field.input.type === 'file') {
+        formOptions.registerInputFile(field.input.name);
       }
 
       return () => {
         mounted.current = false;
         /**
          * Delete the value from form state when field is inmounted
          */
-        if ((formOptions.clearOnUnmount || props.clearOnUnmount) && props.clearOnUnmount !== false) {
-          fieldProps.input.onChange(fieldClearedValue);
+        if ((formOptions.clearOnUnmount || clearOnUnmount) && clearOnUnmount !== false) {
+          field.input.onChange(fieldClearedValue);
         }
 
-        if (fieldProps.input.type === 'file') {
-          formOptions.unRegisterInputFile(fieldProps.input.name);
+        if (field.input.type === 'file') {
+          formOptions.unRegisterInputFile(field.input.name);
         }
       };
     },
@@ -197,38 +221,33 @@ const useFieldApi = ({ name, initializeOnMount, component, render, validate, res
 
   const {
     initialValue: _initialValue,
-    clearOnUnmount,
-    dataType,
     clearedValue,
-    isEqual: _isEqual,
-    validate: _validate,
-    type: _type,
     ...cleanProps
-  } = enhancedProps;
+  } = rest;
 
   /**
    * construct component props necessary that would live in field provider
    */
   return {
     ...cleanProps,
-    ...fieldProps,
+    ...field,
     ...(arrayValidator && { arrayValidator }),
     ...(useWarnings && {
       meta: {
-        ...fieldProps.meta,
+        ...field.meta,
         warning
       }
     }),
     input: {
-      ...fieldProps.input,
+      ...field.input,
       value:
-        fieldProps.input.type === 'file' && typeof fieldProps.input.value === 'object' ? fieldProps.input.value.inputValue : fieldProps.input.value,
+        field.input.type === 'file' && typeof field.input.value === 'object' ? field.input.value.inputValue : field.input.value,
       onChange: (...args) => {
         enhancedOnChange(
           {
-            ...fieldProps.meta,
+            ...field.meta,
             dataType,
-            onChange: fieldProps.input.onChange,
+            onChange: field.input.onChange,
             clearedValue: fieldClearedValue
           },
           ...args

packages/react-renderer-demo/src/pages/migration-guide-v3.md

@@ -66,4 +66,19 @@ FormRenderer component is no longer a default export of the `react-form-renderer
 
 All the mappers except Ant Design and PatternFly 4 were migrated to use JSS (CSS in JS), so you don't have to use any css-loader. (However, you still need to setup the loader in case you are using ant-component-mapper of pf4-component-mapper. If you are using PF4, you are probably using the loader right now, as you need it also for the core package.)
 
+## FieldProps introduction
+
+A new [FieldProps](/schema/introduction#fieldprops) props is introduced. This object serves to pass values to Final Form [useField configuration](https://final-form.org/docs/react-final-form/types/FieldProps). Do not use for natively supported props (`initialValue`, `validate`, ...).
+
+```diff
+{
+    name: 'component-with-complex-isEqual',
+    component: 'dual-list-selector',
+-   isEqual: (a, b) => isEqual(a, b),
++   FieldProps: {
++     isEqual: (a, b) => isEqual(a, b),
++   }
+}
+```
+
 </DocPage>

packages/react-renderer-demo/src/pages/schema/introduction.md

@@ -29,6 +29,7 @@ Other attribues, such as title or description, can be used in [form templates](/
     clearOnUnmount: true,
     condition: { ... },
     dataType: 'string',
+    FieldProps: { ... },
     hideField: true,
     initializeOnMount: true,
     initialValue: 'default-login',
@@ -132,6 +133,14 @@ Data type sets the type the value will be converted to. Read more [here](/schema
 
 ---
 
+### FieldProps
+
+*object*
+
+You can pass additional [Final Form FieldProps](https://final-form.org/docs/react-final-form/types/FieldProps) via FieldProps object. This prop is made to avoid conflicts between Final Form props and component props.
+
+---
+
 ### hideField
 
 *bool*