Awesome
⚠️ Deprecated repository
This project has been moved to the following monorepo: capawesome-team/capacitor-plugins.
<p align="center"><br><img src="https://avatars.githubusercontent.com/u/105555861" width="128" height="128" /></p> <h3 align="center">Photo Editor</h3> <p align="center"><strong><code>@capawesome/capacitor-photo-editor</code></strong></p> <p align="center"> Capacitor plugin that allows the user to edit a photo. </p> <p align="center"> <img src="https://img.shields.io/maintenance/yes/2023?style=flat-square" /> <a href="https://github.com/capawesome-team/capacitor-photo-editor/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/actions/workflow/status/capawesome-team/capacitor-photo-editor/ci.yml?branch=main&style=flat-square" /></a> <a href="https://www.npmjs.com/package/@capawesome/capacitor-photo-editor"><img src="https://img.shields.io/npm/l/@capawesome/capacitor-photo-editor?style=flat-square" /></a> <br> <a href="https://www.npmjs.com/package/@capawesome/capacitor-photo-editor"><img src="https://img.shields.io/npm/dw/@capawesome/capacitor-photo-editor?style=flat-square" /></a> <a href="https://www.npmjs.com/package/@capawesome/capacitor-photo-editor"><img src="https://img.shields.io/npm/v/@capawesome/capacitor-photo-editor?style=flat-square" /></a> <a href="https://github.com/capawesome-team"><img src="https://img.shields.io/badge/part%20of-capawesome-%234f46e5?style=flat-square" /></a> </p>
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.
<!-- sponsors --><!-- sponsors -->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
<docgen-index> </docgen-index> <docgen-api> <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->editPhoto(...)
editPhoto(options: EditPhotoOptions) => Promise<void>
Edit a photo at a given path.
Only available for Android.
| Param | Type |
|---|---|
options | <code><a href="#editphotooptions">EditPhotoOptions</a></code> |
Interfaces
EditPhotoOptions
| Prop | Type | Description |
|---|---|---|
path | <code>string</code> | The path of the file to edit. |
Changelog
See CHANGELOG.md.
License
See LICENSE.