Dropzone
Search…
Getting Started
Configuration
Miscellaneous
📞
Events
Dropzone triggers events when processing files, to which you can register easily, by calling
.on(eventName, callbackFunction) on your Dropzone instance:1
let myDropzone = Dropzone("#my-element", { /* options */ });
2
myDropzone.on("addedfile", file => {
3
console.log("A file has been added");
4
});
Copied!
If you're configuring your Dropzone declaratively, then you don't have access to the instance to add events. In these case, you can use the
init config, which is a function that is invoked when the Dropzone is initialized:1
Dropzone.options.myElement = {
2
// Note: using "function()" here to bind `this` to
3
// the Dropzone instance.
4
init: function() {
5
this.on("addedfile", file => {
6
console.log("A file has been added");
7
});
8
}
9
};
Copied!
Careful: when providing the init function, make sure you use the
function() syntax instead of the arrow syntax, because otherwise the keyword this will not reference the Dropzone instance. For more information read up on the difference between the arrow function expression and the function expression.Both ways are perfectly fine, but you need to use the
init() function if you setup your Dropzone declaratively.Dropzone itself relies heavily on events. Everything that’s visual is created by listening to them. They are a fundamental part of making Dropzone look and feel how you want it to.
List of all events
We will be listing all possible events here soon, but until we do that, you can find all of them, well documented in the source code. These are the implementations for the default event handles so you can see which arguments they receive. You can ignore the content of them if you aren't interested, or override the default behaviour (explained in the next section).
Overriding default event handlers
In general you should never have to do this, and you should be familiar with the code if you decide to do it.
You can also override default event handlers. This should be approached with absolute caution since it can break if you upgrade the library and can also remove default functionality that you might not want to lose:
1
let myDropzone = Dropzone("#my-element", {
2
addedfile: file => {
3
// ONLY DO THIS IF YOU KNOW WHAT YOU'RE DOING!
4
}
5
});
Copied!
The difference here, is that the default event handler
addedfile has been changed, instead of adding a new event handler with myDropzone.on("addedfile", () => {})You should only do this when you really know how Dropzone works, and when you want to completely theme your Dropzone.
Last modified 5mo ago
Copy link