enyo /dropzone
Dropzone is an easy to use drag'n'drop library. It supports image previews and shows nice progress bars.
★ 18,410⑂ 3,225👁 369⑃ 307● 1,867▤ 54
+1
日增长
18,410
stars
3,225
forks
369
watchers
307
prs
1,867
issues
54
releases
README
Dropzone is a JavaScript library that turns any HTML element into a dropzone.
This means that a user can drag and drop a file onto it, and Dropzone will
display file previews and upload progress, and handle the upload for you via
XHR.
It's fully configurable, can be styled according to your needs and is trusted by
thousands. It's written in TypeScript and ships its own types, so there's
nothing extra to install.
Quickstart
Install:
bash
$ npm install dropzone
or with pnpm:
$ pnpm add dropzone
Use as ES6 module (recommended):
js
import { Dropzone } from "dropzone";
const dropzone = new Dropzone("divmyId", { url: "/file/post" });
or use as CommonJS module:
js
const { Dropzone } = require("dropzone");
const dropzone = new Dropzone("divmyId", { url: "/file/post" });
TypeScript
The types come with the package — there's no @types/dropzone to install, and
you should remove it if you have it: it stopped at 5.7.9 and describes the
v5 API.
ts
import { Dropzone } from "dropzone";
import type { DropzoneFile, DropzoneOptions } from "dropzone";
const options: DropzoneOptions = { url: "/file/post", maxFilesize: 10 };
const dropzone = new Dropzone("divmyId", options);
// listener arguments are inferred from the event name
dropzone.on("addedfile", (file) = console.log(file.name, file.upload.uuid));
👉 Checkout our example implementations for different
bundlers
Not using a package manager or bundler?
Use the standalone files like this:
html
// Dropzone has been added as a global variable.
const dropzone = new Dropzone("div.my-dropzone", { url: "/file/post" });
---
- 📚 Full documentation
- ⚙️ src/options.ts
for all available options
---
⚠️ NOTE: Dropzone 6 does not support Internet Explorer. If you still need
it, use 5.9.3. See the CHANGELOG for everything that
changed in 6.0.0.
Repository layout
This is a monorepo. It holds the library, the documentation and the website:
| | |
| ---------------------------------------- | ------------------------------------------ |
| packages/dropzone | the library published to npm as dropzone |
| apps/docs | the documentation, built with Docusaurus |
| apps/website | www.dropzone.dev, built with SvelteKit |
bash
pnpm install
pnpm build the library and the docs
pnpm test the library's unit tests
pnpm test:e2e the library's browser tests
pnpm dev:docs the documentation, locally
pnpm dev:website the website, locally
Building the deployable site
The website and the documentation are published together as one GitHub Pages
site: the website at the root, the documentation under /docs. One command
produces exactly what gets deployed, in _site/:
bash
pnpm build:site
CI runs the same script, so what you get locally is
what ships. It builds each half with its own toolchain and combines them, which
means there is no manual copTop issues
#1984Heic format conversion via heic2any19 comments · 2021-05-24#2012Dropzonejs Error upload attached file9 comments · 2021-07-26#2067Drop broken after uploading first file7 comments · 2021-11-30#816Problem with combining normal form with file inputs and dropzone7 comments · 2015-01-16#1967Orientation fix vs Image Exif6 comments · 2021-04-28#1930acceptedFiles ignored when uploading through mobile browser.6 comments · 2021-03-10#2243Documentation: Dead external links5 comments · 2023-07-06#2031when i use displayExistingFile function maxFiles does not seem to work5 comments · 2021-09-09
Discussions
#2340Using Python Flask1 comments · 2026-05-17#2339Documentation mistake1 comments · 2025-11-13#2336Processing chunks0 comments · 2025-06-20#2332I use flask-dropzone pypi package and I want to know how to edit the progress bar1 comments · 2025-05-05#2329How do I handle file becoming inaccessible before queue processing?0 comments · 2025-03-19#2327Documentation discrepancy: `maxFileSize` configuration option unit mismatch1 comments · 2025-02-27#2324Integration into the shadowDom0 comments · 2025-01-28#2323Upload different filetypes to different upload-urls2 comments · 2025-01-14
Latest release
[email protected] [email protected] 2026-09-27Patch Changes - 2380 88901b7 - Fix binaryBody uploads sending the original file instead of the transformed one. resizeWidth, resizeHeight and any custom transformFile were silently ignored, so an unresized image went to the server. Chunked and form-data uploads were unaffected. - 2379 eae9121 - Fix cancelling an upload while transformFile is still running. The file had no xhr yet, so it was grouped with every other file that had not started and the whole queue was cancelled with it — and the file itself was still sent once the transform finished.