🗻 Resize local images with React Native

Go to file

Umberto Lentini b92d8de42a Fix error reporting, path handling and extension naming on iOS (#90 ) * `saveFile` used to return always `YES`, now it returns whether or not the save has been saved. * `generateFilePath` didn’t do any check about the path. Now it creates the in the app directory. If for some reason it fails, it throws an Exception. * `saveFile` can handle png extension and path issues. A bug on a `nil` fileSize has been fixed.		2017-07-20 17:19:24 +02:00
android	Unify returned value between Android and iOS implementation, (#83 )	2017-07-18 23:05:26 +02:00
example	Fix example to work with the specified React Native version (#79 )	2017-05-09 00:02:58 +02:00
ios	Fix error reporting, path handling and extension naming on iOS (#90 )	2017-07-20 17:19:24 +02:00
.gitignore	Minor Android fixes for empty/failed return paths (#67 )	2017-02-10 11:21:55 +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	Unify returned value between Android and iOS implementation, (#83 )	2017-07-18 23:05:26 +02:00
index.android.js	Add outputPath to options (#16 )	2016-06-30 19:07:42 +02:00
index.d.ts	Unify returned value between Android and iOS implementation, (#83 )	2017-07-18 23:05:26 +02:00
index.ios.js	Unify returned value between Android and iOS implementation, (#83 )	2017-07-18 23:05:26 +02:00
package.json	chore(version): Bump version	2017-05-09 00:05:57 +02: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.28 and < 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((response) => {
  // response.uri is the URI of the new image that can now be displayed, uploaded...
  // response.path is the path of the new image
  // response.name is the name of the new image with the extension
  // response.size is the size of the new image
}).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 an object containing: path, uri, name and size of the new file. The URI can be used directly as the source of an <Image> component.

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).