Skip to content

Latest commit

 

History

History
120 lines (85 loc) · 3.63 KB

README.md

File metadata and controls

120 lines (85 loc) · 3.63 KB
Raw

Dropzone.js

npm version Validate CodeQL

Fork

This fork exists because upstream isn't maintained anymore. Its goal is to maintain this library in a good state, with mainly bugfixes and possibly minor improvements.

the new package name is @deltablot/dropzone

Description

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 is fully configurable, can be styled according to your needs and is trusted by thousands.

Dropzone Screenshot

Quickstart

Install:

$ npm install --save @deltablot/dropzone
# or with yarn:
$ yarn add @deltablot/dropzone
# or with bun:
$ bun add @deltablot/dropzone

First argument is an element to bind to, second argument is the options object.

Use as ES6 module (recommended):

import { Dropzone } from "@deltablot/dropzone";
const dropzone = new Dropzone("#elementId", { url: "/file/post" });

or use as CommonJS module:

const { Dropzone } = require("@deltablot/dropzone");
const dropzone = new Dropzone("#elementId", { url: "/file/post" });

👉 Checkout our example implementations for different bundlers

CSS

@import "@deltablot/dropzone/src/dropzone";

Not using a package manager or bundler?

Use the standalone files like this:

<script src="https://unpkg.com/@deltablot/dropzone@7/dist/dropzone-min.js"></script>
<link
  rel="stylesheet"
  href="https://unpkg.com/@deltablot/dropzone@7/dist/dropzone.css"
  type="text/css"
/>

<div class="my-dropzone"></div>

<script>
  // Dropzone has been added as a global variable.
  const dropzone = new Dropzone(".my-dropzone", { url: "/file/post" });
</script>

Community

If you need support please open an issue.

If you have a feature request or want to discuss something, please use the issues as well.

Main features ✅

  • Beautiful by default
  • Image thumbnail previews. Simply register the callback thumbnail(file, data) and display the image wherever you like
  • High-DPI screen support
  • Multiple files and synchronous uploads
  • Progress updates
  • Support for large files
    • Chunked uploads (upload large files in smaller chunks)
  • Support for Amazon S3 Multipart upload
  • Complete theming. The look and feel of Dropzone is just the default theme. You can define everything yourself by overwriting the default event listeners.
  • Browser image resizing (resize the images before you upload them to your server)
  • Well tested

MIT License

See the LICENSE file