HoldDetector class

A widget that detects a holding gesture.

If this widget has a child, it defers to that child for its sizing behavior. If it does not have a child, it grows to fit the parent instead.

It defaults to repeating an action every 300ms (customizable), but for now it always waits 300ms to start repeating the onHold callback.

See flutter.io/gestures/ for additional information.

Material design applications typically react to touches with ink splash effects. The InkWell class implements this effect and can be used in place or with a GestureDetector for handling taps.

The onTap override won't work when the child has a onPressed or similar property, so you might want to pass the same method before, like this:

HoldDetector(
  onHold: _incrementCounter,
  child: FloatingActionButton(
    child: Icon(Icons.add),
    onPressed: _incrementCounter,
  ),
)

This example makes the counter keep while holding the button:

HoldDetector(
  onHold: () {
    setState(() { _counter += 1; });
  },
  child: Text("$_counter"),
)
Inheritance

Constructors

HoldDetector({Key? key, GestureTapCallback? onTap, GestureHoldCancelCallback? onCancel, Duration? holdTimeout, HitTestBehavior behavior = HitTestBehavior.translucent, bool enableHapticFeedback = false, bool excludeFromSemantics = false, required GestureHoldCallback onHold, required Widget child})
const

Properties

behavior → HitTestBehavior
final
child → Widget
final
enableHapticFeedback → bool
final
excludeFromSemantics → bool
final
hashCode → int
The hash code for this object.
no setterinherited
holdTimeout → Duration?
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onCancel → GestureHoldCancelCallback?
final
onHold → GestureHoldCallback
final
onTap → GestureTapCallback?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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}) → 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