Feature - Prep work for new feature in 4736 #4776
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… of properties Fixed rjsf-team#4772 by always genering the outer grid - Updated `chakra-ui`'s `ObjectFieldTemplate` to render the outer `Grid` regardless of the number of properties - Updated the `CHANGELOG.md` accordingly
8 tasks
nickgros
reviewed
Sep 20, 2025
| const { keyedFormData } = this.state; | ||
| const fieldTitle = schema.title || title || name; | ||
| const { schemaUtils, formContext } = registry; | ||
| const { schemaUtils, formContext, globalFormOptions = {} } = registry; |
There was a problem hiding this comment.
It doesn't look like it would be a problem in any of the components in this change, but setting the default value to {} here would create a new object every render. It could cause performance issues if it later got passed to a hook dependency array, which could happen in a future change or in a custom field.
Maybe Form.getDefaultRegistry should create one empty object instead and pass it around everywhere?
There was a problem hiding this comment.
I'll go with that
| The `customValidate` prop requires a function that specifies custom validation rules for the form. | ||
| See [Validation](../usage/validation.md) for more information. | ||
|
|
||
| ## experimental_componentUpdateStrategy |
Breaking change refactoring in preparation for the feature in 4736 - In `@rjsf/utils`: - Added new `GlobalFormOptions`, refactoring the `experimental_componentUpdateStrategy` from `Registry` and `idPrefix` & `idSeparator` from `FieldProps` - Replaced the `experimental_componentUpdateStrategy` prop in `Registry` with `readonly globalFormOptions?: GlobalFormOptions` - Updated `FieldProps` to remove `idPrefix` and `idSeparator` - In `@rjsf/core`: - Updated `Form` to add the `globalFormOptions` to the registry if there are any `GlobalFormOptions` values provided - Updated `ArrayField`, `LayoutGridField`, `ObjectField` and `SchemaField` to get `idPrefix`, `idSeparator` from the `registry.globalFormOptions`, no longer passing them on `FieldProps` - Updated `SchemaField` to get `experimental_componentUpdateStrategy` from the `registry.globalFormOptions` as well - Updated the `SchemaField` tests as needed - In `@rjsf/daisy` updated the snapshots - Updated the `custom-widget-fields.md` and `v6.x upgrade guide.md` to document the refactor of the `idPrefix` and `idSeparator` refactor - Updated the `CHANGELOG.md` file accordingly
heath-freenome
force-pushed
the
prep-work-for-4736
branch
from
819c8bb to
baab030
Compare
nickgros
reviewed
Sep 20, 2025
Comment on lines
966
to
968
| const globalFormOptions = JSON.parse( | ||
| JSON.stringify({ idPrefix, idSeparator, experimental_componentUpdateStrategy }), | ||
| ); |
There was a problem hiding this comment.
This will not work if #4773 adds the nameGenerator function prop since it couldn't be be stringified/parsed.
Could you use lodash omitBy/isUndefined?
Suggested change
| const globalFormOptions = JSON.parse( | |
| JSON.stringify({ idPrefix, idSeparator, experimental_componentUpdateStrategy }), | |
| ); | |
| const globalFormOptions = omitBy({ idPrefix, idSeparator, experimental_componentUpdateStrategy }, isUndefined) |
There was a problem hiding this comment.
I went with isNil() rather than isUndefined() because we were already including it
nickgros
approved these changes
Sep 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reasons for making this change
Breaking change refactoring in preparation for the feature in 4736
@rjsf/utils:GlobalFormOptions, refactoring theexperimental_componentUpdateStrategyfromRegistryandidPrefix&idSeparatorfromFieldPropsexperimental_componentUpdateStrategyprop inRegistrywithreadonly globalFormOptions?: GlobalFormOptionsFieldPropsto removeidPrefixandidSeparator@rjsf/core:Formto add theglobalFormOptionsto the registry if there are anyGlobalFormOptionsvalues providedArrayField,LayoutGridField,ObjectFieldandSchemaFieldto getidPrefix,idSeparatorfrom theregistry.globalFormOptions, no longer passing them onFieldPropsSchemaFieldto getexperimental_componentUpdateStrategyfrom theregistry.globalFormOptionsas wellSchemaFieldtests as needed@rjsf/daisyupdated the snapshotscustom-widget-fields.mdandv6.x upgrade guide.mdto document the refactor of theidPrefixandidSeparatorrefactorCHANGELOG.mdfile accordinglyChecklist
npx nx run-many --target=build --exclude=@rjsf/docs && npm run test:updateto update snapshots, if needed.