fix: #2768 by returning id on the Form.onChange handler #3173
+665
−297
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
Fixed #2768 by improving the
onChange
callback onForm
to return theid
of the field experiencing the changeFieldProps
type foronChange
to add an optionalid: string
parameter, makingonChange
forFieldTemplateProps
useFieldProps
definitionid: string
, to theonChange()
prop onForm
as follows:Form.onChange()
callback handler passed to all fields to take an optional third parameter,id: string
, passing it out to theonChange()
prop callArrayField
to make the callback returned from theonChangeForIndex()
method take the additionalid
parameter and pass it along to theprops.onChange()
handlerMultiSchemaField
to make theonOptionChange()
method pass along thethis.getFieldId()
value to theprops.onChange()
handlerid
logic for the select widget used in theMultiSchemaField
into thegetFieldId()
methodObjectField
to make the callback returned from theonPropertyChange()
method take the additionalid
parameter and pass it along to theprops.onChange()
handlerSchemaField
to add a newhandleFieldComponentChange()
callback that ensures that anid
is passed up theonChange
callback chainFieldComponent
to pass thehandleFieldComponentChange()
as theonChange
handlerid
in those situations when it is passed back - In @rjsf/playground, updated theonFormDataChange
handler to log theid
of the changed field if it is provided - Updated theform-props.md
documentation to describe the newid
parameter that may be returned - UpdaonFormDataChange
handler to log theid
of the changed field if it is providedform-props.md
documentation to describe the newid
parameter that may be returnedCHANGELOG.md
accordinglyChecklist
npm run test:update
to update snapshots, if needed.