Skip to content
No description, website, or topics provided.
Java JavaScript Objective-C Python Ruby
Branch: master
Clone or download
Latest commit 64004bb Jul 18, 2019

README.md

react-native-image-editor

Image Editor Native module for React Native. This module was extracted from React-Native core in the "Lean Core" process.

Build Status Version MIT License PRs Welcome

Getting started

Install

yarn add @react-native-community/image-editor

or

npm install @react-native-community/image-editor --save

Link

react-native link @react-native-community/image-editor

Usage

Start by importing the library:

import ImageEditor from "@react-native-community/image-editor";

Crop image

Crop the image specified by the URI param. If URI points to a remote image, it will be downloaded automatically. If the image cannot be loaded/downloaded, the promise will be rejected.

If the cropping process is successful, the resultant cropped image will be stored in the cache path, and the URI returned in the promise will point to the image in the cache path. Remember to delete the cropped image from the cache path when you are done with it.

  ImageEditor.cropImage(uri, cropData).then(url => {
    console.log("Cropped image uri", url);
  })

cropData

Property Required Description
offset Yes The top-left corner of the cropped image, specified in the original image's coordinate space
size Yes Size (dimensions) of the cropped image
displaySize No Size to which you want to scale the cropped image
resizeMode No Resizing mode to use when scaling the image (iOS only, android resize mode is always 'cover') Default value: 'contain'
  cropData = {
    offset: {x: number, y: number},
    size: {width: number, height: number},
    displaySize: {width: number, height: number},
    resizeMode: 'contain' | 'cover' | 'stretch',
  };

For more advanced usage check our example app.

You can’t perform that action at this time.