--- description: Capacitor plugin for compressing files, including images, with cross-platform support and high performance. title: Capacitor File Compressor Plugin for Android, iOS & Web - Capawesome image: https://capawesome.io/docs/assets/images/social/plugins/file-compressor.png --- [ Skip to content](#capawesome-teamcapacitor-file-compressor) [ 🎉 Introducing **Capawesome Platform** — one platform for Live Updates, Native Builds, App Store Publishing, and Insider SDKs.](https://capawesome.io) * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Changelog ](#changelog) * [ Breaking Changes ](#breaking-changes) * [ License ](#license) * [ File Opener ](/docs/plugins/file-opener/) * [ File Picker ](/docs/plugins/file-picker/) * [ Firebase ](/docs/plugins/firebase/) * [ Formbricks ](/docs/plugins/formbricks/) * [ Geocoder ](/docs/plugins/geocoder/) * [ Google Sign-In ](/docs/plugins/google-sign-in/) * [ libSQL ](/docs/plugins/libsql/) * [ Live Update ](/docs/plugins/live-update/) * [ Managed Configurations ](/docs/plugins/managed-configurations/) * [ Media Session ](/docs/plugins/media-session/) * [ ML Kit ](/docs/plugins/mlkit/) * [ NFC ](/docs/plugins/nfc/) * [ OAuth ](/docs/plugins/oauth/) * [ Pedometer ](/docs/plugins/pedometer/) * [ Photo Editor ](/docs/plugins/photo-editor/) * [ PostHog ](/docs/plugins/posthog/) * [ Printer ](/docs/plugins/printer/) * [ Purchases ](/docs/plugins/purchases/) * [ RealtimeKit ](/docs/plugins/realtimekit/) * [ Screen Orientation ](/docs/plugins/screen-orientation/) * [ Screenshot ](/docs/plugins/screenshot/) * [ Secure Preferences ](/docs/plugins/secure-preferences/) * [ Speech Recognition ](/docs/plugins/speech-recognition/) * [ Speech Synthesis ](/docs/plugins/speech-synthesis/) * [ Share Target ](/docs/plugins/share-target/) * [ Square Mobile Payments ](/docs/plugins/square-mobile-payments/) * [ SQLite ](/docs/plugins/sqlite/) * [ Superwall ](/docs/plugins/superwall/) * [ Torch ](/docs/plugins/torch/) * [ Wifi ](/docs/plugins/wifi/) * [ Zip ](/docs/plugins/zip/) * [ Cloud ](/docs/cloud/) * [ Live Updates ](/docs/cloud/live-updates/) * Advanced * Integrations * [ Native Builds ](/docs/cloud/native-builds/) * [ Configuration ](/docs/cloud/native-builds/configuration/) * [ Environments ](/docs/cloud/native-builds/environments/) * Guides * [ Sample Projects ](/docs/cloud/native-builds/sample-projects/) * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ Automations ](/docs/cloud/automations/) * [ Assist ](/docs/cloud/assist/) * Account * Organizations * [ Organization and User Management ](/docs/cloud/organizations/memberships/) * [ Single Sign-On (SSO) ](/docs/cloud/organizations/sso/) * [ Teams ](/docs/cloud/organizations/teams/) * [ Two-Factor Authentication ](/docs/cloud/organizations/two-factor-authentication/) * [ Integrations ](/docs/cloud/integrations/) * [ License Keys ](/docs/cloud/license-keys/) * [ Webhooks ](/docs/cloud/webhooks/) * [ Pricing ](https://capawesome.io/pricing/) * [ FAQ ](/docs/cloud/faq/) * [ Support ](/docs/cloud/support/) * [ Contributing ](/docs/contributing/) * [ LLMs ](/docs/llms/) * [ Insiders ](/docs/insiders/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/insiders/support/) * [ FAQ ](/docs/insiders/faq/) * [ Blog ](/blog/) * Categories * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Changelog ](#changelog) * [ Breaking Changes ](#breaking-changes) * [ License ](#license) # @capawesome-team/capacitor-file-compressor[¶](#capawesome-teamcapacitor-file-compressor "Permanent link") Capacitor plugin for efficient file compression with support for image formats like PNG, JPEG, and WebP. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Features[¶](#features "Permanent link") We are proud to offer one of the most complete and feature-rich Capacitor plugins for file compression. Here are some of the key features: * 🖥️ **Cross-platform**: Supports Android, iOS and Web. * 🌅 **Compress Images**: Compress png, jpeg, and webp images. * 🤝 **Compatibility**: Compatible with the [Zip](https://capawesome.io/docs/plugins/zip/) plugin. * 📦 **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS. * 🔁 **Up-to-date**: Always supports the latest Capacitor version. * ⭐️ **Support**: Priority support from the Capawesome Team. * ✨ **Handcrafted**: Built from the ground up with care and expertise, not forked or AI-generated. Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look! ## Newsletter[¶](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Compatibility[¶](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 8.x.x | \>=8.x.x | Active support | | 7.x.x | 7.x.x | Deprecated | | 6.x.x | 6.x.x | Deprecated | ## Demo[¶](#demo "Permanent link") A working example can be found [here](https://github.com/capawesome-team/capacitor-plugin-demo). | Android | | -------------------------------------------------------------------------------------------------------------------------------------------- | | ![Android Demo](../../assets/external/github.com/capawesome-team/capacitor-plugins/assets/13857929/24fa080e-327f-4a7e-afed-f2e7da82d5a7.gif) | ## Guides[¶](#guides "Permanent link") * [Exploring the Capacitor File Compressor API](https://capawesome.io/blog/exploring-the-capacitor-file-compressor-api/) ## Installation[¶](#installation "Permanent link") This plugin is only available to [Capawesome Insiders](https://capawesome.io/insiders/). First, make sure you have the Capawesome npm registry set up. You can do this by running the following commands: `[](#%5F%5Fcodelineno-0-1)npm config set @capawesome-team:registry https://npm.registry.capawesome.io [](#%5F%5Fcodelineno-0-2)npm config set //npm.registry.capawesome.io/:_authToken ` **Attention**: Replace `` with the license key you received from Polar. If you don't have a license key yet, you can get one by becoming a [Capawesome Insider](https://capawesome.io/insiders/). Next, you can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-1-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-2-1)Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome-team/capacitor-file-compressor` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below: `[](#%5F%5Fcodelineno-3-1)npm install @capawesome-team/capacitor-file-compressor [](#%5F%5Fcodelineno-3-2)npx cap sync ` ### Android[¶](#android "Permanent link") #### Proguard[¶](#proguard "Permanent link") If you are using Proguard, you need to add the following rules to your `proguard-rules.pro` file: `[](#%5F%5Fcodelineno-4-1)-keep class io.capawesome.capacitorjs.plugins.** { *; } ` #### Variables[¶](#variables "Permanent link") If needed, you can define the following project variable in your app’s `variables.gradle` file to change the default version of the dependency: * `$androidxDocumentFileVersion` version of `androidx.documentfile:documentfile` (default: `1.1.0`) This can be useful if you encounter dependency conflicts with other plugins in your project. ## Configuration[¶](#configuration "Permanent link") No configuration required for this plugin. ## Usage[¶](#usage "Permanent link") `[](#%5F%5Fcodelineno-5-1)import { FileCompressor } from '@capawesome-team/capacitor-file-compressor'; [](#%5F%5Fcodelineno-5-2) [](#%5F%5Fcodelineno-5-3)const compressImage = async () => { [](#%5F%5Fcodelineno-5-4) const { path } = await FileCompressor.compressImage({ [](#%5F%5Fcodelineno-5-5) height: 1000, [](#%5F%5Fcodelineno-5-6) mimeType: 'image/jpeg', [](#%5F%5Fcodelineno-5-7) path: 'content://com.android.providers.downloads.documents/document/msf%3A1000000485', [](#%5F%5Fcodelineno-5-8) quality: 0.7, [](#%5F%5Fcodelineno-5-9) width: 1000, [](#%5F%5Fcodelineno-5-10) }); [](#%5F%5Fcodelineno-5-11) return path; [](#%5F%5Fcodelineno-5-12)}; ` ## API[¶](#api "Permanent link") * [compressImage(...)](#compressimage) * [Interfaces](#interfaces) ### compressImage(...)[¶](#compressimage "Permanent link") `[](#%5F%5Fcodelineno-6-1)compressImage(options: CompressImageOptions) => Promise ` Compress an image. Only png, jpeg, and webp images are supported. **Attention**: The exif data of the image is lost during compression. | Param | Type | | ----------- | --------------------------------------------- | | **options** | [CompressImageOptions](#compressimageoptions) | **Returns:** `Promise<[CompressImageResult](#compressimageresult)>` **Since:** 5.0.0 --- ### Interfaces[¶](#interfaces "Permanent link") #### CompressImageResult[¶](#compressimageresult "Permanent link") | Prop | Type | Description | Since | | -------- | ------ | ------------------------------------------------------------------- | ----- | | **path** | string | The path of the compressed file. Only available on Android and iOS. | 5.0.0 | | **blob** | Blob | The blob of the compressed file. Only available on Web. | 5.0.0 | #### CompressImageOptions[¶](#compressimageoptions "Permanent link") | Prop | Type | Description | Default | Since | | ------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----- | | **blob** | Blob | The blob of the file to compress. Only available on Web. | 5.0.0 | | | **height** | number | The height of the resulting image. | 7.1.0 | | | **mimeType** | string | The mime type of the compressed file. On Android, only image/jpeg and image/webp are supported. On iOS, only image/jpeg is supported. On Web, only image/jpeg and image/webp are supported. | 'image/jpeg' | 5.0.0 | | **path** | string | The path of the file to compress. Only available on Android and iOS. | 5.0.0 | | | **quality** | number | The quality of the resulting image, expressed as a value from 0.0 to 1.0. The value 0.0 represents the maximum compression (or lowest quality) while the value 1.0 represents the least compression (or best quality). | 0.6 | 5.0.0 | | **width** | number | The width of the resulting image. | 7.1.0 | | ## Changelog[¶](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/file-compressor/CHANGELOG.md). ## Breaking Changes[¶](#breaking-changes "Permanent link") See [BREAKING.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/file-compressor/BREAKING.md). ## License[¶](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/file-compressor/LICENSE). May 17, 2026 Back to top