Chore remove unnecessary formContext from all interfaces but Registry (#4743)

Author: heath-freenome

CHANGELOG.md

@@ -15,6 +15,33 @@ it according to semantic versioning. For example, if your PR adds a breaking cha
 should change the heading of the (upcoming) version to include a major version bump.
 
 -->
+# 6.0.0-beta.16
+
+## @rjsf/antd
+
+- Updated the `ArrayFieldTemplate`, `FieldTemplate` and `ObjectFieldTemplate` to get `formContext` from the `registry`
+
+## @rjsf/core
+
+- Updated `ArrayField`, `Form`, `LayoutMultiSchemaField` and `SchemaField` to stop passing `formContext`
+
+## @rjsf/daisyui
+
+- Updated `FieldTemplate` to remove `formContext` as it is never used
+
+## @rjsf/semantic-ui
+
+- Updated the `ArrayFieldTemplate`, `BaseInputTemplate`, `CheckboxWidget`, `FieldTemplate`, `RadioWidget`, `RangeSelect`, `SelectWidget`, `TextareaWidget` and `ObjectFieldTemplate` to get `formContext` from the `registry`
+
+## @rjsf/utils
+
+- BREAKING CHANGE: Removed `formContext` from the following interfaces because it is available on `registry`:
+  - `ErrorListProps`, `FieldProps`, `FieldTemplateProps`, `ArrayFieldTemplateProps` and `WidgetProps`
+
+## Dev / docs / playground
+
+- Updated the documentation to remove `formContext` from the interface documentation, adding a BREAKING CHANGE notification in the `v6.x upgrade guide`
+
 # 6.0.0-beta.15
 
 ## @rjsf/chakra-ui

packages/antd/src/templates/ArrayFieldTemplate/index.tsx

@@ -30,7 +30,6 @@ export default function ArrayFieldTemplate<
     canAdd,
     className,
     disabled,
-    formContext,
     idSchema,
     items,
     onAddClick,
@@ -57,6 +56,7 @@ export default function ArrayFieldTemplate<
     registry,
     uiOptions,
   );
+  const { formContext } = registry;
   // Button templates are not overridden in the uiSchema
   const {
     ButtonTemplates: { AddButton },

packages/antd/src/templates/FieldTemplate/index.tsx

@@ -30,7 +30,6 @@ export default function FieldTemplate<
     disabled,
     displayLabel,
     errors,
-    formContext,
     help,
     hidden,
     id,
@@ -46,6 +45,7 @@ export default function FieldTemplate<
     schema,
     uiSchema,
   } = props;
+  const { formContext } = registry;
   const {
     colon,
     labelCol = VERTICAL_LABEL_COL,

packages/antd/src/templates/ObjectFieldTemplate/index.tsx

@@ -38,7 +38,6 @@ export default function ObjectFieldTemplate<
   const {
     description,
     disabled,
-    formContext,
     formData,
     idSchema,
     onAddClick,
@@ -57,6 +56,7 @@ export default function ObjectFieldTemplate<
     registry,
     uiOptions,
   );
+  const { formContext } = registry;
   // Button templates are not overridden in the uiSchema
   const {
     ButtonTemplates: { AddButton },

packages/core/src/components/Form.tsx

@@ -597,7 +597,6 @@ export default class Form<
   /** Renders any errors contained in the `state` in using the `ErrorList`, if not disabled by `showErrorList`. */
   renderErrors(registry: Registry<T, S, F>) {
     const { errors, errorSchema, schema, uiSchema } = this.state;
-    const { formContext } = this.props;
     const options = getUiOptions<T, S, F>(uiSchema);
     const ErrorListTemplate = getTemplate<'ErrorListTemplate', T, S, F>('ErrorListTemplate', registry, options);
 
@@ -608,7 +607,6 @@ export default class Form<
           errorSchema={errorSchema || {}}
           schema={schema}
           uiSchema={uiSchema}
-          formContext={formContext}
           registry={registry}
         />
       );
@@ -1117,7 +1115,6 @@ export default class Form<
       noHtml5Validate = false,
       disabled,
       readonly,
-      formContext,
       showErrorList = 'top',
       _internalFormWrapper,
     } = this.props;
@@ -1163,7 +1160,6 @@ export default class Form<
           idSchema={idSchema}
           idPrefix={idPrefix}
           idSeparator={idSeparator}
-          formContext={formContext}
           formData={formData}
           onChange={this.onChange}
           onBlur={this.onBlur}

packages/core/src/components/fields/ArrayField.tsx

@@ -566,7 +566,6 @@ class ArrayField<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends For
       required,
       schema,
       title: fieldTitle,
-      formContext,
       formData,
       rawErrors,
       registry,
@@ -832,7 +831,6 @@ class ArrayField<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends For
       schema,
       uiSchema,
       title: fieldTitle,
-      formContext,
       errorSchema,
       rawErrors,
     };

packages/core/src/components/fields/LayoutMultiSchemaField.tsx

@@ -190,7 +190,6 @@ export default function LayoutMultiSchemaField<
       label={(title || schema.title) ?? ''}
       disabled={disabled || (Array.isArray(enumOptions) && isEmpty(enumOptions))}
       uiSchema={uiSchema}
-      formContext={formContext}
       required={required}
       readonly={!!readonly}
       registry={registry}

packages/core/src/components/fields/SchemaField.tsx

@@ -263,7 +263,6 @@ function SchemaFieldRender<T = any, S extends StrictRJSFSchema = RJSFSchema, F e
     displayLabel,
     classNames: classNames.join(' ').trim(),
     style: uiOptions.style,
-    formContext,
     formData,
     schema,
     uiSchema,

packages/core/test/ArrayField.test.jsx

@@ -2988,7 +2988,10 @@ describe('ArrayField', () => {
         root_1: 'root_1-id',
       };
       function CustomSchemaField(props) {
-        const { formContext, idSchema } = props;
+        const {
+          registry: { formContext },
+          idSchema,
+        } = props;
         return (
           <>
             <code id={formContext[idSchema.$id]}>Ha</code>
@@ -3015,7 +3018,10 @@ describe('ArrayField', () => {
         root_1: 'root_1-id',
       };
       function CustomSchemaField(props) {
-        const { formContext, idSchema } = props;
+        const {
+          registry: { formContext },
+          idSchema,
+        } = props;
         return (
           <>
             <code id={formContext[idSchema.$id]}>Ha</code>

packages/core/test/FormContext.test.jsx

@@ -58,7 +58,7 @@ describe('FormContext', () => {
   });
 
   it('should be passed to TemplateField', () => {
-    function CustomTemplateField({ formContext }) {
+    function CustomTemplateField({ registry: { formContext } }) {
       return <div id={formContext.foo} />;
     }
 
@@ -79,7 +79,7 @@ describe('FormContext', () => {
   });
 
   it('should be passed to ArrayTemplateField', () => {
-    function CustomArrayTemplateField({ formContext }) {
+    function CustomArrayTemplateField({ registry: { formContext } }) {
       return <div id={formContext.foo} />;
     }