feat: add suppressInternalGestures flag to disable built-in input#10
Draft
F1orian wants to merge 1 commit into
Draft
feat: add suppressInternalGestures flag to disable built-in input#10F1orian wants to merge 1 commit into
F1orian wants to merge 1 commit into
Conversation
Adds an explicit `suppressInternalGestures` bool to CanvasKit. When true, the widget builds no internal pan/pinch GestureDetector and ignores pointer-signal (mouse-wheel) zoom, regardless of interactionMode or gestureOverlayBuilder. This replaces the implicit idiom of passing an empty `gestureOverlayBuilder: (_, _) => SizedBox.shrink()` purely to suppress the library's own gestures when the embedding app owns all input from a sibling layer stacked above CanvasKit. Backward compatible: defaults to false, and the previous programmatic+overlay suppression still applies. Also adds the package's first test/ directory (suppress_internal_gestures_test.dart) covering both the control (pans by default) and suppressed (no camera movement) paths. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Owner
|
noticed.. will not get time before the weekend to check your PRs, thx :) |
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
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
Adds an explicit
bool suppressInternalGestures(defaultfalse) toCanvasKit. Whentrue, the widget builds no internal pan/pinchGestureDetectorand ignores pointer-signal (mouse-wheel) zoom — regardless ofinteractionModeorgestureOverlayBuilder.Why
Today the only way to fully suppress canvas_kit's own input handling is to be in
programmaticmode and pass a non-nullgestureOverlayBuilder. But apps that own all input from their own gesture layer — stacked as a sibling aboveCanvasKitso it can hit-test in world space and win pointers over the items — don't actually want canvas_kit'sgestureOverlayBuilder, because that builder's result is composited below the item children (it can't host a layer that must hit-test above tiles).So those apps currently pass an empty
gestureOverlayBuilder: (_, _) => SizedBox.shrink()purely to flip the internal switch. That's a non-obvious idiom — a builder's mere presence silently changes gesture behavior, with no compile-time or runtime signal of intent.This flag makes "the embedding app owns all input" explicit and self-documenting, and decouples it from "I'm supplying an overlay."
Behavior / compatibility
false→ no change for existing callers.programmatic+ non-nullgestureOverlayBuilder) still applies, so existing code keeps working unchanged.GestureDetectorand theonPointerSignalwheel-zoom are gated on the same computed condition.Tests
Adds the package's first
test/directory (suppress_internal_gestures_test.dart):CanvasKitpans on drag (proves the harness drives the gesture, so the assertion below isn't vacuous);suppressInternalGestures: true, the library does not move the camera on drag.Notes
The diff is intentionally minimal and additive: one field, one constructor parameter, and two one-line gate changes in
build(). Happy to adjust the name (suppressInternalGesturesvs. e.g.handleInput: false) to match your preference.