browser_image_compression 1.0.1 
browser_image_compression: ^1.0.1 copied to clipboard
championsgoal.comThis plugin wraps a JavaScript library used for image compression and is specifically designed for use in Flutter Web. The image compression process runs on a web worker concurrently with Flutter's UI [...]
Browser Image Compression #
This is a flutter plugin package that compress images using the javascript library browser_image_compression. This plugin only works on Web platform. Please see browser-image-compression repository for all image compression benefits.
Main benifits of this plugin compared with other packages currently available on pub.dev are:
- Compression works on a web worker cuncurrently with your flutter app.
- Image compression update progress.
- Also can resize image if prefered.
- You can limit the size of the compressed file in megabytes, (the lower you set the longer it takes to compress).
Installation #
- flutter pub add browser_image_compression
- append inside the
<head>tag onindex.html
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/browser-image-compression@2.0.2/dist/browser-image-compression.js"></script>
<script>
- import the plugin
import 'package:browser_image_compression/browser_image_compression.dart';
- code as the example below
Example #
final XFile? xfile =
await ImagePicker().pickImage(source: ImageSource.gallery);
if (xfile != null) {
final initialSize = await xfile.length();
_imageNotifier.value = await BrowserImageCompression.compressImage(
xfile,
Options(
maxSizeMB: 1,
maxWidthOrHeight: 2048,
useWebWorker: true,
onProgress: (progress) {
_progressIndicatorNotifier.value = progress;
},
),
);
_progressIndicatorNotifier.value = null;
if (_imageNotifier.value != null) {
final finalSize = (_imageNotifier.value!).length;
var f = NumberFormat("####.0#", "en_US");
comparisonSize =
'initial size is $initialSize and final size is $finalSize. Compression of ${f.format(initialSize / finalSize)}x';
}
}
TODO #
- Implement javascript "AbortSignal" to abort compression.
Metadata
Publisher
Metadata
This plugin wraps a JavaScript library used for image compression and is specifically designed for use in Flutter Web. The image compression process runs on a web worker concurrently with Flutter's UI main thread, ensuring smooth performance. You can set the final size of the compressed image to any desired value. However, please note that when a high compression rate is set, the library may take longer to process the image.
Repository (GitHub)
View/report issues
License
unknown (license)
Dependencies
cross_file, flutter, flutter_web_plugins, js, plugin_platform_interface
