Skip to content

Scope widget inspector overlay to the selected widget's modal route#186784

Merged
auto-submit[bot] merged 9 commits into
flutter:masterfrom
muhammadkamel:fix/widget-inspector-overlay
Jun 12, 2026
Merged

Scope widget inspector overlay to the selected widget's modal route#186784
auto-submit[bot] merged 9 commits into
flutter:masterfrom
muhammadkamel:fix/widget-inspector-overlay

Conversation

@muhammadkamel

Copy link
Copy Markdown
Contributor

When a widget inside a modal route (bottom sheet, dialog, etc.) is selected in the widget inspector, the on-device overlay (selection box, layout guide lines, and tooltip) was drawn across the entire screen, including over the scaffold behind the modal. That made inspection misleading while a modal was open.

This PR scopes inspector overlay behavior to the selected widget’s modal route:

  • _inspectAt: filters hit-test selection.candidates to the active modal route scope (prefers the current route when present; otherwise uses the smallest-area hit’s route; excludes offstage routes).
  • _InspectorOverlayLayer: skips drawing overlay candidates that do not share the selected render object’s ModalRoute.
  • InspectorSelection.clearOverlayCandidates(): clears stale candidates when selection is updated via tools (setSelection), without clearing current / currentElement.

Before: selecting a sheet widget could show guide lines over main-screen widgets behind the sheet.

After: overlay candidates and painted guides stay within the modal route scope. Manual verification: examples/inspector_overlay_repro (optional reviewer aid).

No DevTools changes are required; the overlay is painted in widget_inspector.dart.

Fixes #186782

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

If this change needs to override an active code freeze, provide a comment explaining why. The code freeze workflow can be overridden by code reviewers. See pinned issues for any active code freezes with guidance.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

@github-actions github-actions Bot added a: text input Entering text in a text field or keyboard related problems framework flutter/packages/flutter repository. See also f: labels. labels May 20, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request refactors the text selection overlay handle logic and improves the widget inspector's selection mechanism. Key changes include calculating selection handle types directly in _updateSelectionOverlay, adding a clearOverlayCandidates method to InspectorSelection, and implementing modal route-based filtering for inspector hit candidates. New tests verify selection handle directionality and inspector selection behavior. A reviewer identified a potential issue in the inspector's route-finding logic where the root-most route is incorrectly prioritized over the leaf-most route in nested navigator scenarios, and provided a code suggestion to fix this by returning the first (leaf-most) current route found.

Comment thread packages/flutter/lib/src/widgets/widget_inspector.dart Outdated
…for selection candidates and implementing clearOverlayCandidates method. Update tests to verify that current selections are preserved and candidates are filtered based on active modal routes.
@muhammadkamel muhammadkamel force-pushed the fix/widget-inspector-overlay branch from 9ae29bb to 9488bd8 Compare May 20, 2026 04:45
@github-actions github-actions Bot removed the a: text input Entering text in a text field or keyboard related problems label May 20, 2026
Return the first isCurrent route from hit candidates instead of the
last, so widgets inside a nested navigator are not filtered out when
both outer and inner routes are current.
@muhammadkamel

Copy link
Copy Markdown
Contributor Author

Hi @kenzieschmoll
Appreciate your review here.

@Piinks Piinks requested a review from elliette May 26, 2026 23:28
@elliette elliette added the CICD Run CI/CD label May 27, 2026

@elliette elliette left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple suggestions but looks good! Thanks for the contribution

Comment thread packages/flutter/lib/src/widgets/widget_inspector.dart Outdated
@github-actions github-actions Bot removed the CICD Run CI/CD label May 27, 2026
@muhammadkamel

Copy link
Copy Markdown
Contributor Author

A couple suggestions but looks good! Thanks for the contribution

Could you please check now

Comment thread packages/flutter/lib/src/widgets/widget_inspector.dart Outdated
Comment thread packages/flutter/lib/src/widgets/widget_inspector.dart Outdated
Comment thread packages/flutter/test/widgets/widget_inspector_test.dart Outdated
Comment thread packages/flutter/test/widgets/widget_inspector_test.dart Outdated
@elliette

Copy link
Copy Markdown
Member

Adding @kenzieschmoll and @srawlins as reviewers for DevTools

@elliette elliette added the CICD Run CI/CD label May 28, 2026
@github-actions github-actions Bot removed the CICD Run CI/CD label May 31, 2026
- Rename clearOverlayCandidates -> clearCandidates and update call sites
- Drop Inspector from helper names (_elementForRenderObject,
  _modalRouteForRenderObject) and reuse _elementForRenderObject in the
  current setter
- Inline single-use _inspectorRenderObjectsShareModalRouteScope helper
- Pass null builders in scoping tests where they are unused
kenzieschmoll
kenzieschmoll previously approved these changes Jun 1, 2026
elliette
elliette previously approved these changes Jun 2, 2026
@elliette elliette added the CICD Run CI/CD label Jun 2, 2026
@github-actions github-actions Bot removed the CICD Run CI/CD label Jun 3, 2026
@muhammadkamel muhammadkamel requested a review from elliette June 3, 2026 00:52
@srawlins srawlins requested a review from bkonyi June 3, 2026 15:39
@elliette

elliette commented Jun 9, 2026

Copy link
Copy Markdown
Member

Gentle ping to @kenzieschmoll @srawlins @bkonyi - this PR needs another review to land. Thanks!

@kenzieschmoll

Copy link
Copy Markdown
Member

Looks like the branch needs to be merged with main again. LGTM.

@bkonyi bkonyi added the CICD Run CI/CD label Jun 10, 2026
@elliette elliette added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 12, 2026
@auto-submit auto-submit Bot added this pull request to the merge queue Jun 12, 2026
Merged via the queue into flutter:master with commit d3bf7f7 Jun 12, 2026
94 checks passed
@flutter-dashboard flutter-dashboard Bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jun 12, 2026
auto-submit Bot pushed a commit to flutter/packages that referenced this pull request Jun 15, 2026
Roll Flutter from b7cb925419e6 to 5827d5fd2b8d (35 revisions)

flutter/flutter@b7cb925...5827d5f

2026-06-15 engine-flutter-autoroll@skia.org Roll Skia from 7128af60575a to c8d9f80f13e4 (1 revision) (flutter/flutter#188015)
2026-06-15 jason-simmons@users.noreply.github.com In the APNG decoder, validate the chunk data length before calling GetChunkSize to avoid potential overflow in the chunk size calculation (flutter/flutter#187949)
2026-06-15 engine-flutter-autoroll@skia.org Roll Skia from 6b4ac3bfb39d to 7128af60575a (1 revision) (flutter/flutter#188011)
2026-06-15 engine-flutter-autoroll@skia.org Roll Skia from 0a3b8549cbf0 to 6b4ac3bfb39d (7 revisions) (flutter/flutter#188007)
2026-06-15 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[a11y] Map some framework semantics roles to android classes.  (#185217)" (flutter/flutter#188008)
2026-06-15 chris@bracken.jp [ios] Filter UIScene events to those relating to Flutter VC scene (flutter/flutter#187987)
2026-06-15 jhy03261997@gmail.com [a11y] Map some framework semantics roles to android classes.  (flutter/flutter#185217)
2026-06-15 engine-flutter-autoroll@skia.org Roll Skia from f46928e7f50c to 0a3b8549cbf0 (1 revision) (flutter/flutter#188004)
2026-06-14 stuartmorgan@google.com Rework docs for flutter/packages changelogs (flutter/flutter#187666)
2026-06-14 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from nvzMQAmuRSzo7-wAP... to TbB86Po_HDe1dvXvT... (flutter/flutter#187997)
2026-06-14 engine-flutter-autoroll@skia.org Roll Skia from 4e2c9b5e4dad to f46928e7f50c (1 revision) (flutter/flutter#187996)
2026-06-14 engine-flutter-autoroll@skia.org Roll Skia from c52667607242 to 4e2c9b5e4dad (1 revision) (flutter/flutter#187990)
2026-06-14 737941+loic-sharma@users.noreply.github.com Improve RenderTargetCache docs (flutter/flutter#187893)
2026-06-13 brackenavaron@gmail.com [Test cross_imports] Check cross imports in flutter_test/** (flutter/flutter#187587)
2026-06-13 matt.kosarek@canonical.com Fixing corrupted window size OnEmptyFrameGenerated due to transpsed width/height (flutter/flutter#187954)
2026-06-13 engine-flutter-autoroll@skia.org Roll Skia from 42355271a335 to c52667607242 (2 revisions) (flutter/flutter#187979)
2026-06-13 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from A3eaUn9mQ_EkSNxVI... to nvzMQAmuRSzo7-wAP... (flutter/flutter#187975)
2026-06-13 engine-flutter-autoroll@skia.org Roll Skia from 9ef46390c2d1 to 42355271a335 (1 revision) (flutter/flutter#187974)
2026-06-13 bdero@google.com [Flutter GPU] Make ShaderLibrary.fromAsset asynchronous (flutter/flutter#187716)
2026-06-13 engine-flutter-autoroll@skia.org Roll Skia from 8c89bf2b0ee3 to 9ef46390c2d1 (6 revisions) (flutter/flutter#187968)
2026-06-12 bdero@google.com [Flutter GPU] Add surface API for framework presentation (flutter/flutter#187358)
2026-06-12 bkonyi@google.com [gen_l10n] Exclude inherited keys from untranslated-messages-file (flutter/flutter#187950)
2026-06-12 31859944+LongCatIsLooong@users.noreply.github.com Update `MediaQueryData` docs for devicePixelRatio overriding (flutter/flutter#187542)
2026-06-12 bdero@google.com [Impeller] Fix dirty-range race in DeviceBufferGLES uploads (flutter/flutter#187932)
2026-06-12 pascal@phntm.xyz Compare isModifiedAfter against the given time (flutter/flutter#187727)
2026-06-12 planetmarshall@users.noreply.github.com Enable unit tests for compilation of compute shaders on non-metal backends (flutter/flutter#179683)
2026-06-12 matt.boetger@gmail.com [flutter_tools] Add doctor validator warning for multiple adb installations (flutter/flutter#186031)
2026-06-12 matt.boetger@gmail.com Optimize SHA hash calculation of generated APK (flutter/flutter#187184)
2026-06-12 mu7ammadkamel@hotmail.com Scope widget inspector overlay to the selected widget's modal route (flutter/flutter#186784)
2026-06-12 30870216+gaaclarke@users.noreply.github.com Switches Windows to OpenGLESSDF (flutter/flutter#187877)
2026-06-12 matt.boetger@gmail.com [integration_test] Update README to support modern Kotlin-based setups by default (flutter/flutter#186080)
2026-06-12 jason-simmons@users.noreply.github.com Convert the PNG signature constant in APNGImageGenerator to a std::array and use it in the APNG tests (flutter/flutter#187930)
2026-06-12 matt.boetger@gmail.com Correct backoff retry time cap unit and add regression tests (flutter/flutter#187250)
2026-06-12 chingjun@google.com Fix std::vector out-of-bounds access in Flutter Android JNI and Delegate (flutter/flutter#187218)
2026-06-12 matt.boetger@gmail.com [Android] Adding 30-second timeouts to adb stopApp and uninstallApp (flutter/flutter#187876)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC bmparr@google.com,stuartmorgan@google.com on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622
...
via-guy pushed a commit to via-guy/flutter that referenced this pull request Jun 26, 2026
…lutter#186784)

When a widget inside a **modal route** (bottom sheet, dialog, etc.) is
selected in the widget inspector, the on-device overlay (selection box,
layout guide lines, and tooltip) was drawn across the **entire screen**,
including over the scaffold behind the modal. That made inspection
misleading while a modal was open.

This PR scopes inspector overlay behavior to the selected widget’s
**modal route**:

- **`_inspectAt`**: filters hit-test `selection.candidates` to the
active modal route scope (prefers the current route when present;
otherwise uses the smallest-area hit’s route; excludes offstage routes).
- **`_InspectorOverlayLayer`**: skips drawing overlay candidates that do
not share the selected render object’s `ModalRoute`.
- **`InspectorSelection.clearOverlayCandidates()`**: clears stale
candidates when selection is updated via tools (`setSelection`), without
clearing `current` / `currentElement`.

**Before:** selecting a sheet widget could show guide lines over
main-screen widgets behind the sheet.

**After:** overlay candidates and painted guides stay within the modal
route scope. Manual verification: `examples/inspector_overlay_repro`
(optional reviewer aid).

No DevTools changes are required; the overlay is painted in
`widget_inspector.dart`.

Fixes flutter#186782

## Pre-launch Checklist

- [ ] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [ ] I read the [AI contribution guidelines] and understand my
responsibilities, or I am not using AI tools.
- [ ] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [ ] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [ ] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [ ] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [ ] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [ ] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel
on [Discord].

If this change needs to override an active code freeze, provide a
comment explaining why. The code freeze workflow can be overridden by
code reviewers. See pinned issues for any active code freezes with
guidance.

**Note**: The Flutter team is currently trialing the use of [Gemini Code
Assist for
GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code).
Comments from the `gemini-code-assist` bot should not be taken as
authoritative feedback from the Flutter team. If you find its comments
useful you can update your code accordingly, but if you are unsure or
disagree with the feedback, please feel free to wait for a Flutter team
member's review for guidance on which automated comments should be
addressed.

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[AI contribution guidelines]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CICD Run CI/CD framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Widget inspector overlay draws across routes when selecting widgets inside a modal route

4 participants