Unverified Commit bf0f4e6b authored by Michael Goderbauer's avatar Michael Goderbauer Committed by GitHub

Document defaults of GestureDetector.behavior and link to debugging options (#17785)

parent af764a51
...@@ -124,6 +124,11 @@ class GestureRecognizerFactoryWithHandlers<T extends GestureRecognizer> extends ...@@ -124,6 +124,11 @@ class GestureRecognizerFactoryWithHandlers<T extends GestureRecognizer> extends
/// ), /// ),
/// ) /// )
/// ``` /// ```
///
/// ## Debugging
///
/// To see how large the hit test box of a [GestureDetector] is for debugging
/// purposes, set [debugPaintPointersEnabled] to true.
class GestureDetector extends StatelessWidget { class GestureDetector extends StatelessWidget {
/// Creates a widget that detects gestures. /// Creates a widget that detects gestures.
/// ///
...@@ -286,6 +291,9 @@ class GestureDetector extends StatelessWidget { ...@@ -286,6 +291,9 @@ class GestureDetector extends StatelessWidget {
final GestureScaleEndCallback onScaleEnd; final GestureScaleEndCallback onScaleEnd;
/// How this gesture detector should behave during hit testing. /// How this gesture detector should behave during hit testing.
///
/// This defaults to [HitTestBehavior.deferToChild] if [child] is not null and
/// [HitTestBehavior.translucent] if child is null.
final HitTestBehavior behavior; final HitTestBehavior behavior;
/// Whether to exclude these gestures from the semantics tree. For /// Whether to exclude these gestures from the semantics tree. For
...@@ -477,6 +485,9 @@ class RawGestureDetector extends StatefulWidget { ...@@ -477,6 +485,9 @@ class RawGestureDetector extends StatefulWidget {
final Map<Type, GestureRecognizerFactory> gestures; final Map<Type, GestureRecognizerFactory> gestures;
/// How this gesture detector should behave during hit testing. /// How this gesture detector should behave during hit testing.
///
/// This defaults to [HitTestBehavior.deferToChild] if [child] is not null and
/// [HitTestBehavior.translucent] if child is null.
final HitTestBehavior behavior; final HitTestBehavior behavior;
/// Whether to exclude these gestures from the semantics tree. For /// Whether to exclude these gestures from the semantics tree. For
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment