photoview-android

PhotoView: An Introduction

PhotoView is a powerful ImageView component for Android, designed to provide intuitive zooming capabilities through various touch gestures. Initially derived from Chris Banes' PhotoView, this project has been refined to stay in sync with the latest androidx library updates, fix bugs, improve features, and make distribution through Maven Central instead of Jitpack.

What is PhotoView?

PhotoView enhances the standard ImageView by enabling users to zoom into and out of images using natural gestures such as pinch-to-zoom and double-tap. This makes it an indispensable tool for any Android application that requires advanced image interaction.

Key Features

• Effortless Zooming: Users can zoom into and out of images using fluid multi-touch gestures.
• Smooth Scrolling: Provides a seamless experience with a fluid fling motion during navigation.
• Compatibility with Scrolling Containers: Works well within various scrolling views, such as ViewPager, offering a smooth experience.
• Matrix Change Notifications: Notifies the application of any changes in the displayed matrix, supporting UI adjustments to synchronize with zoom or scroll movements.
• User Interaction Notifications: Alerts the app when users interact with an image, enabling dynamic and responsive UI behaviors.

Getting Started

To integrate PhotoView into your Android project, add the following line to your module's build.gradle file:

dependencies {
    implementation("io.getstream:photoview:1.0.2")
}

Using PhotoView

PhotoView can be used like a regular ImageView in your XML layouts:

<io.getstream.photoview.PhotoView
    android:id="@+id/photoView"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:src="@drawable/wallpaper"/>

Compatibility with Image Loaders

When using third-party image loading libraries, such as Coil or Glide, loading images is straightforward:

Coil Example

val photoView = binding.photoView
photoView.load(IMAGE_URL) {
  crossfade(true)
}

Glide Example

val photoView = binding.photoView
Glide.with(this)
  .load(IMAGE_URL)
  .into(photoView)

PhotoView Dialog

PhotoView also offers a dialog feature to display collections of PhotoView images. To use this, add the following dependency:

dependencies {
    implementation("io.getstream:photoview-dialog:$version")
}

Then, employ the PhotoViewDialog component to display these images:

val imageUrls = listOf(
  // image URLs
)

val button = binding.button
button.setOnClickListener {
  PhotoViewDialog.Builder(context = this, images = imageUrls) { imageView, url ->
    Glide.with(this)
      .load(url)
      .into(imageView)
  }.build().show()
}

Contribution and Licensing

PhotoView is maintained by Stream and welcomes contributions from the community. Contributions can range from code improvements to documentation updates, following the project's Contributing Guideline.

The project is licensed under the Apache License, Version 2.0, allowing free use and distribution with certain conditions.

PhotoView stands out as a robust solution for integrating advanced image viewing interactions in Android applications, aiding developers in enhancing their app's user experience effortlessly. For more advanced video and audio functionalities, one might explore the Stream Video SDK for Compose.