Skip to content

Latest commit

 

History

History
124 lines (83 loc) · 6.38 KB

README.md

File metadata and controls

124 lines (83 loc) · 6.38 KB
Raw

React Native Image Picker

A React Native module that allows you to select a photo/video from the device library or camera.

Note: If you are still using deprecated version 2.x.x check this for documentation.

Migration from 2.x.x to 3.x.x

  • showImagePicker API is removed.
  • No permission required for default options on Android.
  • Removed and updated some values in options, so please check them carefully.

Install

yarn add react-native-image-picker

# RN >= 0.60
cd ios && pod install

# RN < 0.60
react-native link react-native-image-picker

Post-install Steps

iOS

Add the appropriate keys to your Info.plist,

If you are allowing user to select image/video from photos, add NSPhotoLibraryUsageDescription.

If you are allowing user to capture image add NSCameraUsageDescription key also.

If you are allowing user to capture video add NSCameraUsageDescription add NSMicrophoneUsageDescription key also.

Android

No permissions required (saveToPhotos requires permission check).

Note: This library does not require Manifest.permission.CAMERA, if your app declares as using this permission in manifest then you have to obtain the permission before using launchCamera.

API Reference

Methods

import {launchCamera, launchImageLibrary} from 'react-native-image-picker';

launchCamera()

Launch camera to take photo or video.

launchCamera(options?, callback);

See Options for further information on options.

The callback will be called with a response object, refer to The Response Object.

launchImageLibrary

Launch gallery to pick image or video.

launchImageLibrary(options?, callback)

See Options for further information on options.

The callback will be called with a response object, refer to The Response Object.

Options

Option iOS Android Description
mediaType OK OK 'photo' or 'video'
maxWidth OK OK To resize the image
maxHeight OK OK To resize the image
videoQuality OK OK 'low', 'medium', or 'high' on iOS, 'low' or 'high' on Android
durationLimit OK OK Video max duration in seconds
quality OK OK 0 to 1, photos
cameraType OK OK 'back' or 'front'. May not be supported in few android devices
includeBase64 OK OK If true, creates base64 string of the image (Avoid using on large image files due to performance)
saveToPhotos OK OK (Boolean) Only for launchCamera, saves the image/video file captured to public photo

The Response Object

key iOS Android Description
didCancel OK OK true if the user cancelled the process
errorCode OK OK Check ErrorCode for all error codes
errorMessage OK OK Description of the error, use it for debug purpose only
base64 OK OK The base64 string of the image (photos only)
uri OK OK The file uri in app specific cache storage. Except when picking video from Android gallery where you will get read only content uri, to get file uri in this case copy the file to app specific storage using any react-native library
width OK OK Image dimensions (photos only)
height OK OK Image dimensions (photos only)
fileSize OK OK The file size (photos only)
type OK OK The file type (photos only)
fileName OK OK The file name
duration OK OK The selected video duration in seconds

Note on file storage

Image/video captured via camera will be stored in temporary folder so will be deleted any time, so don't expect it to persist. Use saveToPhotos: true (default is false) to save the file in the public photos. saveToPhotos requires WRITE_EXTERNAL_STORAGE permission on Android 28 and below (You have to obtain the permission, the library does not).

ErrorCode

Code Description
camera_unavailable camera not available on device
permission Permission not satisfied
others other errors (check errorMessage for description)

License

MIT