Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tzsk/filepond-plugin-zipper
Zip Filepond Directory Uploads
https://github.com/tzsk/filepond-plugin-zipper
create-zip-file filepond filepond-plugin-zipper jszip upload-zip zip
Last synced: about 1 month ago
JSON representation
Zip Filepond Directory Uploads
- Host: GitHub
- URL: https://github.com/tzsk/filepond-plugin-zipper
- Owner: tzsk
- License: mit
- Created: 2020-10-06T12:50:09.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-12T23:09:13.000Z (about 1 year ago)
- Last Synced: 2024-05-02T04:29:42.203Z (8 months ago)
- Topics: create-zip-file, filepond, filepond-plugin-zipper, jszip, upload-zip, zip
- Language: TypeScript
- Homepage: https://github.com/tzsk/filepond-plugin-zipper
- Size: 2.95 MB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# :gift: Filepond Plugin Zipper
[](https://www.npmjs.com/package/filepond-plugin-zipper)
[](https://www.npmjs.com/package/filepond-plugin-zipper)
This 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.
## :package: Installation
```bash
// NPM:
$ npm install --save filepond-plugin-zipper
// Yarn:
$ yarn add filepond-plugin-zipper
```
### CDN
```
https://cdn.jsdelivr.net/npm/[email protected]/dist/jszip.min.js
// And...
https://unpkg.com/filepond-plugin-zipper/dist/zipper.min.js
```
> `JSZip` dependency is required while using via CDN.
## :fire: Usage
This 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.
```js
import FilepondZipper from 'filepond-plugin-zipper';
FilePond.registerPlugin(FilepondZipper());
// Make sure you register it as a function
// cause you can pass in hook to tap into the zip files.
```
### :star: Hook Support
In 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.
In 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.
**Example:**
```js
const pond = FilePond.create(...);
const injector = async (generators) => {
// Set Loading...
const files = await Promise.all(
generators.map(generate => generate())
);
pond.addFiles(files);
// Stop loading...
// OR. If you want to tap individually
// Set Loading...
generators.forEach(generate => {
const file = await generate();
pond.addFile(file);
});
// Stop Loading...
};
Filepond.registerPlugin(FilepondZipper(injector));
```
## :microscope: Testing
After Cloning the repository, install all npm dependencies by running: `npm install`.
Then Run Tests:
```bash
$ npm run test
```
## :date: Change log
This repository follows semantic versioning. Please follow the releases to know about what changed.
## :heart: Contributing
Please feel free to contribute ideas and PRs are most welcome.
## :crown: Credits
- [Kazi Mainuddin Ahmed][link-author]
- [All Contributors][link-contributors]
## :policeman: License
The MIT License (MIT). Please see [License File](LICENSE) for more information.
[link-author]: https://github.com/tzsk
[link-contributors]: ../../contributors