OverlayConfig class
Overlay behavior config attached to a rendered vnode.
This is used by the DOM patcher/runtime to handle dismiss behavior, focus management, and scroll locking in a consistent way.
Constructors
- OverlayConfig({required String id, String? anchorId, OverlaySide side = OverlaySide.bottom, OverlayAlign align = OverlayAlign.center, double offset = 8, bool dismissOnEscape = true, bool dismissOnOutsideTap = true, bool trapFocus = true, bool lockScroll = true, void onDismiss()?})
-
const
Properties
- align → OverlayAlign
-
Alignment relative to the anchor bounding box.
final
- anchorId → String?
-
ID of the anchor element for dynamic positioning.
final
- dismissOnEscape → bool
-
Whether pressing Escape dismisses this overlay.
final
- dismissOnOutsideTap → bool
-
Whether clicking outside content dismisses this overlay.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
Stable overlay identifier for stack management.
final
- lockScroll → bool
-
Whether body scrolling is disabled while this overlay is active.
final
- offset → double
-
Gap offset from the anchor.
final
- onDismiss → void Function()?
-
Dismiss callback used by runtime handlers.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- side → OverlaySide
-
Side of anchor to position against.
final
- trapFocus → bool
-
Whether keyboard tab focus is trapped inside this overlay.
final
Methods
-
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