fix!: change paste to return the pasted thing to support keyboard nav #5996
Conversation
This file contains hidden or 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
gonfunko
approved these changes
Mar 15, 2022
Contributor
gonfunko
left a comment
gonfunko
left a comment
There was a problem hiding this comment.
This looks good to me; I like the general approach and tend to agree it seems unlikely the API change would be problematic. Probably worth checking with the rest of the team to confirm folks are good with it though before submitting.
core/clipboard.js
Outdated
| /** | ||
| * Paste a block or workspace comment on to the main workspace. | ||
| * @return {boolean} True if the paste was successful, false otherwise. | ||
| * @return {!BlockSvg|!WorkspaceCommentSvg|null} The pasted thing if the paste |
Contributor
There was a problem hiding this comment.
This would probably be cleaner and more future-proof if you used ICopyable as the return type like in duplicate(). Probably want to do this in workspace_svg as well.
This was referenced Apr 6, 2022
This was referenced Apr 19, 2022
This was referenced Apr 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 basics
The details
Resolves
Work on RaspberryPiFoundation/blockly-samples#833
Proposed Changes
Changes the paste functions on the clipboard and the workspace to return the pasted thing (block or workspace comment).
Reason for Changes
Keyboard nav needs to grab the pasted thing to then move it to the correct spot. This gives keyboard nav a simple and safe API for doing so.
Test Coverage
N/A
Documentation
N/A
Additional Information
I'm not sure if this is the thing we want to do or not, because it is a breaking change for anyone using
clipboard.paste(thing) === true. I just thought posting a PR would be the best way to discuss.(Personally I think this is the best API, but totally willing to change it for backwards compat reasons)