https://github.com/tisankan/file_compression_plus
A Flutter package offering efficient file compression solutions for images (JPG, PNG, WebP) and PDFs. Features customizable quality settings, dimension control, and compression levels while maintaining optimal output quality.
https://github.com/tisankan/file_compression_plus
Last synced: 3 months ago
JSON representation
A Flutter package offering efficient file compression solutions for images (JPG, PNG, WebP) and PDFs. Features customizable quality settings, dimension control, and compression levels while maintaining optimal output quality.
- Host: GitHub
- URL: https://github.com/tisankan/file_compression_plus
- Owner: Tisankan
- License: mit
- Created: 2025-03-03T12:18:00.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-03T14:41:21.000Z (3 months ago)
- Last Synced: 2025-03-03T14:48:39.541Z (3 months ago)
- Language: Dart
- Homepage: https://pub.dev/packages/file_compression_plus
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# File Compression Plus
A Flutter package for compressing various file types including images and PDFs. This package provides simple and efficient methods to reduce file sizes while maintaining acceptable quality.
Developed by Tisankan.
## Features
- **Image Compression**: Compress JPG, PNG, and WebP images with customizable quality and dimensions
- **PDF Compression**: Compress PDF files with different compression levels
- **Simple API**: Easy-to-use methods with sensible defaults
- **Customizable**: Configure compression parameters to suit your needs
## Getting Started
Add the package to your `pubspec.yaml` file:
```yaml
dependencies:
file_compression_plus: ^0.0.1
```
Then run:
```bash
flutter pub get
```
## Usage
### Image Compression
```dart
import 'dart:io';
import 'package:file_compression_plus/file_compression_plus.dart';
// Basic usage with default settings
Future compressImageExample() async {
File originalImage = File('path/to/image.jpg');
File compressedImage = await FileCompressor.compressImage(
file: originalImage,
);
print('Compressed image saved to: ${compressedImage.path}');
}
// Advanced usage with custom settings
Future advancedImageCompression() async {
File originalImage = File('path/to/image.png');
File compressedImage = await FileCompressor.compressImage(
file: originalImage,
quality: 70,
maxWidth: 1280,
maxHeight: 720,
format: ImageFormat.jpg, // Convert PNG to JPG
);
print('Compressed image saved to: ${compressedImage.path}');
}
```
### PDF Compression
```dart
import 'dart:io';
import 'package:file_compression_plus/file_compression_plus.dart';
// Basic usage with best compression
Future compressPdfExample() async {
File originalPdf = File('path/to/document.pdf');
File compressedPdf = await FileCompressor.compressPdf(
file: originalPdf,
);
print('Compressed PDF saved to: ${compressedPdf.path}');
}
// With custom compression level
Future customPdfCompression() async {
File originalPdf = File('path/to/document.pdf');
File compressedPdf = await FileCompressor.compressPdf(
file: originalPdf,
compressionLevel: PdfCompressionLevel.normal,
);
print('Compressed PDF saved to: ${compressedPdf.path}');
}
```
## Additional Information
- The compressed files are saved to the temporary directory by default
- For production use, you may want to copy the compressed files to a permanent location
- This package uses [image_compression_flutter](https://pub.dev/packages/image_compression_flutter) for image compression and [syncfusion_flutter_pdf](https://pub.dev/packages/syncfusion_flutter_pdf) for PDF compression
## License
This project is licensed under the MIT License - see the LICENSE file for details.
```