npm.io
0.4.2 • Published 6 years ago

react-native-image-converter

Licence
MIT
Version
0.4.2
Deps
0
Size
37 kB
Vulns
0
Weekly
0
Stars
5

react-native-image-converter

A React-native module it can modify an image by simply.

supported features.

  • resize
  • quality
  • grayscale
  • base64 encoding

latest version

  • 0.4.1

install

  • React Native >= 0.60
yarn add react-native-image-converter
cd ios && pod install
  • React Native <= 0.59
yarn add react-native-image-converter
react-native link react-native-image-converter
  • add to yarn package.json
"dependencies": {
    "react-native-image-converter": "^0.4.1"
}

usage

import IImageConverter from 'react-native-image-converter'
...
const param = {
        path: uri,
        grayscale: false, // or true
        base64: false, // or true
        resizeRatio: 0.8, // 1.0 is origin value
        imageQuality: 0.7 // 1.0 is max quality value
      }

const { success, errorMsg, imageURI, base64String } = await IImageConverter.convert(param)

request param

path - required value
  • type : string
  • description : The absolute path of the local file. (URI)
grayscale - optional value (default value is false)
  • type : boolean
  • description : If you want to make to grayscale, set true.
base64 - optional value (default value is false)
  • type : boolean
  • description : If you want to get image data by base64 encoding, set true.
resizeRatio - optional value (default value is 1.0)
  • type : float
  • description : Image resize ratio, between 0.1 to 1.0.
imageQuality - optional value (default value is 1.0)
  • type : float
  • description : Image quality, between 0.1 to 1.0.

response value

success
  • type : boolean
  • description : success(true) or failure(false).
errorMsg
  • type : string
  • description : the message of errors.
imageURI
  • type : string
  • description : The absolute path of the edited file. (URI)
base64String
  • type : string
  • description : base64 encoded text data.

setting the module to the project.

ios
  • In the Xcode, in the project navigator and right click Libraries -> Add Files to your project name
  • Go to node_modules -> react-native-image-converter and add RNImageConverter.xcodeproj
  • In the Xcode, in the project navigator and select your project. Add libRNImageConverter.a to your project's Build Phases -> Link Binary With Libraries
  • Build & run your project
android
  • Open android/app/src/main/java/your project name/MainApplication.java

  • Add import me.phoboslabs.RNImageConverterPackage; to the imports line

  • Add new RNImageConverterPackage() to the list of the getPackages() method

  • Insert to the android/settings.gradle

    include ':react-native-image-converter'
    project(':react-native-image-converter').projectDir = new File(rootProject.projectDir,     '../node_modules/react-native-image-converter/android')
  • Insert the line of dependencies block in android/app/build.gradle

    compile project(':react-native-image-converter')

License

react-native-image-converter is belongs to the project Illuminati, and distributed MIT license.