@capgo/capacitor-file-compressor

Capacitor plugin for efficient image compression and format conversion across iOS, Android, and Web.

Why File Compressor?

A free, open-source alternative for client-side image compression:

• Format conversion - Convert HEIF, PNG, WebP, GIF, and more to JPEG, PNG, WebP, or HEIF
• Multiple formats - Broad input support with platform-specific output formats
• Quality control - Adjustable compression quality (0.0 - 1.0)
• Smart resizing - Automatic aspect ratio preservation without upscaling
• Cross-platform - Consistent API across iOS, Android, and Web
• Zero backend - All compression happens on the device

Essential for apps that need to optimize image uploads, reduce storage, or improve performance without server-side processing.

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/file-compressor/

Compatibility

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/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:

npm install @capgo/capacitor-file-compressor
npx cap sync

Format Conversion

The plugin accepts common image formats as input and converts them to the mimeType you request.

import { FileCompressor } from '@capgo/capacitor-file-compressor';

// Convert an iPhone HEIF photo to JPEG before upload
const result = await FileCompressor.compressImage({
  path: heifFileUri,
  width: 1920,
  height: 1080,
  quality: 0.7,
  mimeType: 'image/jpeg',
});

Note: EXIF metadata is removed during compression on all platforms.

API

compressImage(options: CompressImageOptions) => Promise<CompressImageResult>

getPluginVersion() => Promise<{ version: string; }>