Add ability to disable gestures (Solves #233) (#234)

bluefireteam · Aug 17, 2020 · 9adbf49 · 9adbf49
2 parents 89534ca + 6567f78
commit 9adbf49
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 13 deletions.
diff --git a/example/lib/screens/common/common_example_wrapper.dart b/example/lib/screens/common/common_example_wrapper.dart
@@ -11,6 +11,7 @@ class CommonExampleRouteWrapper extends StatelessWidget {
     this.initialScale,
     this.basePosition = Alignment.center,
     this.filterQuality = FilterQuality.none,
+    this.disableGestures,
   });
 
   final ImageProvider imageProvider;
@@ -21,6 +22,7 @@ class CommonExampleRouteWrapper extends StatelessWidget {
   final dynamic initialScale;
   final Alignment basePosition;
   final FilterQuality filterQuality;
+  final bool disableGestures;
 
   @override
   Widget build(BuildContext context) {
@@ -38,6 +40,7 @@ class CommonExampleRouteWrapper extends StatelessWidget {
           initialScale: initialScale,
           basePosition: basePosition,
           filterQuality: filterQuality,
+          disableGestures: disableGestures,
         ),
       ),
     );

diff --git a/example/lib/screens/examples/common_use_cases_examples.dart b/example/lib/screens/examples/common_use_cases_examples.dart
@@ -131,6 +131,20 @@ class CommonUseCasesExamples extends StatelessWidget {
               );
             },
           ),
+          ExampleButtonNode(
+            title: "No gesture ",
+            onPressed: () {
+              Navigator.push(
+                context,
+                MaterialPageRoute(
+                  builder: (context) => const CommonExampleRouteWrapper(
+                    imageProvider: const AssetImage("assets/large-image.jpg"),
+                    disableGestures: true,
+                  ),
+                ),
+              );
+            },
+          ),
         ],
       ),
     );

diff --git a/lib/photo_view.dart b/lib/photo_view.dart
@@ -258,6 +258,7 @@ class PhotoView extends StatefulWidget {
     this.gestureDetectorBehavior,
     this.tightMode,
     this.filterQuality,
+    this.disableGestures,
   })  : child = null,
         childSize = null,
         super(key: key);
@@ -289,6 +290,7 @@ class PhotoView extends StatefulWidget {
     this.gestureDetectorBehavior,
     this.tightMode,
     this.filterQuality,
+    this.disableGestures,
   })  : loadFailedChild = null,
         imageProvider = null,
         gaplessPlayback = false,
@@ -379,6 +381,10 @@ class PhotoView extends StatefulWidget {
   /// Quality levels for image filters.
   final FilterQuality filterQuality;
 
+  // Removes gesture detector if `true`.
+  // Useful when custom gesture detector is used in child widget.
+  final bool disableGestures;
+
   @override
   State<StatefulWidget> createState() {
     return _PhotoViewState();
@@ -552,6 +558,7 @@ class _PhotoViewState extends State<PhotoView> {
       gestureDetectorBehavior: widget.gestureDetectorBehavior,
       tightMode: widget.tightMode ?? false,
       filterQuality: widget.filterQuality ?? FilterQuality.none,
+      disableGestures: widget.disableGestures ?? false,
     );
   }
 
@@ -609,6 +616,7 @@ class _PhotoViewState extends State<PhotoView> {
       gestureDetectorBehavior: widget.gestureDetectorBehavior,
       tightMode: widget.tightMode ?? false,
       filterQuality: widget.filterQuality ?? FilterQuality.none,
+      disableGestures: widget.disableGestures ?? false,
     );
   }
 

diff --git a/lib/photo_view_gallery.dart b/lib/photo_view_gallery.dart
@@ -265,6 +265,7 @@ class _PhotoViewGalleryState extends State<PhotoViewGallery> {
             tightMode: pageOption.tightMode,
             filterQuality: pageOption.filterQuality,
             basePosition: pageOption.basePosition,
+            disableGestures: pageOption.disableGestures,
           )
         : PhotoView(
             key: ObjectKey(index),
@@ -289,6 +290,7 @@ class _PhotoViewGalleryState extends State<PhotoViewGallery> {
             tightMode: pageOption.tightMode,
             filterQuality: pageOption.filterQuality,
             basePosition: pageOption.basePosition,
+            disableGestures: pageOption.disableGestures,
           );
 
     return ClipRect(
@@ -326,11 +328,12 @@ class PhotoViewGalleryPageOptions {
     this.gestureDetectorBehavior,
     this.tightMode,
     this.filterQuality,
+    this.disableGestures,
   })  : child = null,
         childSize = null,
         assert(imageProvider != null);
 
-  PhotoViewGalleryPageOptions.customChild({
+  PhotoViewGalleryPageOptions.customChild( {
     @required this.child,
     this.childSize,
     this.heroAttributes,
@@ -346,6 +349,7 @@ class PhotoViewGalleryPageOptions {
     this.gestureDetectorBehavior,
     this.tightMode,
     this.filterQuality,
+    this.disableGestures,
   })  : imageProvider = null,
         assert(child != null);
 
@@ -394,6 +398,9 @@ class PhotoViewGalleryPageOptions {
   /// Mirror to [PhotoView.tightMode]
   final bool tightMode;
 
+  /// Mirror to [PhotoView.disableGestures]
+  final bool disableGestures;
+
   /// Quality levels for image filters.
   final FilterQuality filterQuality;
 }
diff --git a/lib/src/core/photo_view_core.dart b/lib/src/core/photo_view_core.dart
@@ -38,6 +38,7 @@ class PhotoViewCore extends StatefulWidget {
     @required this.basePosition,
     @required this.tightMode,
     @required this.filterQuality,
+    @required this.disableGestures,
   })  : customChild = null,
         super(key: key);
 
@@ -57,6 +58,7 @@ class PhotoViewCore extends StatefulWidget {
     @required this.basePosition,
     @required this.tightMode,
     @required this.filterQuality,
+    @required this.disableGestures,
   })  : imageProvider = null,
         gaplessPlayback = false,
         super(key: key);
@@ -79,6 +81,7 @@ class PhotoViewCore extends StatefulWidget {
 
   final HitTestBehavior gestureDetectorBehavior;
   final bool tightMode;
+  final bool disableGestures;
 
   final FilterQuality filterQuality;
 
@@ -312,20 +315,27 @@ class PhotoViewCoreState extends State<PhotoViewCore>
               ),
               child: _buildHero(),
             );
-            return PhotoViewGestureDetector(
-              child: Container(
-                constraints: widget.tightMode
-                    ? BoxConstraints.tight(scaleBoundaries.childSize * scale)
-                    : null,
-                child: Center(
-                  child: Transform(
-                    child: customChildLayout,
-                    transform: matrix,
-                    alignment: basePosition,
-                  ),
+
+            final child = Container(
+              constraints: widget.tightMode
+                  ? BoxConstraints.tight(scaleBoundaries.childSize * scale)
+                  : null,
+              child: Center(
+                child: Transform(
+                  child: customChildLayout,
+                  transform: matrix,
+                  alignment: basePosition,
                 ),
-                decoration: widget.backgroundDecoration ?? _defaultDecoration,
               ),
+              decoration: widget.backgroundDecoration ?? _defaultDecoration,
+            );
+
+            if (widget.disableGestures) {
+              return child;
+            }
+
+            return PhotoViewGestureDetector(
+              child: child,
               onDoubleTap: nextScaleState,
               onScaleStart: onScaleStart,
               onScaleUpdate: onScaleUpdate,