@baronha/react-native-photo-editor - npm Package Compare versions

Comparing version 0.1.2 to 1.0.0

lib/typescript/index.d.ts

 export declare type Options = {
     path: String;
+    stickers: Array<String>;
 };
+export declare type ErrorCode = 'USER_CANCELLED' | 'IMAGE_LOAD_FAILED' | 'ACTIVITY_DOES_NOT_EXIST' | 'FAILED_TO_SAVE_IMAGE';
 declare type PhotoEditorType = {
@@ -5,0 +7,0 @@ open(option: Object): Promise<String>;

package.json

 {
   "name": "@baronha/react-native-photo-editor",
-  "version": "0.1.2",
+  "version": "1.0.0",
   "description": "🌄 Image editor using native modules for iOS and Android",
@@ -5,0 +5,0 @@ "main": "lib/commonjs/index",

README.md

 # React Native Photo Editor (RNPE)
 
-🌄 Image editor using native modules for iOS and Android. Inherit from 2 available libraries, [Brightroom](https://github.com/muukii/Brightroom) (iOS) and [PhotoEditor](https://github.com/burhanrashid52/PhotoEditor) (Android)
+🌄 Image editor using native modules for iOS and Android. Inherit from 2 available libraries, [ZLImageEditor](https://github.com/longitachi/ZLImageEditor) (iOS) and [PhotoEditor](https://github.com/burhanrashid52/PhotoEditor) (Android)
 
@@ -14,3 +14,3 @@ <p align="center">
 
-- [iOS](https://github.com/muukii/Brightroom)
+- [iOS](https://github.com/muukii/ZLImageEditor)
 - [Android](https://github.com/burhanrashid52/PhotoEditor)
@@ -20,20 +20,18 @@
 
+> Previously this library used [Brightroom](https://github.com/muukii/Brightroom) as the native library for iOS. If you want to use Brightroom you can check it out [here](https://github.com/baronha/react-native-photo-editor/releases/tag/0.1.2).
+
 ## Feature 🙈
 
+###  Both
+- Draw (Support custom line color).
+- Adding/Editing **Text** with option to change its Color.
+- Adding **Images/Stickers**
+- Pinch to Scale and Rotate views.
+
 ### iOS
-- [Wide color editing supported](https://instagram-engineering.com/bringing-wide-color-to-instagram-5a5481802d7d)
-- [Super large photo (12000px)](https://visibleearth.nasa.gov/img/temp.png) supported (But exporting takes so long time for now.)
-- Blazing fast previewing by Metal power.
-- Drawing supported - masking blurry
-- Creating your own filter with LUT
-
+- Apply Filter Effect on image using [LUT Color](#custom-filtersios) (Custom filter is simpler than android)
+- Crop image.
 ### Android
 - Drawing on image with option to change its Brush's Color, Size, Opacity, Erasing and basic shapes.
-- Apply Filter Effect on image using MediaEffect
-- Adding/Editing **Text** with option to change its Color with Custom Fonts.
-- Adding **Emoji** with Custom Emoji Fonts.
-- Adding **Images/Stickers**
-- Pinch to Scale and Rotate views.
-- **Undo and Redo** for Brush and Views.
-- **Deleting** Views
+- Apply Filter Effect on image using [MediaEffect](https://developer.android.com/reference/android/media/effect/EffectFactory). But in the future will change to LUT color.
 
@@ -57,2 +55,4 @@ ## ScreenShot 👉👈
 
+> Don't forget add file [.swift](https://stackoverflow.com/questions/52536380/why-linker-link-static-libraries-with-errors-ios) in your project (and create bridging header file swift).
+
 ## Usage
@@ -71,3 +71,4 @@
 | -------- | :----: | :-----------: | :------: | :--------------- |
-| uri      | string |   required    |   both   | Local image path |
+| path      | string |   required    |   both   | Local/remote image path |
+| [stickers](#stickers)      | Array<String> |   []    |   both   | An array of paths containing sticker images |
 
@@ -91,10 +92,32 @@ ## Filters 🦋
 **IMPORTANT**
-You have to copy [this folder](https://github.com/baronha/react-native-photo-editor/tree/master/resources/LUTs) and paste in Xcode root folder
-[See Example](https://github.com/baronha/react-native-photo-editor/tree/master/example/ios)
+You have to create ```LUTs.bundle``` and add all your LUT Photo(Re-name your LUT Photo follow this format: [LUT_64_FILTER_NAME](https://github.com/baronha/react-native-photo-editor/tree/master/resources/LUTs.bundle)) into ```LUTs.bundle```. Then add ```LUTs.bundle``` into ```Copy Bundle Resources```. [See detail](https://github.com/baronha/react-native-photo-editor/tree/master/example/ios)
 
+## Stickers 🤌
+### Remote
+You need to pass an array of image urls to the sticker parameter in [options](#options)
+[Example](https://github.com/baronha/react-native-photo-editor/blob/dev/example/src/assets/data/stickers.json): 
+```
+[
+  "https://cdn-icons-png.flaticon.com/512/5272/5272912.png",
+  "https://cdn-icons-png.flaticon.com/512/5272/5272913.png",
+  "https://cdn-icons-png.flaticon.com/512/5272/5272916.png",
+  ...
+] 
+```
+### Local
+
+#### iOS
+You have to create ```Stickers.bundle``` and add all your sticker into ```Stickers.bundle```. Then add ```Stickers.bundle``` into ```Copy Bundle Resources```. [See detail](https://github.com/baronha/react-native-photo-editor/tree/master/example/ios)
+#### Android
+You have to create ```Stickers``` folder inside ```assets``` folder. Then drag or copy all sticker in to ```Sticker``` folder. [See detail](https://github.com/baronha/react-native-photo-editor/tree/master/example/android/app/src/main/assets/Stickers)
 ## To Do
 
-- [ ] Customize.
-- [ ] Sync between two platforms.
+- [ ] Lut Color in android.
+- [ ] Crop Image in android.
 
+## Performance
+
+We're trying to improve performance. If you have a better solution, please open a [issue](https://github.com/baronha/react-native-photo-editor/issues)
+or [pull request](https://github.com/baronha/react-native-photo-editor/pulls). Best regards!
+
 ## Contributing
@@ -101,0 +124,0 @@

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Number of package files

142

increased by54.35%

Lines of code

41

increased by24.24%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

125

increased by22.55%

Worsened metrics

Total package byte prevSize

3992900

decreased by-45.56%

No dependency changes