@exodus/image-editor
    TypeScript icon, indicating that this package has built-in type declarations

    2.3.0-exodus.1 • Public • Published

    react-native-image-editor

    Image Editor Native module for React Native.

    Build Status Version 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

    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.

    Install

    npm i @exodus/image-editor

    DownloadsWeekly Downloads

    17

    Version

    2.3.0-exodus.1

    License

    MIT

    Unpacked Size

    50.5 kB

    Total Files

    20

    Last publish

    Collaborators

    • lekzd
    • cdotta
    • ryansquared
    • alexandrbbm
    • danm.exodus
    • danh.t.vo
    • renie
    • alex.alexandrius
    • ezenwankwogabriel
    • meniem
    • mzndako
    • ianertson
    • kevva
    • jumokeolads
    • aaronloexodus
    • vikgmdev
    • iamcrazycoder
    • kewde_
    • cassapula
    • wjbeau
    • feri42
    • jprichardson
    • farisissa
    • dooglio
    • ryanzim
    • headfire
    • kklash
    • gutenye
    • mosesbot
    • roccomuso
    • dcastagnoli
    • sonaye
    • nareg_exodus
    • ves
    • tenaciousmv
    • asyakost
    • maxogden
    • bulgakovk
    • sekhmet
    • chalker
    • andrejb
    • gordonel
    • richayotte
    • jaydp17
    • olistic
    • joepie91
    • merlz
    • jadechip
    • vbonini
    • cooncesean
    • devopsrobot
    • jenish-sojitra
    • unidwell
    • nachoalvarez
    • giovannirco
    • ilyavf
    • rec
    • dncabal
    • r1oga
    • diegomura
    • danilsergeev
    • lanre-mark
    • sunilagrawal
    • guillecura
    • timztos
    • motorina0
    • chadstrat
    • mariosvlad
    • federico-po
    • pagan404