flutter_image_compress_lite

Standalone image-compression plugin for Flutter on Android and iOS — a drop-in replacement for flutter_image_compress, collapsed into a single package (no federated architecture, hence no macOS/Web/OpenHarmony).

Purpose: minimal and legacy-free, for current toolchains only — minimal native dependencies, no CocoaPods, and built against the latest AGP, Gradle, Flutter, and Xcode rather than older ones. If you need older toolchains or CocoaPods, use the upstream package instead.

What changed vs upstream

Usage

dependencies:
  flutter_image_compress_lite: ^2.4.4

import 'package:flutter_image_compress_lite/flutter_image_compress_lite.dart';

final result = await FlutterImageCompress.compressAndGetFile(
  sourcePath,
  targetPath,
);

Same FlutterImageCompress API as the upstream — just change the import.

Errors

UnsupportedError is thrown when the requested encoding is unsupported on the current platform:

• WebP encoding on iOS (decoding works on iOS 14+)
• HEIC encoding on Android < API 28 (Android 9)

CompressError is thrown for invalid input caught Dart-side (empty image bytes, missing file).

PlatformException is thrown by the native side when something goes wrong below the channel. Both platforms surface the same core codes (Android previously swallowed these to null; it now matches iOS):

• FILE_NOT_FOUND — the source file could not be read.
• BAD_IMAGE — the source bytes/file could not be decoded into an image.
• WRITE_FAILED — the compressed output could not be written to the target path (compressAndGetFile only).

It can also carry these defensive codes (unreachable from the public Dart API):

• BAD_ARGS — channel arguments are missing, of the wrong type, or carry an unknown format index. Both platforms.
• COMPRESS_ERROR — Android-only catch-all for any other native failure (e.g. a HeifWriter error or an OutOfMemoryError). iOS has no equivalent: its encoder APIs return Optional<Data> instead of throwing, so there's no exception soup to defend against.

License

Same as upstream: MIT