firka/flutter
firka/flutter
5
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify Overlay.initialEntries. (#6701)

Browse Source 
Closes https://github.com/flutter/flutter/issues/6141
This commit is contained in:
Ian Hickson 2016-11-03 14:39:12 -07:00 committed by GitHub
parent 8a91c8bc59
commit b47b16f44a
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
packages/flutter/lib/src/widgets/overlay.dart
View File

@ -209,6 +209,18 @@ class Overlay extends StatefulWidget {
}
/// The entries to include in the overlay initially.
///
/// These entries are only used when the [OverlayState] is initialized. If you
/// are providing a new [Overlay] description for an overlay that's already in
/// the tree, then the new entries are ignored.
///
/// To add entries to an [Overlay] that is already in the tree, use
/// [Overlay.of] to obtain the [OverlayState] (or assign a [GlobalKey] to the
/// [Overlay] widget and obtain the [OverlayState] via
/// [GlobalKey.currentState]), and then use [OverlayState.add] or
/// [OverlayState.addAll].
///
/// To remove an entry from an [Overlay], use [OverlayEntry.remove].
final List<OverlayEntry> initialEntries;
/// The state from the closest instance of this class that encloses the given context.