feat: add constrained movement #384
Merged
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
maribethb
approved these changes
Apr 3, 2025
src/keyboard_drag_strategy.ts
Outdated
| /** | ||
| * Returns the next compatible connection in keyboard navigation order, | ||
| * based on the input direction. | ||
| * Always resumes the search at the last |
Collaborator
There was a problem hiding this comment.
nit: this comment is cut off
| private getConstrainedConnectionCandidate( | ||
| draggingBlock: BlockSvg, | ||
| ): ConnectionCandidate | null { | ||
| const cursor = draggingBlock.workspace.getCursor() as LineCursor; |
Collaborator
There was a problem hiding this comment.
even when line cursor is the default in core, we'll still let people have other types right? can you leave a comment or something to remind us that we'll need to adjust this logic as well
Collaborator
Author
There was a problem hiding this comment.
Added a todo and filed an issue.
src/keyboard_drag_strategy.ts
Outdated
| localConns.forEach((conn: RenderedConnection) => { | ||
| const potentialLocation = | ||
| potential?.getLocation() as RenderedConnection; | ||
| if (connectionChecker.canConnect(conn, potentialLocation, true, 5000)) { |
Collaborator
There was a problem hiding this comment.
is the 5000 here just a really big number? what about Infinity?
Collaborator
Author
There was a problem hiding this comment.
Good point. I forgot Infinity exists. Changed.
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.
Fixes #364
This PR adds constrained movement by selectively extending and overriding parts of the drag strategy. In particular:
searchNodeproperty, which is where a constrained search should start traversing the tree.currCandidateIsBetterto always return false for a constrained drag. That is, the new candidate is always preferred.getConnectionCandidateto callgetConstrainedConnectionCandidateif the movement was constrained.getConstrainedConnectionCandidateimplements the following algorithm:searchNode.Additional information
This does not position the dragging block near the connection (tracked in #370). I'm still figuring out how to do that without causing very weird jumps--I have to push information backwards through the dragging pipeline.
This does not loop from the last block in the workspace to the first, or vice versa (tracked in #369).
When you switch from unconstrained to constrained dragging, the traversal will always resume at the last valid connection that was tried. This may lead to unexpected jumps.
If you use the arrow keys to constrained move off the edge of the workspace, it will not scroll to keep it in view (tracked in #371). The drag will continue and end appropriately on an escape or enter.
I'm accessing a lot of private properties. Every
@ts-expect-erroris a sign of an API problem we need to sort out.