[Form lib] Add "updateFieldValues" to the form hook API #130544
Merged
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
sebelga
added
enhancement
|
Pinging @elastic/platform-deployment-management (Team:Deployment Management) |
sebelga
commented
Apr 19, 2022
|
|
||
| // Create an internal hook field which behaves like any other form field except that it is not | ||
| // outputed in the form data (when calling form.submit() or form.getFormData()) | ||
| // This allow us to run custom validations (passed to the props) on the Array items | ||
|
|
||
| const internalFieldPath = useMemo(() => `${path}__${uuid.v4()}`, [path]); |
There was a problem hiding this comment.
We need a predictable field name to be able to update the field values in updateFieldValues()
sebelga
commented
Apr 19, 2022
| }); | ||
| }); | ||
|
|
||
| test('should be updated with the UseField "defaultValue" prop', () => { |
There was a problem hiding this comment.
This test is not related to the new API change but I realised it was missing so I added it 😊
sebelga
commented
Apr 19, 2022
| @@ -578,16 +659,6 @@ export function useForm<T extends FormData = FormData, I extends FormData = T>( | |||
| // ---------------------------------- | |||
| // -- EFFECTS | |||
| // ---------------------------------- | |||
|
|
|||
| useEffect(() => { | |||
There was a problem hiding this comment.
That was a bug. We don't want the defaultValue internal ref to be updated when the defaultValue option changes
const { form } = useForm({
defaultValue: {
... // this object will always be a new reference when the component re-renders
}
});
yuliacech
reviewed
Apr 19, 2022
| @@ -653,4 +689,321 @@ describe('useForm() hook', () => { | |||
| expect(errors).toEqual(['Field1 can not be empty', 'Field2 is invalid']); | |||
| }); | |||
| }); | |||
|
|
|||
| describe('form.updateFieldValues()', () => { | |||
| test('should update field values and discard unknwon fields provided', async () => { | |||
There was a problem hiding this comment.
typo
Suggested change
| test('should update field values and discard unknwon fields provided', async () => { | |
| test('should update field values and discard unknown fields provided', async () => { |
|
Thanks for the review @yuliacech ! |
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.
Fixes #128458
Summary
This PR adds a new
form.updateFieldValues()handler to update multiple field values at once. See the linked issue for context.How to test
The changes in this PR are included in the current storybook (draft) work (#127898). You can pull that branch locally and start storybook as indicated in the PR description.
In Storybook, navigate to the "UseArray > Dynamic data" story.