IgnorePointer class

A widget that is invisible to hit-testing.

When ignoring is true (the default), the widget's subtree cannot receive mouse events via hit-testing. In a Stack, this causes events to fall through to siblings painted below.

This is useful for overlays (e.g., DebugOverlay) that should be visible but not block mouse interaction with the content underneath.

Stack(
  children: [
    interactiveContent,
    IgnorePointer(
      child: Align(
        alignment: Alignment.topRight,
        child: overlayWidget,
      ),
    ),
  ],
)
Inheritance

Constructors

IgnorePointer({Widget? child, bool ignoring = true, Key? key})

Properties

accessibilityLabel → String?
Optional accessibility label.
no setterinherited
accessibilityRole → String
Optional accessibility role.
no setterinherited
child → Widget?
finalinherited
children → List<Widget>
Child widgets that receive forwarded messages.
no setterinherited
debugRenderObjectPassthrough → bool
Whether this widget is intentionally transparent to render-object layouts.
no setterinherited
degradationSignal → WidgetDegradationSignal
Signal that controls this widget's render budget behavior.
no setterinherited
focusable → bool
Whether this widget can receive keyboard focus.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String
Unique identifier for this widget.
no setterinherited
ignoring → bool
Whether this widget is invisible to hit-testing.
final
key → Key?
Key for preserving widget identity.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
theme → Theme
Access the current theme.
no setterinherited

Methods

buildCachedView<T>(T builder(), Object? cacheKey) → T
Returns a cached view if the cache key matches.
inherited
createRenderObject() → RenderObject
didUnmountRenderObject(RenderObject renderObject) → void
inherited
handleInit() → Cmd?
Override this instead of init for widget-specific initialization.
inherited
handleIntercept(Msg msg) → (Widget, Cmd?)
Override this to handle messages before they reach children.
inherited
handleUpdate(Msg msg) → (Widget, Cmd?)
Override this to handle messages specific to this widget.
inherited
init() → Cmd?
Called once when the widget is first mounted.
inherited
invalidateCachedView() → void
Clears any cached view for this widget.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
shouldRenderAt(DegradationLevel degradationLevel, {required bool subtreeHasFocusedWidget}) → bool
Whether this widget should participate in the current render when degradationLevel is active.
inherited
toString() → String
A string representation of this object.
inherited
update(Msg msg) → (Model, Cmd?)
Handles messages by forwarding to children then calling handleUpdate.
inherited
updateRenderObject(RenderObject renderObject) → void
view() → Object
Renders the widget to a string or View.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited