Bootstrap FileInput中文API整理
这段时间做项目用到bootstrap fileinput插件上传文件，在用的过程中，网上能查到的api都不是很全，所以想着整理一份比较详细的文档，方便自己今后使用，也希望能给大家带来帮助，如有错误，希望大家积极指正。
一、 引入文件
<link href="../css/bootstrap.min.css"rel="stylesheet">
<link href="../css/fileinput.css" media="all"rel="stylesheet" type="text/css" />
<scriptsrc="../js/jQuery-2.0.3.min.js"></script>
<script src="../js/fileinput.js"type="text/JavaScript"></script>
<script src="../js/bootstrap.min.js"type="text/javascript"></script>
二、 初始化设置：
$("#uploadfile").fileinput({
language: 'zh', //设置语言
uploadUrl:"http://127.0.0.1/testDemo/fileupload/upload.do", //上传的地址
allowedFileExtensions: ['jpg', 'gif', 'png'],//接收的文件后缀
//uploadExtraData:{"id": 1, "fileName":'123.mp3'},
uploadAsync: true, //默认异步上传
showUpload:true, //是否显示上传按钮
showRemove :true, //显示移除按钮
showPreview :true, //是否显示预览
showCaption:false,//是否显示标题
browseClass:"btn btn-primary", //按钮样式
dropZoneEnabled: false,//是否显示拖拽区域
//minImageWidth: 50, //图片的最小宽度
//minImageHeight: 50,//图片的最小高度
//maxImageWidth: 1000,//图片的最大宽度
//maxImageHeight: 1000,//图片的最大高度
//maxFileSize:0,//单位为kb，如果为0表示不限制文件大小
//minFileCount: 0,
maxFileCount:10, //表示允许同时上传的最大文件个数
enctype:'multipart/form-data',
validateInitialCount:true,
previewFileIcon: "<iclass='glyphicon glyphicon-king'></i>",
msgFilesTooMany: "选择上传的文件数量({n}) 超过允许的最大数值{m}！",
}).on("fileuploaded", function (event, data, previewId, index){
});
三、 Options 说明：
|
属性名 |
属性类型 |
描述说明 |
默认值 |
|
language |
String |
多语言设置，使用时需提前引入locales文件夹下对应的语言文件，中文zh，引入语言文件必须放在fileinput.js之后 |
'en' |
|
showCaption |
Boolean |
是否显示被选文件的简介 |
true |
|
showBrowse |
Boolean |
是否显示浏览按钮 |
true |
|
showPreview |
Boolean |
是否显示预览区域 |
true |
|
showRemove |
Boolean |
是否显示移除按钮 |
true, |
|
showUpload |
Boolean |
是否显示上传按钮 |
true, |
|
showCancel |
Boolean |
是否显示取消按钮 |
true, |
|
showClose: |
Boolean |
是否显示关闭按钮 |
true |
|
showUploadedThumbs |
Boolean |
true |
|
|
browseOnZoneClick |
Boolean |
false |
|
|
autoReplace |
Boolean |
是否自动替换当前图片，设置为true时，再次选择文件，会将当前的文件替换掉。 |
false |
|
generateFileId |
Object |
null |
|
|
previewClass |
String |
添加预览按钮的类属性 |
‘’ |
|
captionClass |
String |
‘’ |
|
|
frameClass |
String |
'krajee-default' |
|
|
mainClass |
String |
'file-caption-main' |
|
|
mainTemplate |
Object |
null |
|
|
purifyHtml |
Boolean |
true |
|
|
fileSizeGetter |
Object |
null |
|
|
initialCaption |
String |
'' |
|
|
initialPreview |
Array/Object |
[] |
|
|
initialPreviewDelimiter |
String |
'*$$*' |
|
|
initialPreviewAsData |
Boolean |
false |
|
|
initialPreviewFileType |
String |
'image' |
|
|
initialPreviewConfig |
Array/Object |
[] |
|
|
initialPreviewThumbTags |
Array/Object |
[] |
|
|
previewThumbTags |
Object |
{} |
|
|
initialPreviewShowDelete |
Boolean |
true |
|
|
removeFromPreviewOnError |
Boolean |
false |
|
|
deleteUrl |
String |
删除图片时的请求路径 |
'' |
|
deleteExtraData |
Object |
删除图片时额外传入的参数 |
{} |
|
overwriteInitial |
Boolean |
true |
|
|
previewZoomButtonIcons |
Object |
{ prev: '<i class="glyphicon glyphicon-triangle-left"></i>', next: '<i class="glyphicon glyphicon-triangle-right"></i>', toggleheader: '<i class="glyphicon glyphicon-resize-vertical"></i>', fullscreen: '<i class="glyphicon glyphicon-fullscreen"></i>', borderless: '<i class="glyphicon glyphicon-resize-full"></i>', close: '<i class="glyphicon glyphicon-remove"></i>' }, |
|
|
previewZoomButtonClasses |
Object |
{ prev: 'btn btn-navigate', next: 'btn btn-navigate', toggleheader: 'btn btn-default btn-header-toggle', fullscreen: 'btn btn-default', borderless: 'btn btn-default', close: 'btn btn-default' }, |
|
|
preferIconicPreview |
Boolrean |
false |
|
|
preferIconicZoomPreview |
Boolrean |
false |
|
|
allowedPreviewTypes |
undefined |
undefined |
|
|
allowedPreviewMimeTypes |
Object |
null |
|
|
allowedFileTypes |
Object |
接收的文件后缀，如['jpg', 'gif', 'png'],不填将不限制上传文件后缀类型 |
null |
|
allowedFileExtensions |
Object |
null |
|
|
defaultPreviewContent |
Object |
null |
|
|
customLayoutTags |
Object |
{} |
|
|
customPreviewTags |
Object |
{} |
|
|
previewFileIcon |
String |
'<i class="glyphicon glyphicon-file"></i>' |
|
|
previewFileIconClass |
String |
'file-other-icon' |
|
|
previewFileIconSettings |
Object |
{} |
|
|
previewFileExtSettings |
Object |
{} |
|
|
buttonLabelClass |
String |
'hidden-xs' |
|
|
browseIcon |
String |
'<i class="glyphicon glyphicon-folder-open"></i> ' |
|
|
browseClass |
String |
'btn btn-primary' |
|
|
removeIcon |
String |
'<i class="glyphicon glyphicon-trash"></i>' |
|
|
removeClass |
String |
'btn btn-default' |
|
|
cancelIcon |
String |
'<i class="glyphicon glyphicon-ban-circle"></i>' |
|
|
cancelClass |
String |
'btn btn-default' |
|
|
uploadIcon |
String |
'<i class="glyphicon glyphicon-upload"></i>' |
|
|
uploadClass |
String |
'btn btn-default' |
|
|
uploadUrl |
String |
上传文件路径 |
null |
|
uploadAsync |
boolean |
是否为异步上传 |
true |
|
uploadExtraData |
上传文件时额外传递的参数设置 |
{} |
|
|
zoomModalHeight |
number |
480 |
|
|
minImageWidth |
String |
图片的最小宽度 |
null |
|
minImageHeight |
String |
图片的最小高度 |
null |
|
maxImageWidth |
String |
图片的最大宽度 |
null |
|
maxImageHeight |
String |
图片的最大高度 |
null |
|
resizeImage |
boolean |
false |
|
|
resizePreference |
String |
'width' |
|
|
resizeQuality |
number |
0.92 |
|
|
resizeDefaultImageType |
String |
'image/jpeg' |
|
|
minFileSize |
number |
单位为kb，上传文件的最小大小值 |
0 |
|
maxFileSize |
number |
单位为kb，如果为0表示不限制文件大小 |
0 |
|
resizeDefaultImageType |
number |
25600(25MB) |
|
|
minFileCount |
number |
表示同时最小上传的文件个数 |
0 |
|
maxFileCount |
number |
表示允许同时上传的最大文件个数 |
0 |
|
validateInitialCount |
boolean |
false |
|
|
msgValidationErrorClass |
String |
'text-danger' |
|
|
msgValidationErrorIcon |
String |
'<i class="glyphicon glyphicon-exclamation-sign"></i> ' |
|
|
msgErrorClass |
String |
'file-error-message' |
|
|
progressThumbClass |
String |
"progress-bar progress-bar-success progress-bar-striped active" |
|
|
rogressClass |
String |
"progress-bar progress-bar-success progress-bar-striped active" |
|
|
progressCompleteClass |
String |
"progress-bar progress-bar-success" |
|
|
progressErrorClass |
String |
"progress-bar progress-bar-danger" |
|
|
progressUploadThreshold |
number |
99 |
|
|
previewFileType |
String |
预览文件类型,内置['image', 'html', 'text', 'video', 'audio', 'flash', 'object',‘other‘]等格式 |
'image' |
|
elCaptionContainer |
String |
null |
|
|
elCaptionText |
String |
设置标题栏提示信息 |
null |
|
elPreviewContainer |
String |
null |
|
|
elPreviewImage |
String |
null |
|
|
elPreviewStatus |
String |
null |
|
|
elErrorContainer |
String |
null |
|
|
errorCloseButton |
String |
'<span class="close kv-error-close">×</span>' |
|
|
slugCallback |
String |
null |
|
|
dropZoneEnabled |
boolean |
是否显示拖拽区域 |
true |
|
dropZoneTitleClass |
String |
拖拽区域类属性设置 |
'file-drop-zone-title' |
|
fileActionSettings |
Object |
{} |
|
|
otherActionButtons |
String |
'' |
|
|
textEncoding |
String |
编码设置 |
'UTF-8' |
|
ajaxSettings |
Object |
{} |
|
|
ajaxDeleteSettings |
Object |
{} |
|
|
showAjaxErrorDetails |
boolean |
true |
四、 提示说明设置：
五、 Method说明：
|
方法名 |
参数 |
描述 |
|
fileerror |
异步上传错误结果处理 $('#uploadfile').on('fileerror', function(event, data, msg) {
}); |
|
|
fileuploaded |
异步上传成功结果处理 $("#uploadfile").on("fileuploaded", function (event, data, previewId, index) {
}) |
|
|
filebatchuploaderror |
同步上传错误结果处理 $('#uploadfile').on('filebatchuploaderror', function(event, data, msg) {
}); |
|
|
filebatchuploadsuccess |
同步上传成功结果处理 $('#uploadfile').on('filepreupload', function(event, data, previewId, index) {
}); |
|
|
filebatchselected |
选择文件后处理事件 $("#fileinput").on("filebatchselected", function(event, files) { }); |
|
|
upload |
文件上传方法 $("#fileinput").fileinput("upload"); |
|
|
fileuploaded |
上传成功后处理方法 $("#fileinput").
|
|
|
filereset |
||
|
fileclear |
点击浏览框右上角X 清空文件前响应事件 $("#fileinput").on("fileclear",function(event, data, msg){ }); |
|
|
filecleared |
点击浏览框右上角X 清空文件后响应事件 $("#fileinput").on("filecleared",function(event, data, msg){ }); |
|
|
fileimageuploaded |
在预览框中图片已经完全加载完毕后回调的事件 |
六、 常见错误：
(1) 当点击上传后，报错，提示你必须选择最少X个文件上传。
错误原因:html中input标签元素属性：data-min-file-count="2" 设置为X个文件，限制上传文件数。