Giter Club home page Giter Club logo

react-native-image-editor's Introduction

react-native-image-editor

Image Editor Native module for React Native.

Build Status MIT License PRs Welcome Lean Core Badge

Getting started

Install

yarn add @react-native-community/image-editor
# or
npm install @react-native-community/image-editor --save

Install Pods

npx pod-install

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);
  // In case of Web, the `url` is the base64 string
});

cropData: ImageCropData

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', Web - no support) Default value: 'contain'
quality No The quality of the resulting image, expressed as a value from 0.0 to 1.0.
The value 0.0 represents the maximum compression (or lowest quality) while the value 1.0 represents the least compression (or best quality).
iOS supports only JPEG format, while Android/Web supports both JPEG, WEBP and PNG formats.
Default value: (iOS: 1), (Android: 0.9)
format No (WEB ONLY) The format of the resulting image, possible values are jpeg, png, webp, Default value: jpeg
cropData: ImageCropData = {
  offset: {x: number, y: number},
  size: {width: number, height: number},
  displaySize: {width: number, height: number},
  resizeMode: 'contain' | 'cover' | 'stretch',
  quality: number, // 0...1
  format: 'jpeg' | 'png' | 'webp' // web only
};

For more advanced usage check our example app.

react-native-image-editor's People

Contributors

aaronechiu avatar bestander avatar chenfadafb avatar cpojer avatar davidaurelio avatar dratwas avatar evanbacon avatar faifai21 avatar gre avatar guhungry avatar hramos avatar javache avatar jayu avatar mateusz1913 avatar naturalclar avatar nicklockwood avatar philikon avatar retyui avatar rubennorte avatar shcheuk avatar shergin avatar sohobloo avatar sophiebits avatar souhe avatar sroka avatar thesavior avatar thymikee avatar trancever avatar vonovak avatar wojteg1337 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.