capawesome-team / capacitor-photo-editor

⚡️ Capacitor plugin that allows the user to edit a photo.

⚠️ Deprecated repository

This project has been moved to the following monorepo: capawesome-team/capacitor-plugins.

---

Photo Editor

@capawesome/capacitor-photo-editor

Capacitor plugin that allows the user to edit a photo.

Maintainers

Maintainer	GitHub	Social
Robin Genz	robingenz	@robin_genz

Sponsors

This is an MIT-licensed open source project. It can grow thanks to the support by these awesome people. If you'd like to join them, please read more here.

Installation

npm install @capawesome/capacitor-photo-editor
npx cap sync

Configuration

No configuration required for this plugin.

Demo

A working example can be found here: robingenz/capacitor-plugin-demo

Usage

import { PhotoEditor } from '@capawesome/capacitor-photo-editor';

const editPhoto = async () => {
  await PhotoEditor.editPhoto({ path: 'data/image.png' });
};

API

• editPhoto(...)
• Interfaces

editPhoto(...)

editPhoto(options: EditPhotoOptions) => Promise<void>

Edit a photo at a given path.

Only available for Android.

Param	Type
options	EditPhotoOptions

---

Interfaces

EditPhotoOptions

Prop	Type	Description
path	string	The path of the file to edit.

Changelog

See CHANGELOG.md.

License

See LICENSE.