【简介】
文件拖拽上传插件dropzone.js,提供 AJAX 异步文件上传功能,支持拖拽文件上传、支持最大文件大小、支持设置文件类型、支持预览上传结果,不依赖jQuery库。
【dropzone.js的使用步骤】
1. 建立一个正式的上传form表单,并且给表单一个.dropzone的class
[HTML] 纯文本查看 复制代码
<form id="mydropzone" action="/upload.php" class="dropzone"></form>
就这样,Dropzone会自动找到.dropzone的表单form元素,并且通过action属性,上传到后台接收文件的程序,如upload.php,就像接受一个很普通的file input表单:
[HTML] 纯文本查看 复制代码
<input type="file" name="file" />
然后,在你的upload.php中写上传代码
2. 引入dropzone.js
[HTML] 纯文本查看 复制代码
<script src="dropzone.min.js"></script>
然后什么都不用做了,打开浏览器,测试拖拽上传效果
【不使用from表单的情况】
有一种情况,我们不希望上传的html中有form表单,那么好,我们只要在html中放置一个div#mydropzone
[HTML] 纯文本查看 复制代码
<div id="mydropzone" class="dropzone"></div>
1. 配置一下js调用
[JavaScript] 纯文本查看 复制代码
var myDropzone = new Dropzone("div#mydropzone", { url: "upload.php"});
2. 如果您使用的是jquery,那么jQuery版的可以这样调用:
[JavaScript] 纯文本查看 复制代码
var myDropzone = new Dropzone("div#mydropzone", { url: "upload.php"});
【配置Dropzone】
- Dropzone的特色就在于非常灵活,提供了许多可选项、事件等。下面是Dropzone几个常用的配置项。
- url:最重要的参数,指明了文件提交到哪个页面。
- method:默认为post,如果需要,可以改为put。
- paramName:相当于<input>元素的name属性,默认为file。
- maxFilesize:最大文件大小,单位是 MB。
- maxFiles:默认为null,可以指定为一个数值,限制最多文件数量。
- addRemoveLinks:默认false。如果设为true,则会给文件添加一个删除链接。
- acceptedFiles:指明允许上传的文件类型,格式是逗号分隔的MIME type 或者扩展名。例如:image/*,application/pdf,.psd,.obj
- uploadMultiple:指明是否允许Dropzone 一次提交多个文件。默认为false。如果设为true,则相当于 HTML 表单添加multiple属性。
- headers:如果设定,则会作为额外的 header 信息发送到服务器。例如:{"custom-header":"value"}
- init:一个函数,在 Dropzone 初始化的时候调用,可以用来添加自己的事件监听器。
- forceFallback:Fallback 是一种机制,当浏览器不支持此插件时,提供一个备选方案。默认为false。如果设为true,则强制 fallback。
- fallback:一个函数,如果浏览器不支持此插件则调用。
【翻译选项】
- dictDefaultMessage:没有任何文件被添加的时候的提示文本。
- dictFallbackMessage:Fallback 情况下的提示文本。
- dictInvalidInputType:文件类型被拒绝时的提示文本。
- dictFileTooBig:文件大小过大时的提示文本。
- dictCancelUpload:取消上传链接的文本。
- dictCancelUploadConfirmation:取消上传确认信息的文本。
- dictRemoveFile:移除文件链接的文本。
- dictMaxFilesExceeded:超过最大文件数量的提示文本。
添加事件监听
如果你希望在一个事件发生时采取一些额外的操作,而不干扰 Dropzone 的默认行为,那么你应该通过添加事件监听器的办法对事件做出响应,而非重写默认事件函数。
重写默认事件函数的例子如下:
[JavaScript] 纯文本查看 复制代码
$("#dropz").dropzone({
addedfile: function() {
// actions...
}
});
如果你重写默认事件函数,该事件发生时插件默认采取的动作将被覆盖。大多数情况下你仅仅想在事件发生时添加自己的行为,那么应该使用on方法。
jQuery 版本
[JavaScript] 纯文本查看 复制代码
$("#dropz").dropzone({
init: function() {
this.on("addedfile", function(file) {
// actions...
});
}
});
非 jQuery 版本:
[JavaScript] 纯文本查看 复制代码
dropz.on("addedfile", function(file) {
// actions...
});
【常用事件】
以下事件接收 file 为第一个参数
addedfile:添加了一个文件时发生。
removedfile:一个文件被移除时发生。你可以监听这个事件并手动从服务器删除这个文件。
uploadprogress:上传时按一定间隔发生这个事件。第二个参数为一个整数,表示进度,从 0 到 100。第三个参数是一个整数,表示发送到服务器的字节数。当一个上传结束时,Dropzone 保证会把进度设为 100。注意:这个函数可能被以同一个进度调用多次。
success:文件成功上传之后发生,第二个参数为服务器响应。
complete:当文件上传成功或失败之后发生。
canceled:当文件在上传时被取消的时候发生。
maxfilesreached:当文件数量达到最大时发生。
maxfilesexceeded:当文件数量超过限制时发生。
以下事件接收一个 file list 作为第一个参数(仅当uploadMultiple被设为true时才会发生)
successmultiple
completemultiple
cancelmultiple
【案例】
Css代码就不放上来了,可以由自己控制,主要演示js代码
[JavaScript] 纯文本查看 复制代码
<div class="dropz"></div>
<script>
$(".dropz").dropzone({
url: "handle-upload.php",
addRemoveLinks: true,
dictRemoveLinks: "x",
dictCancelUpload: "x",
maxFiles: 10,
maxFilesize: 5,
acceptedFiles: ".js",
init: function() {
this.on("success", function(file) {
console.log("File " + file.name + "uploaded");
});
this.on("removedfile", function(file) {
console.log("File " + file.name + "removed");
});
}
});
</script>
【效果】