OverlayScope class

A component that registers its child with _OverlayScopeRegistry.

This component does not render anything itself but allows its child to be rendered in a different part of the DOM tree. It is used to scope overlays to a specific part of the application, allowing for better organization and management of overlays.

Example

OverlayScope(
  id: 'my-scope',
  child: MyComponent(),
);

Constructors

OverlayScope({Key? key, required Component child, required String id})

A component that registers its child with _OverlayScopeRegistry.

const

Properties

child → Component

final

hashCode → int

The hash code for this object.

no setter, inherited

id → String

final

key → Key?

Controls how one component replaces another component in the tree.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createElement() → Element

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

inherited

createState() → State<OverlayScope>

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited