{"id":19858114,"url":"https://github.com/tzsk/filepond-plugin-zipper","last_synced_at":"2026-03-09T13:08:32.916Z","repository":{"id":36969994,"uuid":"301724926","full_name":"tzsk/filepond-plugin-zipper","owner":"tzsk","description":"Zip Filepond Directory Uploads","archived":false,"fork":false,"pushed_at":"2023-10-12T23:09:13.000Z","size":3094,"stargazers_count":10,"open_issues_count":10,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-18T04:13:07.373Z","etag":null,"topics":["create-zip-file","filepond","filepond-plugin-zipper","jszip","upload-zip","zip"],"latest_commit_sha":null,"homepage":"https://github.com/tzsk/filepond-plugin-zipper","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tzsk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-06T12:50:09.000Z","updated_at":"2024-11-07T02:46:51.000Z","dependencies_parsed_at":"2024-11-12T14:22:14.576Z","dependency_job_id":"fc78287d-86d0-4908-8edd-ab8d97a2f94a","html_url":"https://github.com/tzsk/filepond-plugin-zipper","commit_stats":{"total_commits":331,"total_committers":3,"mean_commits":"110.33333333333333","dds":0.4259818731117825,"last_synced_commit":"cc9bdfe1d97bb69d48089bae760c2eafa21151d3"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzsk%2Ffilepond-plugin-zipper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzsk%2Ffilepond-plugin-zipper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzsk%2Ffilepond-plugin-zipper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzsk%2Ffilepond-plugin-zipper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tzsk","download_url":"https://codeload.github.com/tzsk/filepond-plugin-zipper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251972433,"owners_count":21673602,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["create-zip-file","filepond","filepond-plugin-zipper","jszip","upload-zip","zip"],"created_at":"2024-11-12T14:21:29.684Z","updated_at":"2026-03-09T13:08:32.866Z","avatar_url":"https://github.com/tzsk.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# :gift: Filepond Plugin Zipper\n![Filepond Plugin Zipper](./assets/zipper.svg)\n\n![Build](https://img.shields.io/github/workflow/status/tzsk/filepond-plugin-zipper/Tests/master?logo=github\u0026style=for-the-badge)\n![Coveralls](https://img.shields.io/coveralls/github/tzsk/filepond-plugin-zipper/master?logo=coveralls\u0026style=for-the-badge)\n[![npm](https://img.shields.io/npm/v/filepond-plugin-zipper?logo=npm\u0026style=for-the-badge)](https://www.npmjs.com/package/filepond-plugin-zipper)\n[![npm](https://img.shields.io/npm/dt/filepond-plugin-zipper?logo=npm\u0026style=for-the-badge)](https://www.npmjs.com/package/filepond-plugin-zipper)\n\nThis is an extension plugin for [Filepond](https://pqina.nl/filepond/) uploader where you can upload directories as ZIP Files instead of uploading each individual files in them separately.\n\n## :package: Installation\n\n```bash\n// NPM:\n$ npm install --save filepond-plugin-zipper\n\n// Yarn:\n$ yarn add filepond-plugin-zipper\n```\n### CDN\n\n```\nhttps://cdn.jsdelivr.net/npm/jszip@3.5.0/dist/jszip.min.js\n// And...\nhttps://unpkg.com/filepond-plugin-zipper/dist/zipper.min.js\n```\n\n\u003e `JSZip` dependency is required while using via CDN.\n\n## :fire: Usage\n\nThis may differ depending upon the Framework you are using, but there is good documentation of how to register plugins in various Frameworks in Filepond website which you can follow.\n\n```js\nimport FilepondZipper from 'filepond-plugin-zipper';\n\nFilePond.registerPlugin(FilepondZipper());\n\n// Make sure you register it as a function\n// cause you can pass in hook to tap into the zip files.\n```\n\n### :star: Hook Support\n\nIn many cases, specially while using some reactive frameworks you might like to show some loading screen while it is zipping files which might take some time depending upon the directory size.\n\nIn those cases you can pass a callback function inside the `FilepondZipper()`. If you pass a callback then it won't add the zip files in the queue directly. Instead, it will give you the Array of Promise objects which you can tap into to show loading and inject the zip files when they are done.\n\n**Example:**\n```js\nconst pond = FilePond.create(...);\n\nconst injector = async (generators) =\u003e {\n  // Set Loading...\n  const files = await Promise.all(\n    generators.map(generate =\u003e generate())\n  );\n  pond.addFiles(files);\n  // Stop loading...\n\n  // OR. If you want to tap individually\n\n  // Set Loading...\n  generators.forEach(generate =\u003e {\n    const file = await generate();\n    pond.addFile(file);\n  });\n  // Stop Loading...\n};\n\nFilepond.registerPlugin(FilepondZipper(injector));\n```\n\n## :microscope: Testing\n\nAfter Cloning the repository, install all npm dependencies by running: `npm install`.\n\nThen Run Tests:\n\n```bash\n$ npm run test\n```\n\n## :date: Change log\n\nThis repository follows semantic versioning. Please follow the releases to know about what changed.\n\n## :heart: Contributing\n\nPlease feel free to contribute ideas and PRs are most welcome.\n\n## :crown: Credits\n\n- [Kazi Mainuddin Ahmed][link-author]\n- [All Contributors][link-contributors]\n\n## :policeman: License\n\nThe MIT License (MIT). Please see [License File](LICENSE) for more information.\n\n[link-author]: https://github.com/tzsk\n[link-contributors]: ../../contributors\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftzsk%2Ffilepond-plugin-zipper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftzsk%2Ffilepond-plugin-zipper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftzsk%2Ffilepond-plugin-zipper/lists"}