post empty images array with user hits escape #4325
Draft
+11
−0
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
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.
What does this change?
Adds an "key down" event listener to the document to post a message event to the parent window (IE, if the Grid is being used in an iframe, the window that has the iframe) representing an empty array of images when the user hits the "Escape" key.
The intent is to allow the Grid to communicate the event to the parent application in a way consistent with the messages posted to communicate the user selecting or creating one of more crops - there are currently different formats for data representing one crop (object with
imageandcropfields) and multiple crops (object withimagesfield, which is an array of those objects ) - the "Escape" key event equates to "0x image crops selected".Did consider haveing the parent application attach the listener, but because the parent application is not necessarily on the same domain as the Grid, it won't always be possible to for it to listen to event on the grid iframe's content window:
https://developer.mozilla.org/en-US/docs/Web/API/HTMLIFrameElement/contentWindow#description
issues
Some controls in the Grid use the escape key - if a user was using them within the Iframe and hit escape, it should only close the control, not the whole window. May need to look a way to check the UI state before emitting the 'close' event
How should a reviewer test this change?
There should be no effect when the Grid is running in its own window the message will be posted, when the escape key is pressed, but not listened to.
TO DO - testing plan for embedding applications:
How can success be measured?
Embedding applications can react to the escape key when the Grid Iframe has focussed (usually by closing the dialog)
Who should look at this?
Tested? Documented?