Added some documentation for OverlayPortal (#138934)

Fixes: #138836 Adds some comments to OverlayPortal to clarify its behavior.
engine-flutter-autoroll · Nov 28, 2023 · f3c84ce · f3c84ce
1 parent 66935a8
commit f3c84ce
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/packages/flutter/lib/src/widgets/overlay.dart b/packages/flutter/lib/src/widgets/overlay.dart
@@ -1474,7 +1474,9 @@ class OverlayPortalController {
 /// widget can depend on.
 ///
 /// This widget requires an [Overlay] ancestor in the widget tree when its
-/// overlay child is showing.
+/// overlay child is showing. The overlay child is rendered by the [Overlay]
+/// ancestor, not by the widget itself. This allows the overlay child to float
+/// above other widgets, independent of its position in the widget tree.
 ///
 /// When [OverlayPortalController.hide] is called, the widget built using
 /// [overlayChildBuilder] will be removed from the widget tree the next time the