IgnorePointer class

A widget that is invisible during hit testing.

When ignoring is true, this widget (and its subtree) is invisible to hit testing. It still consumes space during layout and paints its child as usual. It just cannot be the target of located events, because it returns false from RenderBox.hitTest.

The following sample has an IgnorePointer widget wrapping the Column which contains a button. When ignoring is set to true anything inside the Column can not be tapped. When ignoring is set to false anything inside the Column can be tapped.

To create a local project with this code sample, run:
flutter create --sample=widgets.IgnorePointer.1 mysample


Using this class may also affect how the semantics subtree underneath is collected.

If ignoring is true, pointer-related SemanticsActions are removed from the semantics subtree. Otherwise, the subtree remains untouched.

The usages of ignoringSemantics are deprecated and not recommended. This property was introduced to workaround the semantics behavior of the IgnorePointer and its friends before v3.8.0-12.0.pre.

Before that version, entire semantics subtree is dropped if ignoring is true. Developers can only use ignoringSemantics to preserver the semantics subtrees.

After that version, with ignoring set to true, it only prevents semantics user actions in the semantics subtree but leaves the other SemanticsProperties intact. Therefore, the ignoringSemantics is no longer needed.

If ignoringSemantics is true, the semantics subtree is dropped. Therefore, the subtree will be invisible to assistive technologies.

If ignoringSemantics is false, the semantics subtree is collected as usual.

See also:

  • AbsorbPointer, which also prevents its children from receiving pointer events but is itself visible to hit testing.
  • SliverIgnorePointer, the sliver version of this widget.


IgnorePointer({Key? key, bool ignoring = true, @Deprecated('Use ExcludeSemantics or create a custom ignore pointer widget instead. ' 'This feature was deprecated after v3.8.0-12.0.pre.') bool? ignoringSemantics, Widget? child})
Creates a widget that is invisible to hit testing.


child Widget?
The widget below this widget in the tree.
hashCode int
The hash code for this object.
no setterinherited
ignoring bool
Whether this widget is ignored during hit testing.
ignoringSemantics bool?
Whether the semantics of this widget is ignored when compiling the semantics subtree.
key Key?
Controls how one widget replaces another widget in the tree.
runtimeType Type
A representation of the runtime type of the object.
no setterinherited


createElement() SingleChildRenderObjectElement
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
createRenderObject(BuildContext context) RenderIgnorePointer
Creates an instance of the RenderObject class that this RenderObjectWidget represents, using the configuration described by this RenderObjectWidget.
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
didUnmountRenderObject(covariant RenderObject renderObject) → void
A render object previously associated with this widget has been removed from the tree. The given RenderObject will be of the same type as returned by this object's createRenderObject.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
toStringShort() String
A short, textual description of this widget.
updateRenderObject(BuildContext context, covariant RenderIgnorePointer renderObject) → void
Copies the configuration described by this RenderObjectWidget to the given RenderObject, which will be of the same type as returned by this object's createRenderObject.


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