UITapGuard class

Prevents duplicate taps while an async onTap is running.

Pass the callback from builder to your button or ink well.

Inheritance

Constructors

UITapGuard({Key? key, required Widget builder(BuildContext context, Future<void> onTap()?), Future<void> onTap()?, Duration? cooldown, Widget waitBuilder(BuildContext context, Widget child)?})
const

Properties

builder Widget Function(BuildContext context, Future<void> onTap()?)
final
cooldown Duration?
Optional delay applied after onTap completes.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onTap Future<void> Function()?
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
waitBuilder Widget Function(BuildContext context, Widget child)?
Optional wrapper shown while the guarded action is running.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<UITapGuard>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

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

Constants

never → const Duration
Disables further taps after one successful invocation.