react-native-uploader

A React Native module for uploading files and camera roll assets in Android and iOS. Supports progress notification.

Note

This module is a cover of https://github.com/g6ling/react-native-uploader. I cover it to make it suitable for my project. And I see it useful and share it.

Thanks to @g6ling for great module.

Install

Use rnpm

1. npm install https://github.com/tranquangvu/react-native-uploader.git --save
2. rnpm link react-native-uploader

If you don't want use rnpm, do this

iOS

• npm install https://github.com/tranquangvu/react-native-uploader.git --save
• In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
• Go to node_modules ➜ react-native-uploader ➜ ios and add RNUploader.xcodeproj
• In XCode, in the project navigator, select your project. Add libRNUploader.a to your project's Build Phases ➜ Link Binary With Libraries
• Run your project (Cmd+R)

Android

• Add to your android/settings.gradle:

include ':react-native-uploader'
project(':react-native-uploader').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-uploader/android')

• Add to your android/app/build.gradle:

dependencies {
  ...
  compile project(':react-native-uploader')
}

• Add to MainApplication.java

import com.burlap.filetransfer.FileTransferPackage;
...
private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) {
  ....
  @Override
  protected List<ReactPackage> getPackages() {
    return Arrays.<ReactPackage>asList(
      ...
      new FileTransferPackage()
    );
  }
}

Example

This is a simple demo for upload image. It can be run both Android and iOs. See it in https://github.com/tranquangvu/react-native-uploader-demo

Usage

var RNUploader = require('react-native-uploader');

var {
	StyleSheet, 
	Component,
	View,
	DeviceEventEmitter,
} = React;

componentDidMount(){
	// upload progress
	DeviceEventEmitter.addListener('RNUploaderProgress', (data)=>{
	  let bytesWritten = data.totalBytesWritten;
	  let bytesTotal   = data.totalBytesExpectedToWrite;
	  let progress     = data.progress;
	  
	  console.log( "upload progress: " + progress + "%");
	});
}

doUpload(){
	let files = [
		{
			name: 'file[]',
			filename: 'image1.png',
			filepath: 'assets-library://....',  // image from camera roll/assets library
			filetype: 'image/png',
		},
		{
			name: 'file[]',
			filename: 'image2.gif',
			filepath: "data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/XBs/fNwfjZ0frl3/zy7////wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAkAABAALAAAAAAQABAAAAVVICSOZGlCQAosJ6mu7fiyZeKqNKToQGDsM8hBADgUXoGAiqhSvp5QAnQKGIgUhwFUYLCVDFCrKUE1lBavAViFIDlTImbKC5Gm2hB0SlBCBMQiB0UjIQA7", // base64 only support ios
			filetype: 'image/gif',
		},
	];

	let opts = {
		url: 'http://my.server/api/upload',
		files: files, 
		method: 'POST',                             // optional: POST or PUT, only support ios, android always have POST
		headers: { 'Accept': 'application/json' },  // optional, only support ios, android always have  { 'Accept': 'application/json' }
		params: { 'user_id': 1 },                   // optional, Android support this only string. If you want this in Android use params: { 'user_id': '1' }
	};

	RNUploader.upload( opts, (err, response) => {
		if( err ){
			console.log(err);
			return;
		}
  
		let status = response.status;
		let responseString = response.data;
		let json = JSON.parse( responseString );

		console.log('upload complete with status ' + status);

		// android's response is response.body.string.
	});
}

API

RNUploader.upload( options, callback )

options is an object with values:

	type	required	description	example
url	string	required	URL to upload to	http://my.server/api/upload
method	string	optional	HTTP method, values: [PUT,POST], default: POST	POST
headers	object	optional	HTTP headers	{ 'Accept': 'application/json' }
params(iOS)	object	optional	Query parameters	{ 'user_id': 1 }
params(Android)	object	optional	Query parameters	{ 'user_id': '1' } only support string value. You can't use int, boolean, etc..
files	array	required	Array of file objects to upload. See below.	[{ name: 'file', filename: 'image1.png', filepath: 'assets-library://...', filetype: 'image/png' } ]

callback is a method with two parameters:

	type	description	example
error	string	String detailing the error	A server with the specified hostname could not be found.
response(iOS)	object{status:Number, data:String}	Object returned with a status code and data.	{ status: 200, data: '{ success: true }' }
response(Android)	String	String returned with responseBody.	success: true

files

files is an array of objects with values:

	type	required	description	example
name	string	optional	Form parameter key for the specified file. If missing, will use filename.	file[]
filename	string	required	filename	image1.png
filepath	string	required	File URI Supports assets-library:, data: and file: URIs and file paths.	assets-library://...(iOS) content://...(Android) data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOV...(only iOS) file:/tmp/image1.png /tmp/image1.png
filetype	string	optional	MIME type of file. If missing, will infer based on the extension in filepath.	image/png

Progress (only support iOS)

To monitor upload progress simply subscribe to the RNUploaderProgress event using DeviceEventEmitter.

DeviceEventEmitter.addListener('RNUploaderProgress', (data)=>{
  let bytesWritten = data.totalBytesWritten;
  let bytesTotal   = data.totalBytesExpectedToWrite;
  let progress     = data.progress;
  
  console.log( "upload progress: " + progress + "%");
});

Cancel (only support iOS)

To cancel an upload in progress:

RNUploader.cancel()

Notes

Inspired by similiar projects:

• https://github.com/booxood/react-native-file-upload
• https://github.com/kamilkp/react-native-file-transfer

...with noteable enhancements:

• uploads are performed asynchronously on the native side
• progress reporting
• packaged as a static library
• support for multiple files at a time
• support for files from the assets library, base64 data: or file: paths
• no external dependencies (ie: AFNetworking)
• support Android

License

MIT