Unverified Commit f3c84ce2 authored by yim's avatar yim Committed by GitHub

Added some documentation for OverlayPortal (#138934)

Fixes: #138836 

Adds some comments to OverlayPortal to clarify its behavior.
parent 66935a82
...@@ -1474,7 +1474,9 @@ class OverlayPortalController { ...@@ -1474,7 +1474,9 @@ class OverlayPortalController {
/// widget can depend on. /// widget can depend on.
/// ///
/// This widget requires an [Overlay] ancestor in the widget tree when its /// 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 /// When [OverlayPortalController.hide] is called, the widget built using
/// [overlayChildBuilder] will be removed from the widget tree the next time the /// [overlayChildBuilder] will be removed from the widget tree the next time the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment