This library started as a basic bridge of the native iOS image picker, and I want to keep it that way. As such, functionality beyond what the native UIImagePickerController
supports will not be supported here. Multiple image selection, more control over the crop tool, and landscape support are things missing from the native iOS functionality - not issues with my library. If you need these things, react-native-image-crop-picker might be a better choice for you.
A React Native module that allows you to use native UI to select a photo/video from the device library or directly from the camera, like so:
iOS | Android |
---|---|
npm install react-native-image-picker@latest --save
Use rnpm to automatically complete the installation, or link manually like so:
- In the XCode's "Project navigator", right click on your project's Libraries folder ➜
Add Files to <...>
- Go to
node_modules
➜react-native-image-picker
➜ios
➜ selectRNImagePicker.xcodeproj
- Add
RNImagePicker.a
toBuild Phases -> Link Binary With Libraries
- Compile and have fun
// file: android/settings.gradle
...
include ':react-native-image-picker'
project(':react-native-image-picker').projectDir = new File(settingsDir, '../node_modules/react-native-image-picker/android')
// file: android/app/build.gradle
...
dependencies {
...
compile project(':react-native-image-picker')
}
<!-- file: android/app/src/main/AndroidManifest.xml -->
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.myApp">
<uses-permission android:name="android.permission.INTERNET" />
<!-- add following permissions -->
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-feature android:name="android.hardware.camera" android:required="false"/>
<uses-feature android:name="android.hardware.camera.autofocus" android:required="false"/>
<!-- -->
...
// file: android/app/src/main/java/com/<...>/MainApplication.java
...
import com.imagepicker.ImagePickerPackage; // <-- add this import
public class MainApplication extends Application implements ReactApplication {
@Override
protected List<ReactPackage> getPackages() {
return Arrays.<ReactPackage>asList(
new MainReactPackage(),
new ImagePickerPackage() // <-- add this line
);
}
...
}
var Platform = require('react-native').Platform;
var ImagePicker = require('react-native-image-picker');
// More info on all the options is below in the README...just some common use cases shown here
var options = {
title: 'Select Avatar',
customButtons: [
{name: 'fb', title: 'Choose Photo from Facebook'},
],
storageOptions: {
skipBackup: true,
path: 'images'
}
};
/**
* The first arg is the options object for customization (it can also be null or omitted for default options),
* The second arg is the callback which sends object: response (more info below in README)
*/
ImagePicker.showImagePicker(options, (response) => {
console.log('Response = ', response);
if (response.didCancel) {
console.log('User cancelled image picker');
}
else if (response.error) {
console.log('ImagePicker Error: ', response.error);
}
else if (response.customButton) {
console.log('User tapped custom button: ', response.customButton);
}
else {
// You can display the image using either data...
const source = {uri: 'data:image/jpeg;base64,' + response.data, isStatic: true};
// or a reference to the platform specific asset location
if (Platform.OS === 'ios') {
const source = {uri: response.uri.replace('file://', ''), isStatic: true};
} else {
const source = {uri: response.uri, isStatic: true};
}
this.setState({
avatarSource: source
});
}
});
Then later, if you want to display this image in your render() method:
<Image source={this.state.avatarSource} style={styles.uploadAvatar} />
To Launch the Camera or Image Library directly (skipping the alert dialog) you can do the following:
// Launch Camera:
ImagePicker.launchCamera(options, (response) => {
// Same code as in above section!
});
// Open Image Library:
ImagePicker.launchImageLibrary(options, (response) => {
// Same code as in above section!
});
On iOS, don't assume that the absolute uri returned will persist. See #107
option | iOS | Android | Info |
---|---|---|---|
title | OK | OK | Specify null or empty string to remove the title |
cancelButtonTitle | OK | OK | |
takePhotoButtonTitle | OK | OK | Specify null or empty string to remove this button |
chooseFromLibraryButtonTitle | OK | OK | Specify null or empty string to remove this button |
customButtons | OK | OK | An array containing objects with the name and title of buttons |
cameraType | OK | - | 'front' or 'back' |
mediaType | OK | OK | 'photo', 'video', or 'mixed' on iOS, 'photo' or 'video' on Android |
maxWidth | OK | OK | Photos only |
maxHeight | OK | OK | Photos only |
quality | OK | OK | 0 to 1, photos only |
videoQuality | OK | OK | 'low', 'medium', or 'high' on iOS, 'low' or 'high' on Android |
durationLimit | OK | OK | Max video recording time, in seconds |
rotation | - | OK | Photos only, 0 to 360 degrees of rotation |
allowsEditing | OK | - | bool - enables built in iOS functionality to resize the image after selection |
noData | OK | OK | If true, disables the base64 data field from being generated (greatly improves performance on large photos) |
storageOptions | OK | OK | If this key is provided, the image will get saved in the Documents directory on iOS, and the Pictures directory on Android (rather than a temporary directory) |
storageOptions.skipBackup | OK | - | If true, the photo will NOT be backed up to iCloud |
storageOptions.path | OK | - | If set, will save image at /Documents/[path] rather than the root |
storageOptions.cameraRoll | OK | - | If true, the cropped photo will be saved to the iOS Camera roll. |
key | iOS | Android | Description |
---|---|---|---|
didCancel | OK | OK | Informs you if the user cancelled the process |
error | OK | OK | Contains an error message, if there is one |
data | OK | OK | The base64 encoded image data (photos only) |
uri | OK | OK | The uri to the local file asset on the device (photo or video) |
origURL | OK | - | The URL of the original asset in photo library, if it exists |
isVertical | OK | OK | Will be true if the image is vertically oriented |
width | OK | OK | Image dimensions |
height | OK | OK | Image dimensions |
fileSize | OK | OK | The file size (photos only) |
type | - | OK | The file type (photos only) |
fileName | - | OK | The file name (photos only) |
path | - | OK | The file path |
latitude | - | OK | Latitude metadata, if available |
longitude | - | OK | Longitude metadata, if available |
timestamp | - | OK | Timestamp metadata, if available, in ISO8601 UTC format |