custom_zoom_widget

Description:

custom zoom widget

A custom zoom widget which can be used in a scrollable screen's to properly maintain the zooming of an image.
Features #
Let's your app show zoomable images in an user friendly way.
It's a container of an uncliped interactive viewer that let's the user zoom the image occupying the entire screen.
Once you release the screen and stop the pinch interaction the image/widget will come back to it's original size in an smooth animation.
Getting started #
Add the dependency to your pubspec.yaml:
custom_zoom_widget: ^0.0.1
copied to clipboard
Usage #

CustomZoomWidget(
child: Image.network(
'https://storage.googleapis.com/cms-storage-bucket/70760bf1e88b184bb1bc.png'
),
)
copied to clipboard
Additional information #
This package also support some extra params that may be useful depending on what are you trying to achieve
CustomZoomWidget(
child: Image.network('https://storage.googleapis.com/cms-storage-bucket/70760bf1e88b184bb1bc.png'),
minScale: 0.8,
maxScale: 4,
resetDuration: const Duration(milliseconds: 200),
boundaryMargin: const EdgeInsets.only(bottom: 0),
clipBehavior: Clip.none,
useOverlay: true,
maxOverlayOpacity: 0.5,
overlayColor: Colors.black,
fingersRequiredToPinch: 2
)
copied to clipboard
Making it work well inside a scroll #
The problem with making a pinch working inside a scroll is that the drag of a screen,
as a simple gesture that can be done with just one finger,
tends to override the more complex scale gesture that needs two fingers to work well,
the best way I found to overcome that challenge is to change the physics of the scroll to NeverScrollableScrollPhysics()
when the second finger touch the screen, that way the scroll stops to override the scale gesture and it's easy to interact with the interactive viewer.
Another consideration that you will need to have is that to avoid losing frames of the reset animation,
you need to delay the setState that will bring the scroll back to the parent widget
So the scroll build will look like this:
bool blockScroll = false;
ScrollController controller = ScrollController();

@override
Widget build(BuildContext context) {
return SingleChildScrollView(
controller: controller,
physics: blockScroll ? NeverScrollableScrollPhysics() : ScrollPhysics(),
copied to clipboard
And the PinchWidget will have this two extra parameters:
twoFingersOn: () => setState(() => blockScroll = true),
twoFingersOff: () => Future.delayed(
CustomZoomWidget.defaultResetDuration,
() => setState(() => blockScroll = false),
copied to clipboard
For a complete widget example check this one:
class TestSimpleScroll extends StatefulWidget {
const TestSimpleScroll({super.key});

@override
State<TestSimpleScroll> createState() => _TestSimpleScrollState();
}

class _TestSimpleScrollState extends State<TestSimpleScroll> {
bool blockScroll = false;
ScrollController controller = ScrollController();

@override
Widget build(BuildContext context) {
return SingleChildScrollView(
controller: controller,
physics: blockScroll ? NeverScrollableScrollPhysics() : ScrollPhysics(),
child: SizedBox(
width: MediaQuery.of(context).size.width,
child: Container(
padding: const EdgeInsets.all(20),
child: Column(
children: [
SizedBox(
width: 300,
height: 250,
child: CustomZoomWidget(
child: Image.network(
'https://www.animalfriends.co.uk/siteassets/media/images/article-images/cat-articles/38_afi_article1_caring-for-a-kitten-tips-for-the-first-month.png',
),
twoFingersOn: () => setState(() => blockScroll = true),
twoFingersOff: () => Future.delayed(
CustomZoomWidget.defaultResetDuration,
() => setState(() => blockScroll = false),
),
),
),
const SizedBox(
height: 5000,
)
],
),
),
),
);
}
}
copied to clipboard
Simulator test #
To test in a simulator add a fingersRequiredToPinch to pinch with a -1 to disable the requirement of two fingers to start an interaction
CustomZoomWidget(
child: Image.network('https://storage.googleapis.com/cms-storage-bucket/70760bf1e88b184bb1bc.png'),
fingersRequiredToPinch: -1
)
copied to clipboard
Like us on pub.dev #
Package url:
https://pub.dev/packages/custom_zoom_widget