Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jerry4rahul/capacitor-image-cropper
A Capacitor plugin that enables image cropping functionality using the popular UCrop library. Supports aspect ratio settings, resizing, and high-quality output for Android.
https://github.com/jerry4rahul/capacitor-image-cropper
android capacitor capacitor-plugin image-cropper image-cropping-tool ionic ionic-framework ucrop
Last synced: 5 days ago
JSON representation
A Capacitor plugin that enables image cropping functionality using the popular UCrop library. Supports aspect ratio settings, resizing, and high-quality output for Android.
- Host: GitHub
- URL: https://github.com/jerry4rahul/capacitor-image-cropper
- Owner: jerry4rahul
- Created: 2025-01-12T08:23:56.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-01-12T08:24:00.000Z (about 1 month ago)
- Last Synced: 2025-02-12T09:48:38.201Z (7 days ago)
- Topics: android, capacitor, capacitor-plugin, image-cropper, image-cropping-tool, ionic, ionic-framework, ucrop
- Language: Java
- Homepage:
- Size: 113 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
## 🌟 Available Now on Android, with iOS Support Coming Soon! 🌟
# 🎨 Capacitor Image Cropper
The **Capacitor Image Cropper** plugin offers a powerful and user-friendly way to crop images in your mobile applications. With this plugin, you can effortlessly select and crop images to meet your desired dimensions, ensuring your app looks polished and professional! ✨
## 🚀 Features
- **Flexible Cropping Options**: Crop images with customizable width, height, and aspect ratios. 📏
- **Quality Control**: Adjust the quality of the resulting image, balancing fidelity and file size. 📸
- **Circle Cropping**: Optionally crop images in a circular shape for a unique visual flair. 🔵
- **Cross-Platform Support**: Works seamlessly on both iOS and Android platforms. 📱
- **uCrop Integration**: For Android, we utilize the powerful **uCrop** library, providing a robust and feature-rich cropping experience. 🎉
## 📚 Usage
To get started with the Capacitor Image Cropper plugin, simply install it in your project and follow the provided documentation for implementation details.
Transform your images effortlessly with the **Capacitor Image Cropper** plugin! 🌈
### 🛠️ Adding JitPack Repository
To add the JitPack repository, navigate to your `android/gradle.build` file and include the following configuration:
```bash
allprojects {
repositories {
google()
mavenCentral()
maven { url "https://jitpack.io" }
}
}
```
## 📦 Install
Run the following commands to install the plugin:
```bash
npm install capacitor-image-cropper
npx cap sync
```
## 📖 API
* [`crop(...)`](#crop)
* [Interfaces](#interfaces)
### crop(...)
```typescript
crop(options: CropOptions) => Promise
```
| Param | Type |
| ------------- | --------------------------------------------------- |
| **`options`** | CropOptions |
**Returns:** Promise<CropResult>
--------------------
### Interfaces
#### CropResult
| Prop | Type | Description |
| ------------ | ------------------- | --------------------------------------------------------------------------------------- |
| **`path`** | string | The path to the cropped image On Android: content:// or file:// URI On iOS: file:// URI |
| **`base64`** | string | Base64 encoded image data (optional, web only) |
#### CropOptions
| Prop | Type | Description | Default |
| ------------------------------- | -------------------- | --------------------------------------------------------------------------------------------- | ---------------------- |
| **`source`** | string | The path or url of the image to crop Can be a local file path, content:// uri, or file:// uri | |
| **`quality`** | number | Quality of the resulting image, between 0-100 | 90 |
| **`circle`** | boolean | Whether to crop the image in a circle | false |
| **`width`** | number | Maximum width of the resulting image | 300 |
| **`height`** | number | Maximum height of the resulting image | 300 |
| **`aspectRatioX`** | number | Aspect ratio X for crop box (width/height) e.g., 1 for square | 1 |
| **`aspectRatioY`** | number | Aspect ratio Y for crop box (height/width) e.g., 1 for square | 1 |
| **`activeControlsWidgetColor`** | string | Color of the active controls widget | "#9ef500" |
---
## 👤 Author
[**Rahul Kumar Sharma**](https://github.com/jerry4rahul)
Passionate developer and creator of the Capacitor Image Cropper plugin.
## 💬 Message
Thank you for using the Capacitor Image Cropper! Your feedback and contributions are always welcome. Let's make image cropping a breeze for everyone! 🌟
## 🤝 Collaboration
We welcome collaboration! If you have ideas, suggestions, or would like to contribute to the project, feel free to reach out or submit a pull request. Together, we can enhance this plugin and make it even better! 🚀
---
### 🎉 Special Thanks
A big shoutout to the [**uCrop**](https://github.com/Yalantis/uCrop) library for providing an excellent cropping experience on Android! Your contributions make this plugin even more powerful! 🙌