Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-zip
Tutorial
by github.com/Cap-go

Zip

A free Capacitor plugin for zipping and unzipping files on iOS, Android, and Web.

Downloads/week

2.4k

GitHub Stars

3

Guide

Tutorial on Zip

Using @capgo/capacitor-zip

Capacitor Zip Plugin for compressing and extracting zip archives.

Install

bun add @capgo/capacitor-zip
bunx cap sync

What This Plugin Exposes

  • zip - Compress a file or directory to create a ZIP archive.
  • unzip - Extract a ZIP archive to a specified destination directory.

Example Usage

zip

Compress a file or directory to create a ZIP archive.

import { CapacitorZip } from '@capgo/capacitor-zip';

// Compress a directory without password
await CapacitorZip.zip({
  source: '/path/to/my-folder',
  destination: '/path/to/output.zip'
});

unzip

Extract a ZIP archive to a specified destination directory.

import { CapacitorZip } from '@capgo/capacitor-zip';

// Extract a standard ZIP archive
await CapacitorZip.unzip({
  source: '/path/to/archive.zip',
  destination: '/path/to/extract-folder'
});

Full Reference

Keep going from Using @capgo/capacitor-zip

If you are using Using @capgo/capacitor-zip to plan native plugin work, connect it with @capgo/capacitor-zip for the implementation detail in @capgo/capacitor-zip, Getting Started for the implementation detail in Getting Started, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins.