react-native-image-compressor
v0.0.2
Published
A native image resizing & compression tool for iOS & Android.
Downloads
19
Maintainers
Readme
react-native-image-compressor
A simple image resizing and compression package, taking care of the resizing process on the native side. Supports iOS and Android out of the box.
Getting started
$ npm install react-native-image-compressor --save
$ yarn add react-native-image-compressor
Mostly automatic installation
$ react-native link react-native-image-compressor
Manual installation
iOS
- In XCode, in the project navigator, right click
Libraries
➜Add Files to [your project's name]
- Go to
node_modules
➜react-native-image-compressor
and addTRNReactNativeImageCompressor.xcodeproj
- In XCode, in the project navigator, select your project. Add
libTRNReactNativeImageCompressor.a
to your project'sBuild Phases
➜Link Binary With Libraries
- Run your project (
Cmd+R
)<
Android
- Open up
android/app/src/main/java/[...]/MainApplication.java
- Add
import com.imagecompressor.TRNReactNativeImageCompressorPackage;
to the imports at the top of the file - Add
new TRNReactNativeImageCompressorPackage()
to the list returned by thegetPackages()
method
- Append the following lines to
android/settings.gradle
:include ':react-native-image-compressor' project(':react-native-image-compressor').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-image-compressor/android')
- Insert the following lines inside the dependencies block in
android/app/build.gradle
:implementation project(':react-native-image-compressor')
Usage
import ImageCompressor from "react-native-image-compressor";
const result = await ImageCompressor.compress(
"file://bowling-alleys/the-dude.jpg",
{
maxWidth: 1000,
}
);
API
ImageCompressor
compress(value: string, options?: CompressorOptions): Promise<string>
Compresses the input file URI or base-64 string with the specified options. Promise returns a string after compression has completed. Resizing will always keep the original aspect ratio of the image, the
maxWidth
andmaxHeight
are used as a boundary.
CompressorOptions
maxWidth: number
(default: 1024)The maximum width boundary used as the main boundary in resizing a landscape image.
maxHeight: number
(default: 1024)The maximum height boundary used as the main boundary in resizing a portrait image.
quality: number
(default: 1.0)The quality modifier for the
JPEG
file format, can be specified when output isPNG
but will be ignored.input: InputType
(default: uri)Can be either
uri
orbase64
, defines the contentents of thevalue
parameter.output: OutputType
(default: jpg)Can be either
jpg
orpng
, defines the output image format.returnableOutputType: ReturnableOutputType
(default: uri)Can be either
uri
orbase64
, defines the Returnable output image format.