Fix: Unfocus YAML Editor on file change #4775
Merged
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.
The Codemirror editor currently ignores updates that happen while the Editor is focused. This is partly a symptom of our invalidation/refetching approach where an update triggered via keystroke from within the editor is eventually received by the editor again via a prop update. Changing that behavior is an ongoing discussion. Because of that conditional, a focused editor would not update its content even when the underlying file being displayed changed.
This PR adds a
key
prop to theYAMLEditor
that unfocuses the editor whenever the prop changes, allowing the conditional check to pass. Implementing it this way, as opposed to wrapping uses of the component in akey
block, ensures the logic is documented/captured with the component.