Bootstrap FileInput 图片上传插件

最近找了一个比较好用的图片和文件上传插件,Bootstrap-file input插件功能如此强大,样式非常美观,并且支持上传文件预览,ajax同步或异步上传,无论是aspx.net 还是MVC.net 都适合,拖曳文件上传等炫酷的功能,完全没有理由不去使用,但是国内很少能找到本插件完整的使用方法。

BootstrapFileInput项目地址:https://github.com/kartik-v/bootstrap-fileinput

下载地址:https://github.com/kartik-v/b...
API文档 :http://plugins.krajee.com/fil...
D E M O:http://plugins.krajee.com/fil...

目录

引言:

使用教程:

Options 属性说明

提示说明设置

Method方法说明


引言:

一个强化的HTML5 文件输入插件,适用于Bootstrap 3.x。本插件对多种类型的文件提供文件预览,并且提供了多选等功能。本插件还提供给你一个简单的方式去安装一个先进的文件选择/上传控制版本去配合Bootstrap CSS3样式。通过对很多种文件提供预览支持,比如图片,文本,html,视频,声音,flash和对象,它大大增强了文件输入的功能。另外,它还包含基于AJAX的上传,拖拽,移除文件的功能,可视化的上传进度条,和可选择的添加或删除文件预览功能。

提示:本插件致力于使用大量在添加jquery下的css3和html5功能,强调:你可能会发现css3或html5或它两个的混合在许多实现中被需要。

本插件最早受一篇博文和Jasny'sFile Input plugin启发。但是本插件现在已经添加的好多功能和强化,为开发者提供了一个成熟并且完整的文件管理工具和解决方案。

 

伴随着4.0.0版本的发布,本插件现在支持被多种现代化浏览器支持的,基于Ajax,利用html5 Formdata和XHR2协议的上传。而且她也拥有了对在服务器端基于AJAX的文件删除原生内置支持。因此它可以添加更加强大的功能,联机添加、移除文件。本插件也对大多数现代浏览器添加了拖拉,移除支持。它也已经为Ajax上传提供原生支持。万一,浏览器不支持FormData或XHR2,本插件会降级成一个普通表单。

先看官方示例demo:

使用教程:

接下来我给大家演示一下我的使用过程,一般情况下,我们需要引入下面三个文件,插件才能正常使用,其中一个是汉化包:

<link href="bootstrap-fileinput/css/fileinput.css" rel="stylesheet">
<script src="bootstrap-fileinput/js/fileinput.js" type="text/javascript"></script>
<script src="bootstrap-fileinput/js/fileinput_locale_zh.js" type="text/javascript"></script><!--汉化中文语言包--> 

但是,我们还需要引用Bootstrap文件,因为这个上传插件是在Bootstrap下支持的,如果不引用,样式就没有了:

<link href="/bootstrap/css/bootstrap.min.css" rel="stylesheet">
<script src="/bootstrap/js/jquery-2.0.3.min.js"></script>
<script src="/bootstrap/js/bootstrap.min.js" type="text/javascript"></script>

简单的界面效果和众多上传文件控件一样,可以接受各种类型的文件。当然,我们也可以指定具体接受的文件类型等功能。

前端页面示例代码(下面代码仅展示了简单的上传,更多属性稍后讲解)

<!--html代码放置上传控件代码-->
<span style="font-size:16px;">普通上传</span>
<input id="uploadImg" class="file" type="file" multiple data-min-file-count="1">
<br>
<button type="submit" class="btn btn-primary">上传</button>
<button type="reset" class="btn btn-default">重置</button>
 
<!--javascript代码初始化上传控件-->
<script>
//初始化fileinput
initFileInput();
function initFileInput() {
    $("#uploadImg").fileinput({
        uploadUrl: "upload/UpdatePhoto", //上传的地址
        allowedFileExtensions : ['jpg', 'png','gif'],//指定待上传文件后缀
        //fileType: "any", // “any”表示允许上传任何类型的文件
        showUpload: false, //是否显示上传按钮
        showCaption: false,//是否显示标题
        browseClass: "btn btn-primary", //按钮样式 
        overwriteInitial: false,//重新初始化
        maxFileSize: 1000,// 文件允许上传的最大size,单位kb
        maxFilesNum: 10,  //最多上传数量
        previewFileIcon: "<i class='glyphicon glyphicon-king'></i>",//当检测到用于预览的不可读文件类型时,将在每个预览文件缩略图中显示的图标。默认为<i class="glyphicon glyphicon-file"></i>  
        layoutTemplates:{
            actionUpload:''//去除上传预览缩略图中的上传图片
            actionZoom:'',   //去除上传预览缩略图中的查看详情预览的缩略图标
            actionDownload:'' //去除上传预览缩略图中的下载图标
            actionDelete:'', //去除上传预览的缩略图中的删除图标
        },//对象用于渲染布局的每个部分的模板配置。您可以设置以下模板来控制窗口小部件布局.eg:去除上传图标
        msgFilesTooMany: "选择上传的文件数量({n}) 超过允许的最大数值{m}!",//字符串,当文件数超过设置的最大计数时显示的消息 maxFileCount。默认为:选择上传的文件数({n})超出了允许的最大限制{m}。请重试您的上传!
    }).on('filebatchpreupload', function(event, data) { //该方法将在上传之前触发
        var id = $('#id option:selected').val();
        if(id == 0){
            return {
                message: "请选择", // 验证错误信息在上传前要显示。如果设置了这个设置,插件会在调用时自动中止上传,并将其显示为错误消息。您可以使用此属性来读取文件并执行自己的自定义验证
                data:{} // any other data to send that can be referred in `filecustomerror`
            };
        }
    });
}
//fileuploaded此事件仅针对ajax上传触发,并在每个缩略图文件上传完成后触发。此事件仅针对ajax上传并在以下情况下触发:当点击每个预览缩略图中的上传图标并且文件上传成功时,或者当你有 uploadAsync设置为true您已触发批量上传。在这种情况下,fileuploaded每一个人选择的文件被上传成功后,触发事件。
var id_str = '';
$('#uploadImg').on('fileuploaded', function(event, data, previewId, index) {
    if(typeof(data.response.id) != 'undefined'){
        id_str = id_str+data.response.id+',';
    }
});
// filebatchuploadcomplete此事件仅在ajax上传和完成同步或异步ajax批量上传后触发。
$('#uploadImg').on('filebatchuploadcomplete',function (event,files,extra) {
    if(id_str.length == 0){
        layer.msg('上传失败', {icon: 0});//弹框提示
        return false;
    }
    setTimeout(function(){ //执行延时关闭
        closeSelf();
    },1000);
});
   
</script>

后台MVC模式接收上传代码:

/// <summary>
/// 上传照片
/// </summary>
/// <param name="id">用户的ID</param>
/// <returns></returns>
public ActionResult UpdatePhoto(string uid)
{
    try
    {
        var files = Request.Files;
        if (files != null && files.Count > 0)
        {
            var fileData = FileHelper.ConvertStreamToByteBuffer(files[0].InputStream);
            var fileName = files[0].FileName;
            bool remsg = SaveFile(fileData, fileName);
            return Content(new AjaxResult { state = ResultType.success.ToString(), message = "fileName" }.ToJson());
        }
        else
        {
            return Content(new AjaxResult { state = ResultType.error.ToString(), message = "error" }.ToJson());
        }
    }
    catch (Exception ex)
    {
        return Content(new AjaxResult { state = ResultType.error.ToString(), message = ex.Message }.ToJson());
    }

}

/// <summary>
/// 文件流上传文件
/// </summary>
/// <param name="binData">字节数组</param>
/// <param name="fileName">文件物理路径含文件名</param>
private bool SaveFile(byte[] binData, string fullName)
{
    FileStream fileStream = null;
    MemoryStream m = new MemoryStream(binData);
    try
    {
        fileStream = new FileStream(fullName, FileMode.Create);
        m.WriteTo(fileStream);
        return true;
    }
    catch
    {
        return false;
    }
    finally
    {
        m.Close();
        fileStream.Close();
    }
}

 

fileinput 的属性和参数有两种方式可以实现,一种是通过JavaScript来初始化,一种是在<input type='flie' data-> 控件的 data-后面初始化;

官方文档为英文文档,看起来有些费劲,我在网上找了一篇文章对属性,方法和世间都描述的很清楚的文章,以下部分内容的表格出处来源于:https://segmentfault.com/a/1190000018477200

Options 属性说明

属性名属性类型描述说明默认值
languageString多语言设置,使用时需提前引入locales文件夹下对应的语言文件,中文zh,引入语言文件必须放在fileinput.js之后'en'
showCaptionBoolean是否显示被选文件的简介true
showBrowseBoolean是否显示浏览按钮true
showPreviewBoolean是否显示预览区域true
showRemoveBoolean是否显示移除按钮true,
showUploadBoolean是否显示上传按钮true,
showCancelBoolean是否显示取消按钮true,
showClose:Boolean是否显示关闭按钮true
showUploadedThumbsBoolean true
browseOnZoneClickBoolean false
autoReplaceBoolean是否自动替换当前图片,设置为true时,再次选择文件, 会将当前的文件替换掉。false
generateFileIdObject null
previewClassString添加预览按钮的类属性‘’
captionClassString ‘’
frameClassString 'krajee-default'
mainClassString 'file-caption-main'
mainTemplateObject null
purifyHtmlBoolean true
fileSizeGetterObject null
initialCaptionString ''
initialPreviewArray/Object []
initialPreviewDelimiterString '$$'
initialPreviewAsDataBoolean false
initialPreviewFileTypeString 'image'
initialPreviewConfigArray/Object []
initialPreviewThumbTagsArray/Object []
previewThumbTagsObject {}
initialPreviewShowDeleteBoolean true
removeFromPreviewOnErrorBoolean false
deleteUrlString删除图片时的请求路径''
deleteExtraDataObject删除图片时额外传入的参数{}
overwriteInitialBoolean true
previewZoomButtonIconsObject {prev: '',next: '',toggleheader: '',fullscreen: '',borderless: '',close: ''},
previewZoomButtonClassesObject {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'},
preferIconicPreviewBoolrean false
preferIconicZoomPreviewBoolrean false
allowedPreviewTypesundefined undefined
allowedPreviewMimeTypesObject null
allowedFileTypesObject接收的文件后缀,如['jpg', 'gif', 'png'],不填将不限制上传文件后缀类型null
allowedFileExtensionsObject null
defaultPreviewContentObject null
customLayoutTagsObject {}
customPreviewTagsObject {}
previewFileIconString ''
previewFileIconClassString 'file-other-icon'
previewFileIconSettingsObject {}
previewFileExtSettingsObject {}
buttonLabelClassString 'hidden-xs'
browseIconString ' '
browseClassString 'btn btn-primary'
removeIconString ''
removeClassString 'btn btn-default'
cancelIconString ''
cancelClassString 'btn btn-default'
uploadIconString ''
uploadClassString 'btn btn-default'
uploadUrlString上传文件路径null
uploadAsyncboolean是否为异步上传true
uploadExtraData 上传文件时额外传递的参数设置{}
zoomModalHeightnumber 480
minImageWidthString图片的最小宽度null
minImageHeightString图片的最小高度null
maxImageWidthString图片的最大宽度null
maxImageHeightString图片的最大高度null
resizeImageboolean false
resizePreferenceString 'width'
resizeQualitynumber 0.92
resizeDefaultImageTypeString 'image/jpeg'
minFileSizenumber单位为kb,上传文件的最小大小值0
maxFileSizenumber单位为kb,如果为0表示不限制文件大小0
resizeDefaultImageTypenumber 25600(25MB)
minFileCountnumber表示同时最小上传的文件个数0
maxFileCountnumber表示允许同时上传的最大文件个数0
validateInitialCountboolean false
msgValidationErrorClassString 'text-danger'
msgValidationErrorIconString ' '
msgErrorClassString 'file-error-message'
progressThumbClassString "progress-bar progress-bar-success progress-bar-striped active"
rogressClassString "progress-bar progress-bar-success progress-bar-striped active"
progressCompleteClassString "progress-bar progress-bar-success"
progressErrorClassString "progress-bar progress-bar-danger"
progressUploadThresholdnumber 99
previewFileTypeString预览文件类型,内置['image', 'html', 'text', 'video', 'audio', 'flash', 'object',‘other‘]等格式'image'
elCaptionContainerString null
elCaptionTextString设置标题栏提示信息null
elPreviewContainerString null
elPreviewImageString null
elPreviewStatusString null
elErrorContainerString null
errorCloseButtonString '<span class="close kv-error-close">×</span>'
slugCallbackfunction选择后未上传前 回调方法null
dropZoneEnabledboolean是否显示拖拽区域true
dropZoneTitleClassString拖拽区域类属性设置'file-drop-zone-title'
fileActionSettingsObject设置预览图片的显示样式{showRemove: true,showUpload: false,showZoom: true,showDrag: true,removeIcon: '',removeClass: 'btn btn-xs btn-default',removeTitle: 'Remove file',uploadIcon: '',uploadClass: 'btn btn-xs btn-default',uploadTitle: 'Upload file',zoomIcon: '',zoomClass: 'btn btn-xs btn-default',zoomTitle: 'View Details',dragIcon: '',dragClass: 'text-info',dragTitle: 'Move / Rearrange',dragSettings: {},indicatorNew: '',indicatorSuccess: '',indicatorError: '',indicatorLoading: '',indicatorNewTitle: 'Not uploaded yet',indicatorSuccessTitle: 'Uploaded',indicatorErrorTitle: 'Upload Error',indicatorLoadingTitle: 'Uploading ...'}
otherActionButtonsString ''
textEncodingString编码设置'UTF-8'
ajaxSettingsObject {}
ajaxDeleteSettingsObject {}
showAjaxErrorDetailsboolean true

提示说明设置

属性名默认值中文
fileSinglefile文件
filePluralfiles个文件
browseLabelBrowse &hellip选择 …
removeLabelRemove移除
removeTitleClear selected files清除选中文件
cancelLabelCancel取消
cancelTitleAbort ongoing upload取消进行中的上传
uploadLabelUpload上传
uploadTitleUpload selected files上传选中文件
msgNoNo没有
msgNoFilesSelectedNo files selected“”
msgCancelledCancelled取消
msgZoomModalHeadingDetailed Preview详细预览
msgSizeTooSmallFile "{name}" ({size} KB) is too small and must be larger than {minSize} KB.File "{name}" ({size} KB) is too small and must be larger than {minSize} KB.
msgSizeTooLargeFile "{name}" ({size} KB) exceeds maximum allowed upload size of {maxSize} KB.文件 "{name}" ({size} KB) 超过了允许大小 {maxSize} KB.
msgFilesTooLessYou must select at least {n} {files} to upload.你必须选择最少 {n} {files} 来上传.
msgFilesTooManyNumber of files selected for upload ({n}) exceeds maximum allowed limit of {m}.选择的上传文件个数 ({n}) 超出最大文件的限制个数 {m}.
msgFileNotFoundFile "{name}" not found!文件 "{name}" 未找到!
msgFileSecuredSecurity restrictions prevent reading the file "{name}".安全限制,为了防止读取文件 "{name}".
msgFileNotReadableFile "{name}" is not readable.文件 "{name}" 不可读.
msgFilePreviewAbortedFile preview aborted for "{name}".取消 "{name}" 的预览.
msgFilePreviewErrorAn error occurred while reading the file "{name}".读取 "{name}" 时出现了一个错误.
msgInvalidFileNameInvalid or unsupported characters in file name "{name}".Invalid or unsupported characters in file name "{name}".
msgInvalidFileTypeInvalid type for file "{name}". Only "{types}" files are supported.不正确的类型 "{name}". 只支持 "{types}" 类型的文件.
msgInvalidFileExtensionInvalid extension for file "{name}". Only "{extensions}" files are supported.不正确的文件扩展名 "{name}". 只支持 "{extensions}" 的文件扩展名.
msgFileTypes{'image': 'image','html': 'HTML','text': 'text','video': 'video','audio': 'audio','flash': 'flash','pdf': 'PDF','object': 'object'},{'image': 'image','html': 'HTML','text': 'text','video': 'video','audio': 'audio','flash': 'flash','pdf': 'PDF','object': 'object'},
msgUploadAbortedThe file upload was aborted该文件上传被中止
msgUploadThresholdProcessing...Processing...
msgUploadBeginInitializing...Initializing...
msgUploadEndDoneDone
msgUploadEmptyNo valid data available for upload.No valid data available for upload.
msgValidationErrorValidation Error验证错误
msgLoadingLoading file {index} of {files} …加载第 {index} 文件 共 {files} …
msgProgressLoading file {index} of {files} - {name} - {percent}% completed.加载第 {index} 文件 共 {files} - {name} - {percent}% 完成.
msgSelected{n} {files} selected{n} {files} 选中
msgFoldersNotAllowedDrag & drop files only! {n} folder(s) dropped were skipped.只支持拖拽文件! 跳过 {n} 拖拽的文件夹.
msgImageWidthSmallWidth of image file "{name}" must be at least {size} px.宽度的图像文件的"{name}"的必须是至少{size}像素.
msgImageHeightSmallHeight of image file "{name}" must be at least {size} px.图像文件的"{name}"的高度必须至少为{size}像素.
msgImageWidthLargeWidth of image file "{name}" cannot exceed {size} px.宽度的图像文件"{name}"不能超过{size}像素.
msgImageHeightLargeHeight of image file "{name}" cannot exceed {size} px.图像文件"{name}"的高度不能超过{size}像素.
msgImageResizeErrorCould not get the image dimensions to resize.无法获取的图像尺寸调整。
msgImageResizeExceptionError while resizing the image.<pre>{errors}</pre>错误而调整图像大小。<pre>{errors}</pre>
msgAjaxErrorSomething went wrong with the {operation} operation. Please try again later!Something went wrong with the {operation} operation. Please try again later!
msgAjaxProgressError{operation} failed{operation} failed
ajaxOperations{deleteThumb: 'file delete', uploadThumb: 'file upload', uploadBatch: 'batch file upload', uploadExtra: 'form data upload' },{deleteThumb: 'file delete',uploadThumb: 'file upload', uploadBatch: 'batch file upload',uploadExtra: 'form data upload'},
dropZoneTitleDrag & drop files here …拖拽文件到这里 …
支持多文件同时上传
dropZoneClickTitle
(or click to select {files})

(或点击{files}按钮选择文件)
previewZoomButtonTitles{prev: 'View previous file',next: 'View next file', toggleheader: 'Toggle header',fullscreen: 'Toggle full screen', borderless: 'Toggle borderless mode', close: 'Close detailed preview' }{ prev: '预览上一个文件',next: '预览下一个文件',toggleheader: '缩放', fullscreen: '全屏', borderless: '无边界模式',close: '关闭当前预览'}
fileActionSettings 

{ removeTitle: '删除文件',uploadTitle: '上传文件',zoomTitle: '查看详情',dragTitle: '移动 / 重置',indicatorNewTitle: '没有上传', indicatorSuccessTitle: '上传',indicatorErrorTitle: '上传错误', indicatorLoadingTitle: '上传 ...'},

 

 

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").on("fileuploaded", function(event, data, previewId, index) {});
filereset 
fileclear点击浏览框右上角X 清空文件前响应事件$("#fileinput").on("fileclear",function(event, data, msg){});
filecleared点击浏览框右上角X 清空文件后响应事件$("#fileinput").on("filecleared",function(event, data, msg){});
fileimageuploaded在预览框中图片已经完全加载完毕后回调的事件
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值