Fix 3759 - uneditable & permanent defaults with additional properties #4490
+246
−27
Conversation
This file contains 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
Co-authored-by: Heath C <[email protected]>
heath-freenome
requested changes
Feb 21, 2025
| @@ -687,6 +699,7 @@ export default function getDefaultFormState< | |||
| theSchema: S, | |||
| formData?: T, | |||
| rootSchema?: S, | |||
| initialDefaultsGenerated?: boolean, | |||
There was a problem hiding this comment.
@Piotr-Debicki Unfortunately, unless you add it to the end of the function call, you are introducing a breaking change. This will need to be the LAST, optional, parameter to the function.
| @@ -111,13 +112,15 @@ class SchemaUtils<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends Fo | |||
| getDefaultFormState( | |||
| schema: S, | |||
| formData?: T, | |||
| initialDefaultsGenerated?: boolean, | |||
There was a problem hiding this comment.
@Piotr-Debicki Unfortunately, unless you add it to the end of the function call, you are introducing a breaking change. This will need to be the LAST, optional, parameter to the function.
| @@ -1082,6 +1083,7 @@ export interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchem | |||
| getDefaultFormState( | |||
| schema: S, | |||
| formData?: T, | |||
| initialDefaultsGenerated?: boolean, | |||
There was a problem hiding this comment.
@Piotr-Debicki Unfortunately, unless you add it to the end of the function call, you are introducing a breaking change. This will need to be the LAST, optional, parameter to the function.
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
Fixes #3759
Additional properties with defaults set currently creates a permanent key-value pair that is essentially uneditable.
Trying to edit the key creates an entirely new key value entry on blur while still keeping the default key-value pair. The default key-value pair is also not deletable. Solution here generates defaults for additional properties once on form initialization, and then skips regeneration on any form update
This solution works for root & nested additionalProperties (see tests)
Allows for 'reset' form to regenerate additionalProperties defaults
Also fixes the issue I mentioned in the Closed PR with custom formData not being applied when generating additionalProperties defaults
Checklist
npx nx run-many --target=build --exclude=@rjsf/docs && npm run test:updateto update snapshots, if needed.