npe

nativescript-photo-editor

🎨 Easily edit an image in your NativeScript app (crop, draw, etc)

Showing:

Popularity

Downloads/wk

27

GitHub Stars

43

Maintenance

Last Commit

2yrs ago

Contributors

1

Package

Dependencies

0

License

Apache-2.0

Type Definitions

Built-In

Tree-Shakeable

No?

Readme

This repo only supports NativeScript pre-6.0. The latest version of the plugin supporting NS 6+ is availble as part of ProPlugins.

NativeScript Photo Editor

Build Status npm downloads npm downloads npm

A NativeScript photo editor. It allows you to crop, draw something on your image or add some text.

Screenshot

Screenshot of iOS

Installation

Run the following command from the root of your project:

tns plugin add nativescript-photo-editor

This command automatically installs the necessary files, as well as stores nativescript-photo-editor as a dependency in your project's package.json file.

Configuration

There is no additional configuration needed!

API

Methods

  • editPhoto(options): Promise
    Opens the photo editor with the given options. If the user accepts the edited image the promise is resolved with an instance of the new ImageSource. If the user cancels the edit the promise will be rejected.

Usage

Simply create an instance of the photo editor, pass the image you want to edit and which editor controls you don't want to use (if any) an that's it!

import { PhotoEditor, PhotoEditorControl } from "nativescript-photo-editor";

const photoEditor = new PhotoEditor();

photoEditor.editPhoto({
    imageSource: originalImage.imageSource,
    hiddenControls: [
        PhotoEditorControl.Save,
        PhotoEditorControl.Crop,
    ],
}).then((newImage: ImageSource) => {
    // Here you can save newImage, send it to your backend or simply display it in your app
    resultImage.imageSource = newImage;
}).catch((e) => {
    console.error(e);
});

Usage in Angular

There is no difference in usage between Core and Angular. So you can refer to the above usage examples on how to use this plugin with Angular.

Demos

This repository includes a plain NativeScript demo. In order to run it execute the following in your shell:

$ git clone https://github.com/peterstaev/nativescript-photo-editor
$ cd nativescript-photo-editor
$ npm install
$ npm run demo-ios

This will run the plain NativeScript demo project on iOS. If you want to run it on Android simply use the -android instead of the -ios sufix.

Donate

bitcoin:14fjysmpwLvSsAskvLASw6ek5XfhTzskHC

Donate

Credits

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Tutorials

No tutorials found
Add a tutorial