1.5.2 • Published 7 years ago

react-native-photo-view v1.5.2

Weekly downloads
533
License
MIT
Repository
github
Last release
7 years ago

react-native-photo-view

Provides custom Image view for React Native that allows to perform pinch-to-zoom on images. Works on both iOS and Android.

This component uses PhotoDraweeView for Android and MWPhotobrowser on iOS.

Usage

import PhotoView from 'react-native-photo-view';

Basics:

<PhotoView
  source={{uri: 'https://facebook.github.io/react/img/logo_og.png'}}
  minimumZoomScale={0.5}
  maximumZoomScale={3}
  androidScaleType="center"
  onLoad={() => console.log("Image loaded!")}
  style={{width: 300, height: 300}} />

Properties

PropertyTypeDescription
sourceObjectsame as source for other React images
loadingIndicatorSourceObjectsource for loading indicator
fadeDurationintduration of image fade (in ms)
minimumZoomScalefloatThe minimum allowed zoom scale. The default value is 1.0
maximumZoomScalefloatThe maximum allowed zoom scale. The default value is 3.0
showsHorizontalScrollIndicatorbooliOS only: When true, shows a horizontal scroll indicator. The default value is true.
showsVerticalScrollIndicatorbooliOS only: When true, shows a vertical scroll indicator. The default value is true.
scalefloatSet zoom scale programmatically
androidZoomTransitionDurationintAndroid only: Double-tap zoom transition duration
androidScaleTypeStringAndroid only: One of the default Android scale types: "center", "centerCrop", "centerInside", "fitCenter", "fitStart", "fitEnd", "fitXY"
onLoadStartfuncCallback function
onLoadfuncCallback function
onLoadEndfuncCallback function
onProgressfunciOS only: Callback function, invoked on download progress with {nativeEvent: {loaded, total}}.
onTapfuncCallback function (called on image tap)
onViewTapfuncCallback function (called on tap outside of image)
onScalefuncCallback function

Compared to react-native-image-zoom

react-native-image-zoom functionality is similar, but there are several major differencies:

  • PhotoView is based on PhotoDraweeView which is the "PhotoView For Fresco". It works better, it supports several important callbacks out-of-box and it is, actually, recommended by Chris Banes, because his PhotoView (base for react-native-image-zoom) doesn't completely support Facebook Fresco;
  • PhotoView has more options like fadeDuration and minimumZoomScale/maximumZoomScale and more important callbacks;
  • PhotoView is written in the same manner as default React Image, and it supports most of the features Image has (the goal is to be fully compaitable with Image and support absolutely everything);
  • It is possible to use PhotoView as a container (currently iOS only)!

Automatic installation

Just two simple steps:

npm install --save react-native-photo-view
rnpm link react-native-photo-view

Manual installation

  1. Add these lines to android/settings.gradle
include ':react-native-photo-view'
project(':react-native-photo-view').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-photo-view/android')
  1. Add one more dependency to android/app/build.gradle
dependencies {
    compile project(':react-native-photo-view')
}
  1. Add it to your MainActivity.java for RN < 0.29 and to your MainApplication.java for RN >=0.29

To register PhotoViewPackage, you need to change the MainActivity or MainApplication depending on React Native version of your app:

import com.reactnative.photoview.PhotoViewPackage;

// ...

public class MainActivity extends ReactActivity {
    // ...

    @Override
    protected List<ReactPackage> getPackages() {
      return Arrays.<ReactPackage>asList(
          new MainReactPackage(),
          new PhotoViewPackage() // add this manager
      );
    }

    // ...
}