Adds onCancelPan optional prop and adds more calls to cancelPan #166
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
ibgreen
approved these changes
Dec 9, 2024
There was a problem hiding this comment.
The functionality seems solid, though from the perspective of a detached maintainer like myself I wish there was a bit more information added
- Docs - Perhaps start writing a "skeleton" doc page about how to implement edit modes and add a section about map panning cancellation.
- Tests - assume it is hard to create a test case for this? Trigger an event and make sure the prop callback is called?
| @@ -62,6 +62,10 @@ export class ExtendLineStringMode extends GeoJsonEditMode { | |||
|
|
|||
| const mapCoords = props.lastPointerMoveEvent && props.lastPointerMoveEvent.mapCoords; | |||
|
|
|||
| if (!mapCoords) { | |||
There was a problem hiding this comment.
Maybe a comment that explains when this happens?
| @@ -61,6 +62,10 @@ export class ExtrudeMode extends ModifyMode { | |||
| } | |||
|
|
|||
| handleStartDragging(event: StartDraggingEvent, props: ModeProps<FeatureCollection>) { | |||
| if (shouldCancelPan(event)) { | |||
There was a problem hiding this comment.
Does this need to be implemented by every mode? Could it be called by the framework before invoking handleStartDragging?
Do we need a mode writer's guide page in the docs that explains this?
| @@ -516,3 +516,7 @@ export function mapCoords( | |||
| }) | |||
| .filter(Boolean); | |||
| } | |||
|
|
|||
| export function shouldCancelPan(event: StartDraggingEvent) { | |||
There was a problem hiding this comment.
Some TSDoc here would be helpful explaining when to call and why this criteria is used.
Comment on lines
+159
to
+161
| if (this.props.onCancelPan) { | ||
| this.props.onCancelPan(); | ||
| } |
There was a problem hiding this comment.
Suggested change
| if (this.props.onCancelPan) { | |
| this.props.onCancelPan(); | |
| } | |
| this.props.onCancelPan?.(); |
Or make the default prop an empty function?
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.
Hello - thank you for building NebulaGL /
editable-layers, it is a fantastic library.This PR contains two small changes:
onCancelPanprop toeditable-layers, allowing developers to execute their own logic when NebulaGL determines a map panning operation should be cancelled. This enables the event to propagate to a host mapping framework.event.cancelPan()invocations for a variety ofEditModes, ensuringevent.cancelPanis being called at the appropriate time