Skip to content

Commit f3c84ce

Browse files
authored
Added some documentation for OverlayPortal (#138934)
Fixes: #138836 Adds some comments to OverlayPortal to clarify its behavior.
1 parent 66935a8 commit f3c84ce

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

packages/flutter/lib/src/widgets/overlay.dart

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1474,7 +1474,9 @@ class OverlayPortalController {
14741474
/// widget can depend on.
14751475
///
14761476
/// This widget requires an [Overlay] ancestor in the widget tree when its
1477-
/// overlay child is showing.
1477+
/// overlay child is showing. The overlay child is rendered by the [Overlay]
1478+
/// ancestor, not by the widget itself. This allows the overlay child to float
1479+
/// above other widgets, independent of its position in the widget tree.
14781480
///
14791481
/// When [OverlayPortalController.hide] is called, the widget built using
14801482
/// [overlayChildBuilder] will be removed from the widget tree the next time the

0 commit comments

Comments
 (0)