🗻 Resize local images with React Native

Go to file

William Candillon d762433fe8 Create index.d.ts (#64 )		2017-01-30 14:06:30 +01:00
android	Add support for base64 formatted Uri strings on Android. (#47 )	2016-09-22 08:18:06 +02:00
example	Upgrade the example to react-native 0.31	2016-08-21 21:40:20 +02:00
ios	Support react-native > 0.40	2017-01-15 22:58:02 +01:00
.gitignore	Add iOS implementation	2015-12-02 22:53:06 +01:00
.npmignore	Add example to npmignore (#18 )	2016-06-30 19:08:05 +02:00
LICENSE	Add LICENSE	2015-12-02 23:10:16 +01:00
README.md	Add note to README explaining `file:` prefix (#62 )	2017-01-20 19:33:23 +01:00
index.android.js	Add outputPath to options (#16 )	2016-06-30 19:07:42 +02:00
index.d.ts	Create index.d.ts (#64 )	2017-01-30 14:06:30 +01:00
index.ios.js	Add basic support for rotation on iOS (#46 )	2016-09-20 17:08:27 +02:00
package.json	chore(version): Bump version	2017-01-15 22:58:02 +01:00
react-native-image-resizer.podspec	Add podspec file (#52 )	2016-10-14 21:37:45 +02:00

README.md

React Native Image Resizer

A React Native module that can create scaled versions of local images (also supports the assets library on iOS).

Setup

Install the package:

😻 React Native >= 0.40

npm install --save react-native-image-resizer
react-native link react-native-image-resizer

👨 React Native >= 0.29.2 and < 0.40

npm install --save react-native-image-resizer@0.0.12
react-native link react-native-image-resizer

👴 React Native < 0.29.2

npm install rnpm -g
rnpm install react-native-image-resizer@0.0.12

Android

Note: on latest versions of React Native, you may have an error during the Gradle build on Android (com.android.dex.DexException: Multiple dex files define Landroid/support/v7/appcompat/R$anim). Run cd android && ./gradlew clean to fix this.

Usage example

import ImageResizer from 'react-native-image-resizer';

ImageResizer.createResizedImage(imageUri, newWidth, newHeight, compressFormat, quality, rotation, outputPath).then((resizedImageUri) => {
  // resizeImageUri is the URI of the new image that can now be displayed, uploaded...
}).catch((err) => {
  // Oops, something went wrong. Check that the filename is correct and
  // inspect err to get more details.
});

Sample app

A basic, sample app is available in the example folder. It uses the module to resize a photo from the Camera Roll.

API

`promise createResizedImage(path, maxWidth, maxHeight, compressFormat, quality, rotation = 0, outputPath)`

The promise resolves with a string containing the URI of the new file. This URI can be used directly as the source of an <Image> component.

⚠️ On Android, file: will be prepended to the returned string. This allows it to be displayed as an image, but it also means you won't be able to access the file directly when using a utility like fs. To do so, you can simply use rawPath = originalPath.replace('file:', '') to get the raw path.

Option	Description
path	Path of image file, or a base64 encoded image string prefixed with 'data:image/imagetype' where `imagetype` is jpeg or png.
maxWidth	Image max width (ratio is preserved)
maxHeight	Image max height (ratio is preserved)
compressFormat	Can be either JPEG, PNG or WEBP (android only).
quality	A number between 0 and 100. Used for the JPEG compression.
rotation	Rotation to apply to the image, in degrees, for android. On iOS, rotation is limited (and rounded) to multiples of 90 degrees.
outputPath	The resized image path. If null, resized image will be stored in cache folder. To set outputPath make sure to add option for rotation too (if no rotation is needed, just set it to 0).