本文主要是介绍slice-uploader切片上传,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
slice-uploader
一个基于 simple-uploader.js 的 Vue 上传组件
特性
-
支持文件、多文件、文件夹上传
-
支持拖拽文件、文件夹上传
-
统一对待文件和文件夹,方便操作管理
-
可暂停、继续上传
-
错误处理
-
支持“快传”,通过文件判断服务端是否已存在从而实现“快传”
-
上传队列管理,支持最大并发上传
-
分块上传
-
支持进度、预估剩余时间、出错自动重试、重传等操作
安装
npm install vue-simple-uploader --save
笔记周边
使用
初始化
import Vue from 'vue'
import uploader from '@/components/slice-uploader'Vue.use(uploader)/* eslint-disable no-new */
new Vue({render(createElement) {return createElement(App)}
}).$mount('#app')
App.vue
<template><uploader :options="options" class="uploader-example"><uploader-unsupport></uploader-unsupport><uploader-drop><p>Drop files here to upload or</p><uploader-btn>select files</uploader-btn><uploader-btn :attrs="attrs">select images</uploader-btn><uploader-btn :directory="true">select folder</uploader-btn></uploader-drop><uploader-list></uploader-list></uploader>
</template><script>export default {data () {return {options: {// https://github.com/simple-uploader/Uploader/tree/develop/samples/Node.jstarget: '//localhost:3000/upload',testChunks: false},attrs: {accept: 'image/*'}}}}
</script><style>.uploader-example {width: 880px;padding: 15px;margin: 40px auto 0;font-size: 12px;box-shadow: 0 0 10px rgba(0, 0, 0, .4);}.uploader-example .uploader-btn {margin-right: 4px;}.uploader-example .uploader-list {max-height: 440px;overflow: auto;overflow-x: hidden;overflow-y: auto;}
</style>
组件
Uploader
上传根组件,可理解为一个上传器。
Props
-
options {Object}
参考 simple-uploader.js 配置。
此外,你可以有如下配置项可选:
-
parseTimeRemaining(timeRemaining, parsedTimeRemaining) {Function}
用于格式化你想要剩余时间,一般可以用来做多语言。参数:
-
timeRemaining{Number}
, 剩余时间,秒为单位 -
parsedTimeRemaining{String}
, 默认展示的剩余时间内容,你也可以这样做替换使用:parseTimeRemaining: function (timeRemaining, parsedTimeRemaining) {return parsedTimeRemaining.replace(/\syears?/, '年').replace(/\days?/, '天').replace(/\shours?/, '小时').replace(/\sminutes?/, '分钟').replace(/\sseconds?/, '秒') }
-
-
categoryMap {Object}
文件类型 map,默认:
{image: ['gif', 'jpg', 'jpeg', 'png', 'bmp', 'webp'],video: ['mp4', 'm3u8', 'rmvb', 'avi', 'swf', '3gp', 'mkv', 'flv'],audio: ['mp3', 'wav', 'wma', 'ogg', 'aac', 'flac'],document: ['doc', 'txt', 'docx', 'pages', 'epub', 'pdf', 'numbers', 'csv', 'xls', 'xlsx', 'keynote', 'ppt', 'pptx'] }
-
-
autoStart {Boolean}
默认
true
, 是否选择文件后自动开始上传。 -
fileStatusText {Object}
默认:
{success: 'success',error: 'error',uploading: 'uploading',paused: 'paused',waiting: 'waiting' }
用于转换文件上传状态文本映射对象。
0.6.0 版本之后,
fileStatusText
可以设置为一个函数,参数为(status, response = null)
, 第一个 status 为状态,第二个为响应内容,默认 null,示例:fileStatusText(status, response) {const statusTextMap = {uploading: 'uploading',paused: 'paused',waiting: 'waiting'}if (status === 'success' || status === 'error') {// 只有status为success或者error的时候可以使用 response// eg:// return response data ?return response.data} else {return statusTextMap[status]} }
事件
参见 simple-uploader.js uploader 事件
注意:
-
所有的事件都会通过 lodash.kebabCase 做转换,例如
fileSuccess
就会变成file-success
。 -
catch-all
这个事件是不会触发的。 -
file-added(file)
, 添加了一个文件事件,一般用做文件校验,如果设置file.ignored = true
的话这个文件就会被过滤掉。 -
files-added(files, fileList)
, 添加了一批文件事件,一般用做一次选择的多个文件进行校验,如果设置files.ignored = true
或者fileList.ignored = true
的话本次选择的文件就会被过滤掉。
作用域插槽
-
files {Array}
纯文件列表,没有文件夹概念。
-
fileList {Array}
统一对待文件、文件夹列表。
-
started
是否开始上传了。
得到 Uploader
实例
可以通过如下方式获得:
// 在 uploader 组件上会有 uploader 属性 指向的就是 Uploader 实例
const uploaderInstance = this.$refs.uploader.uploader
// 这里可以调用实例方法
// https://github.com/simple-uploader/Uploader/blob/develop/README_zh-CN.md#方法
uploaderInstance.cancel()
UploaderBtn
点选上传文件按钮。
Props
-
directory {Boolean}
默认
false
, 是否是文件夹上传。 -
single {Boolean}
默认
false
, 如果设为true
,则代表一次只能选择一个文件。 -
attrs {Object}
默认
{}
, 添加到 input 元素上的额外属性。
UploaderDrop
拖拽上传区域。
UploaderList
文件、文件夹列表,同等对待。
作用域插槽
-
fileList {Array}
文件、文件夹组成数组。
UploaderFiles
文件列表,没有文件夹概念,纯文件列表。
作用域插槽
-
files {Array}
文件列表。
UploaderUnsupport
不支持 HTML5 File API 的时候会显示。
UploaderFile
文件、文件夹单个组件。
Props
-
file {Uploader.File}
封装的文件实例。
-
list {Boolean}
如果是在
UploaderList
组件中使用的话,请设置为true
。
作用域插槽
-
file {Uploader.File}
文件实例。
-
list {Boolean}
是否在
UploaderList
组件中使用。 -
status {String}
当前状态,可能是:
success
,error
,uploading
,paused
,waiting
-
paused {Boolean}
是否暂停了。
-
error {Boolean}
是否出错了。
-
averageSpeed {Number}
平均上传速度,单位字节每秒。
-
formatedAverageSpeed {String}
格式化后的平均上传速度,类似:
3 KB / S
。 -
currentSpeed {Number}
当前上传速度,单位字节每秒。
-
isComplete {Boolean}
是否已经上传完成。
-
isUploading {Boolean}
是否在上传中。
-
size {Number}
文件或者文件夹大小。
-
formatedSize {Number}
格式化后文件或者文件夹大小,类似:
10 KB
. -
uploadedSize {Number}
已经上传大小,单位字节。
-
progress {Number}
介于 0 到 1 之间的小数,上传进度。
-
progressStyle {String}
进度样式,transform 属性,类似:
{transform: '-50%'}
. -
progressingClass {String}
正在上传中的时候值为:
uploader-file-progressing
。 -
timeRemaining {Number}
预估剩余时间,单位秒。
-
formatedTimeRemaining {String}
格式化后剩余时间,类似:
3 miniutes
. -
type {String}
文件类型。
-
extension {String}
文件名后缀,小写。
-
fileCategory {String}
文件分类,其中之一:
folder
,document
,video
,audio
,image
,unknown
。
Development
# install dependencies
npm install# serve with hot reload at localhost:8080
npm run dev# build for production with minification
npm run build# build for production and view the bundle analyzer report
npm run build --report
这篇关于slice-uploader切片上传的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!