# Download Multiple Documents ## Summary This sample empowers users to effortlessly download multiple documents as a single compressed ZIP file. ![screenshot](./assets/screenshot1.png) ![demo](./assets/MultipleDownloadsWebPartDemo.gif) ## Compatibility | :warning: Important | |:---------------------------| | Every SPFx version is optimally compatible with specific versions of Node.js. In order to be able to build this sample, you need to ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.| |Refer to for more information on SPFx compatibility. | This sample is optimally compatible with the following environment configuration: ![SPFx 1.17.4](https://img.shields.io/badge/SPFx-1.17.4-green.svg) ![Node.js v16.13+](https://img.shields.io/badge/Node.js-v16.13+-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) ![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower") ![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1") ![Local Workbench Unsupported](https://img.shields.io/badge/Local%20Workbench-Unsupported-red.svg "Local workbench is no longer available as of SPFx 1.13 and above") ![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg) ![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg) Tested using Node.js v16.13.0 ## Applies to - [SharePoint Framework](https://aka.ms/spfx) - [Microsoft 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant) > Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/m365devprogram) ## Prerequisites - [JSZIP](https://github.com/Stuk/jszip) - [spfx-property-controls](https://pnp.github.io/sp-dev-fx-property-controls/) ## Contributors - [Ramin Ahmadi](https://github.com/AhmadiRamin) | ## Version history | Version | Date | Comments | | ------- | ---------------- | --------------- | | 1.0 | September 09, 2023 | Initial release | ## Minimal Path to Awesome - Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-download-multiple-documents) then unzip it) - From your command line, change your current directory to the directory containing this sample (`react-download-multiple-documents`, located under `samples`) - in the command line run: - `npm install` - `gulp serve` ## Features - Seamless Integration: This SPFx web part seamlessly integrates with your SharePoint environment, allowing you to select multiple documents from document libraries or lists. - Batch Download: Select multiple documents, and with a single click, generate and download a ZIP file containing all the selected documents. - Efficient Compression: The web part leverages the jszip library, a popular JavaScript library for working with ZIP files. It efficiently compresses your selected documents while preserving their folder structure. ## References - [Getting started with SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant) - [Building for Microsoft teams](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/build-for-teams-overview) - [Use Microsoft Graph in your solution](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/using-microsoft-graph-apis) - [Publish SharePoint Framework applications to the Marketplace](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/publish-to-marketplace-overview) - [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development ## Help We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues. If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment. You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-download-multiple-documents%22) to see if anybody else is having the same issues. You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-download-multiple-documents) and see what the community is saying. If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-download-multiple-documents&template=bug-report.yml&sample=react-download-multiple-documents&authors=@AhmadiRamin&title=react-download-multiple-documents%20-%20). For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-download-multiple-documents&template=question.yml&sample=react-download-multiple-documents&authors=@AhmadiRamin&title=react-download-multiple-documents%20-%20). Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-download-multiple-documents&template=suggestion.yml&sample=react-download-multiple-documents&authors=@AhmadiRamin&title=react-download-multiple-documents%20-%20). ## Disclaimer **THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**