@thienmd/react-native-image-editor

v0.7.0

Published

5 months ago

React Native: Native Image Editor

Downloads

0High
0Medium
0Low

thienmd

react-native

ReactNative: Native Image Editor (Android/iOS)

If this project has helped you out, please support us with a star 🌟

Cropping
Adding Images -Stickers-
Adding Text with Colors
Drawing with Colors
Scaling and Rotating Objects
Deleting Objects
Saving to Photos and Sharing
Cool Animations

Introduction

@thienmd/react-native-image-editor is a fork of the deprecated react-native-photo-editor. The original library had not been updated for a while and had several limitations, including inconsistent user interfaces between iOS and Android.

Seeing the need for a more maintained and consistent library, I decided to fork react-native-photo-editor and create @thienmd/react-native-image-editor.

The main goals of this library are:

Maintainability: As the maintainer of this library, I aim to keep it up-to-date with the latest versions of React Native and the native photo editor libraries.
Consistency: This library aims to provide a consistent user interface across both iOS and Android platforms. This not only provides a better user experience, but also makes it easier for developers to use.

📱 Demo

| iOS | Android | | ---------------------------------------- | -------------------------------------------- | | | |

Migrating from react-native-photo-editor

If you're currently using react-native-photo-editor and want to switch to this library, you can follow these steps:

Uninstall the old library. Run npm uninstall react-native-photo-editor or yarn remove react-native-photo-editor, depending on whether you're using npm or yarn.
Install this library. Run npm install @thienmd/react-native-image-editor or yarn add @thienmd/react-native-image-editor.
Update your JavaScript files. Replace all instances of import PhotoEditor from 'react-native-photo-editor' with import ImageEditor from '@thienmd/react-native-image-editor'.
Update your Podfile. If you're using iOS, make the following changes in your Podfile:
Replace pod 'RNPhotoEditor', :path => '../node_modules/react-native-photo-editor' with pod 'RNImageEditor', :path => '../node_modules/@thienmd/react-native-image-editor'.
Replace pod 'iOSPhotoEditor', :git => 'https://github.com/prscX/photo-editor', :branch => 'master' with pod 'iOSPhotoEditor', :git => 'https://github.com/ThienMD/photo-editor', :branch => 'master'.
Run pod install. If you're using iOS, run pod install in your ios directory to install the new library.

Please note that the API of this library might be different from react-native-photo-editor. Make sure to update your code to use the new API.

📖 Getting started

$ yarn add @thienmd/react-native-image-editor

This library is supported React Native V61 and above

iOS

iOS Prerequisite: Please make sure CocoaPods is installed on your system

- Add the following to your `Podfile` -> `ios/Podfile` and run pod update:

  use_native_modules!

  use_frameworks! :linkage => :static
  pod "iOSPhotoEditor", :git => "https://github.com/ThienMD/photo-editor", :branch => "master"

  post_install do |installer|
    installer.pods_project.targets.each do |target|
      if target.name.include?('iOSPhotoEditor')
        target.build_configurations.each do |config|
          config.build_settings['SWIFT_VERSION'] = '5'
        end
      end
    end
  end

  # Follow [Flipper iOS Setup Guidelines](https://fbflipper.com/docs/getting-started/ios-native)
  # This is required because iOSPhotoEditor is implemented using Swift and we have to use use_frameworks! in Podfile
  $static_framework = ['FlipperKit', 'Flipper', 'Flipper-Folly',
    'CocoaAsyncSocket', 'ComponentKit', 'Flipper-DoubleConversion',
    'Flipper-Glog', 'Flipper-PeerTalk', 'Flipper-RSocket', 'Yoga', 'YogaKit',
    'CocoaLibEvent', 'OpenSSL-Universal', 'boost-for-react-native']

  pre_install do |installer|
    Pod::Installer::Xcode::TargetValidator.send(:define_method, :verify_no_static_framework_transitive_dependencies) {}
    installer.pod_targets.each do |pod|
        if $static_framework.include?(pod.name)
          def pod.build_type;
            Pod::BuildType.static_library
          end
        end
      end
  end

Please make sure Flipper iOS Setup Guidelines steps are added to Podfile, since iOSPhotoEditor is implemented using Swift and we have to use use_frameworks! in Podfile
If using React Native Firebase v6+, please see Troubleshooting section for a known issue before moving further.
Add below property to your info.list

	<key>NSPhotoLibraryAddUsageDescription</key>
	<string>Application needs permission to write photos...</string>

	<!-- If you are targeting devices running on iOS 10 or later, you'll also need to add: -->
	<key>NSPhotoLibraryUsageDescription</key>
	<string>iOS 10 needs permission to write photos...</string>

Android
Please add below script in your build.gradle

buildscript {
    repositories {
        maven { url "https://jitpack.io" }
        ...
    }
}

allprojects {
    repositories {
        maven { url "https://jitpack.io" }
        ...
    }
}

Add below activity in your app activities:

<activity android:name="com.ahmedadeltito.photoeditor.PhotoEditorActivity" /> <activity android:name="com.yalantis.ucrop.UCropActivity" />

To save image to the public external storage, you must request the WRITE_EXTERNAL_STORAGE permission in your manifest file:

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

⛄️ Stickers

If you want stickers, please add them to your native project:

iOS: Add stickers to iOS Resources folder
Android: Add stickers to app drawable folder

Refer Example project for the same.

💻 Usage

import ImageEditor from '@thienmd/react-native-image-editor'

ImageEditor.Edit({
    path: RNFS.DocumentDirectoryPath + "/photo.jpg"
});

Purpose of this library is to edit photos which are within app sandbox, we recommend to move captured image to app sandbox then using RNFS share image path with library for the edit.

Example: If we capture image through cameraRoll then we should first move image to app sandbox using RNFS then share app storage path with the editor.

💡 Props

General(iOS & Android)

| Prop | Type | Default | Note | | ----------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | path: mandatory | string | | Specify image path you want to edit | | hiddenControls | array | | Specify editor controls you want to hide [clear, crop, draw, save, share, sticker, text] | | stickers | array | | Specify stickers you want to show in stickers picker | | languages | object | | Specify languages you want to show in text editor | | colors | array: HEX-COLOR | [#000000, #808080, #a9a9a9, #FFFFFF, #0000ff, #00ff00, #ff0000, #ffff00, #ffa500, #800080, #00ffff, #a52a2a, #ff00ff] | Specify colors you want to show for draw/text | | onDone | func | | Specify done callback | | onCancel | func | | Specify cancel callback |

🔧 Troubleshooting

If using React Native Firebase v6+ or facing any of the following issues: #104, #93

Add the following to your podfile -> ios/podfile and run pod install

pre_install do |installer|
  installer.pod_targets.each do |pod|
    if pod.name.start_with?('RNFB')
      def pod.build_type;
        Pod::BuildType.static_library
      end
    end
  end
end

If the above doesn't work, try the following and and re-run pod install:

As @react-native-firebase documentation you should add following to top of the Podfile for Allow iOS Static Frameworks

$RNFirebaseAsStaticFramework = true

swiftFORCE_LOAD$_swiftUniformTypeIdentifiers / swiftFORCE_LOAD$_swiftCoreMIDI

✨ Credits

Android Image Editor: eventtus/photo-editor-android
iOS Image Editor: eventtus/photo-editor
react-native-photo-editor: prscX/react-native-photo-editor

🤔 How to contribute

Have an idea? Found a bug? Please raise to ISSUES. Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list below. ✨

💖 Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Starring and sharing the projects you like 🚀
If you're feeling especially charitable, please follow prscX on GitHub.