Gesture-based image zoom library for enhanced image viewing with features like double-click scaling, rotation, subsampling, and Exif orientation. Supports multiple image loaders and scroll bars.
ZoomImage
Translations: 简体中文
ZoomImage is an gesture zoom viewing of images library specially designed for Compose Multiplatform and Android View. It has the following features and functions:
https://github.com/panpf/zoomimage/assets/3250512/f067bed9-24e4-4ab8-a839-0731e155f4ef
Published to mavenCentral
${LAST_VERSION}: (Not included 'v')
Compose multiplatform:
// Provides the SketchZoomAsyncImage component adapted to the Sketch v4+ image loader (recommended)
implementation()
implementation()
implementation()
implementation()
implementation()
implementation()
[!TIP] Just choose one according to the image loader you use or your needs.
Only android compose:
// Provides the GlideZoomAsyncImage component adapted to the Glide image loader
implementation("io.github.lucchetto.zoomimage:zoomimage-compose-glide:${LAST_VERSION}")
[!TIP] Why is there no picasso version of the compose ZoomImage component? Because Picasso has officially stated that it will not provide support for compose (Original post here)
Android view:
[!TIP] Just choose one according to the image loader you use or your needs.
ZoomImage's own obfuscation is already included in aar, but you may also need to add obfuscation configuration for other libraries that depend indirectly
Compose multiplatform:
// Use basic ZoomImage components
val zoomState: ZoomState by rememberZoomState()
LaunchedEffect(zoomState.subsampling) {
val resUri = Res.getUri("files/huge_world.jpeg")
val imageSource = ImageSource.fromComposeResource(resUri)
zoomState.setSubsamplingImage(imageSource)
}
ZoomImage(
painter = painterResource(Res.drawable.huge_world_thumbnail),
contentDescription = "view image",
modifier = Modifier.fillMaxSize(),
zoomState = zoomState,
)
SketchZoomAsyncImage(
uri = ,
contentDescription = ,
modifier = Modifier.fillMaxSize(),
)
CoilZoomAsyncImage(
model = ,
contentDescription = ,
modifier = Modifier.fillMaxSize(),
)
[!TIP] The usage of SketchZoomAsyncImage and CoilZoomAsyncImage is the same as their original AsyncImage, except that there is an additional
zoomState: ZoomStateparameter
Only android compose:
// Use GlideZoomAsyncImage component
GlideZoomAsyncImage(
model = "https://sample.com/sample.jpeg",
contentDescription = "view image",
modifier = Modifier.fillMaxSize(),
)
[!TIP] The usage of GlideZoomAsyncImage is the same as its original GlideImage, except that there is an additional
zoomState: ZoomStateparameter
Android view:
// Use basis ZoomImageView component
val zoomImageView = ZoomImageView(context)
zoomImageView.setImageResource(R.drawable.huge_world_thumbnail)
zoomImageView.setSubsamplingImage(ImageSource.fromResource(R.raw.huge_world))
// Use SketchZoomAsyncImage component
val sketchZoomImageView = SketchZoomImageView(context)
sketchZoomImageView.loadImage()
coilZoomImageView = CoilZoomImageView(context)
sketchZoomImageView.loadImage()
glideZoomImageView = GlideZoomImageView(context)
Glide.with()
.load()
.into(glideZoomImageView)
picassoZoomImageView = PicassoZoomImageView(context)
picassoZoomImageView.loadImage()
You can find the sample code in the examples directory, or you can go to release page download App experience
Please review the CHANGELOG file
Prepare the environment:
Kotlin Multiplatform and Compose Multiplatform IDE SupportpluginsRun the sample app:
The following are my other open source projects. If you are interested, you can learn about them:
Apache 2.0. See the LICENSE file for details.
Compose Multiplatform. Support for Compose Multiplatform, which can be used on Android, macOS,
Windows, Linux and other platformsPower. Supports basic functions such as double-click scale, two-finger scale, single-finger
scale, mouse wheel scale, keyboard scale, single-finger drag, inertial sliding, and keyboard drag.Locate. Support for locate anywhere in the image and keeping it in the center of the screenRotate. Supports 0°, 90°, 180°, 270°, 360° rotation of picturesSubsampling. Support for subsampling of very large images to avoid OOM, tile support animation,
and sharpness gradientsDynamic scale factor. Automatically calculates the most appropriate double-click scaling factor
based on image size and container sizeScaling damping. When manually scaled beyond the maximum or minimum scale factor, there is a
damped rubber band effectScroll bar. Supports displaying horizontal and vertical scroll bars to clarify the current
scroll positionRead Mode. When a long image is displayed in reading mode, the initial state automatically fills
the screen, and the user can immediately start reading the image content, eliminating the need for
the user to double-click to scale inExif. Support reading Exif Orientation information and automatically rotating imagesImage Loader. Provide support for image loaders such as sketch, coil, glide, picasso, etc., and
can also customize support for more image loaders| Function/Platform | Android | iOS | Desktop | Web |
|---|
| Zoom | ✅ | ✅ | ✅ | ✅ |
| Subsampling | ✅ | ✅ | ✅ | ✅ |
| Exif Orientation | ✅ | ✅ | ✅ | ✅ |
| Integrated Sketch | ✅ | ✅ | ✅ | ✅ |
| Integrated Coil | ✅ | ✅ | ✅ | ✅ |
| Integrated Glide | ✅ | ❌ | ❌ | ❌ |
| Integrated Picasso | ✅ | ❌ | ❌ | ❌ |
./package_desktop.sh// Provides the SketchZoomImageView component adapted to the Sketch v4+ image loader (recommended)
implementation("io.github.lucchetto.zoomimage:zoomimage-view-sketch4:${LAST_VERSION}")
// Provides SketchZoomImageView component adapted to the old Sketch v3 image loader
implementation("io.github.lucchetto.zoomimage:zoomimage-view-sketch3:${LAST_VERSION}")
// Provides the CoilZoomImageView component adapted to the Coil v3+ image loader
implementation("io.github.lucchetto.zoomimage:zoomimage-view-coil3:${LAST_VERSION}")
// Provides CoilZoomImageView component adapted to the old Coil v2 image loader
implementation("io.github.lucchetto.zoomimage:zoomimage-view-coil2:${LAST_VERSION}")
// Provides the GlideZoomImageView component adapted to the Glide image loader
implementation("io.github.lucchetto.zoomimage:zoomimage-view-glide:${LAST_VERSION}")
// Provides the PicassoZoomImageView component adapted to the Picasso image loader
implementation("io.github.lucchetto.zoomimage:zoomimage-view-picasso:${LAST_VERSION}")
// Provides the most basic ZoomImageView component. Additional work needs to be done to support subsampling. Network images are not supported.
implementation("io.github.lucchetto.zoomimage:zoomimage-view:${LAST_VERSION}")
.run directory. After
synchronization is completed, directly select the running configuration of the corresponding
platform in the running configuration drop-down box at the top of Android Studio and click Run..run/iosSample.run.template.xml file and remove the .template suffix.
The .ignore file has been configured to ignore iosSample.run.xmlEdit Configurations in the run configuration drop-down box at the top,
select iosSample and then configure Execute targetSurfaced from shared tags and platforms — no rankings paid for.