https://github.com/capawesome-team/capacitor-photo-editor
⚡️ Capacitor plugin that allows the user to edit a photo.
https://github.com/capawesome-team/capacitor-photo-editor
List: capacitor-photo-editor
android capacitor capacitor-android capacitor-community capawesome ios photo-editor
Last synced: 3 months ago
JSON representation
⚡️ Capacitor plugin that allows the user to edit a photo.
- Host: GitHub
- URL: https://github.com/capawesome-team/capacitor-photo-editor
- Owner: capawesome-team
- License: mit
- Archived: true
- Created: 2021-09-16T16:12:22.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-01T07:18:44.000Z (almost 2 years ago)
- Last Synced: 2024-10-29T16:20:24.608Z (4 months ago)
- Topics: android, capacitor, capacitor-android, capacitor-community, capawesome, ios, photo-editor
- Language: Java
- Homepage: https://capawesome.io/plugins/photo-editor/
- Size: 357 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-capacitor - Photo editor - Capacitor plugin that allows the user to edit a photo. ([Capawesome plugins](https://capawesome.io/))
README
## ⚠️ Deprecated repository
**This project has been moved to the following monorepo: [capawesome-team/capacitor-plugins](https://github.com/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](https://github.com/robingenz) | [@robin_genz](https://twitter.com/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](https://github.com/sponsors/capawesome-team).
## Installation
```bash
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](https://github.com/robingenz/capacitor-plugin-demo)
## Usage
```typescript
import { PhotoEditor } from '@capawesome/capacitor-photo-editor';
const editPhoto = async () => {
await PhotoEditor.editPhoto({ path: 'data/image.png' });
};
```
## API
* [`editPhoto(...)`](#editphoto)
* [Interfaces](#interfaces)
### editPhoto(...)
```typescript
editPhoto(options: EditPhotoOptions) => Promise
```
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](https://github.com/capawesome-team/capacitor-photo-editor/blob/main/CHANGELOG.md).
## License
See [LICENSE](https://github.com/capawesome-team/capacitor-photo-editor/blob/main/LICENSE).