A Stack of entries that can be managed independently.

Overlays let independent child widgets "float" visual elements on top of other widgets by inserting them into the overlay's Stack. The overlay lets each of these widgets manage their participation in the overlay using OverlayEntry objects.

Although you can create an Overlay directly, it's most common to use the overlay created by the Navigator in a WidgetsApp or a MaterialApp. The navigator uses its overlay to manage the visual appearance of its routes.

See also:

Inheritance

Static Methods

of(BuildContext context, { Widget debugRequiredFor }) → OverlayState

The state from the closest instance of this class that encloses the given context.

Constructors

Overlay({Key key, List<OverlayEntry> initialEntries: const [] })

Creates an overlay.

Properties

initialEntries → List<OverlayEntry>

The entries to include in the overlay initially.

read-only
hashCode → int

Get a hash code for this object.

read-only, inherited
key → Key

Controls how one widget replaces another widget in the tree.

read-only, inherited
runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited

Operators

operator ==(other) → bool

The equality operator.

inherited

Methods

createState() → OverlayState

Creates the mutable state for this widget at a given location in the tree.

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited
debugFillDescription(List<String> description) → void

Add additional information to the given description for use by toString.

inherited
noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
toString() → String

Returns a string representation of this object.

inherited
toStringShort() → String

A short, textual description of this widget.

inherited