Skip to content

Upload 上传

规则

js
{
    type: "upload",
    field: "pic",
    title: "轮播图",
    value: [
        'http://img1.touxiang.cn/uploads/20131030/30-075657_191.jpg',
        'http://img1.touxiang.cn/uploads/20131030/30-075657_191.jpg'
        ],
    props: {
        action: "/upload.php",
        limit: 2,
            onSuccess:function (file) {
            file.url = file.response.url;
        }
    },
}

完整配置项:Ant-design-vue_Upload

value :Array | String

注意

文件上传成功后需要通过 onSuccess 回调, 将接口返回内容中的 url 赋值给 file.url.否则表单获取不到组件的数据

Props

参数说明类型默认值
onSuccess用于获取文件链接 file.url = file.response.urlFunction(file,fileList)
accept接受上传的文件类型, 详见 input accept Attributestring-
action上传的地址string|(file) => Promise-
beforeUpload上传文件之前的钩子,参数为上传的文件,若返回 false 则停止上传。支持返回一个 Promise 对象,Promise 对象 reject 时则停止上传,resolve 时开始上传( resolve 传入 FileBlob 对象则上传 resolve 传入对象)。(file, fileList) => booleanPromise
customRequest通过覆盖默认的上传行为,可以自定义自己的上传实现function-
data上传所需参数或返回上传参数的方法object|(file) => object-
directory支持上传文件夹(caniusebooleanfalse
disabled是否禁用boolean-
downloadIcon自定义下载 iconv-slot:iconRender="{file: UploadFile}"-
fileList已经上传的文件列表(受控)object[]-
headers设置上传的请求头部,IE10 以上有效object-
iconRender自定义显示 iconv-slot:iconRender="{file: UploadFile, listType?: UploadListType}"-
isImageUrl自定义缩略图是否使用 标签进行显示(file: UploadFile) => boolean-
itemRender自定义上传列表项v-slot:itemRender="{originNode: VNode, file: UploadFile, fileList: object[], actions: { download: function, preview: function, remove: function }"-
listType上传列表的内建样式,支持三种基本样式 text, picturepicture-cardstringtext
maxCount限制上传数量。当为 1 时,始终用最新上传的文件代替当前文件number-
method上传请求的 http methodstringpost
multiple是否支持多选文件,ie10+ 支持。开启后按住 ctrl 可选择多个文件。booleanfalse
name发到后台的文件参数名stringfile
openFileDialogOnClick点击打开文件对话框booleantrue
previewFile自定义文件预览逻辑(file: File | Blob) => Promise<dataURL: string>-
previewIcon自定义预览 iconv-slot:iconRender="{file: UploadFile}"-
progress自定义进度条样式ProgressProps(仅支持 type="line"{ strokeWidth: 2, showInfo: false }
removeIcon自定义删除 iconv-slot:iconRender="{file: UploadFile}"-
showUploadList是否展示 uploadList, 可设为一个对象,用于单独设定 showPreviewIcon, showRemoveIcon 和 showDownloadIconboolean | { showPreviewIcon?: boolean, showRemoveIcon?: boolean, showDownloadIcon?: boolean }true
supportServerRender服务端渲染时需要打开这个booleanfalse
withCredentials上传请求时是否携带 cookiebooleanfalse

Events

事件名称说明回调参数
change上传文件改变时的状态,详见 changefunction
download点击下载文件时的回调,如果没有指定,则默认跳转到文件 url 对应的标签页。function(file): void
drop当文件被拖入上传区域时执行的回调功能(event: DragEvent) => void
preview点击文件链接或预览图标时的回调function(file)
reject拖拽文件不符合 accept 类型时的回调function(fileList)
remove点击移除文件时的回调,返回值为 false 时不移除。支持返回一个 Promise 对象,Promise 对象 resolve(false) 或 reject 时不移除function(file): boolean | Promise

UploadFile

继承自 File,附带额外属性用于渲染。

参数说明类型默认值
crossOriginCORS 属性设置'anonymous' | 'use-credentials' | ''-
name文件名string-
percent上传进度number-
status上传状态,不同状态展示颜色也会有所不同error | success | done | uploading | removed-
thumbUrl缩略图地址string-
uid唯一标识符,不设置时会自动生成string-
url下载地址string-

change

上传中、完成、失败都会调用这个函数。

文件状态改变的回调,返回为:

jsx
{
  file: { /* ... */ },
  fileList: [ /* ... */ ],
  event: { /* ... */ },
}
  1. file 当前操作的文件对象。
jsx
   {
      uid: 'uid',      // 文件唯一标识,建议设置为负数,防止和内部产生的 id 冲突
      name: 'xx.png',   // 文件名
      status: 'done', // 状态有:uploading done error removed
      response: '{"status": "success"}', // 服务端响应内容
      linkProps: '{"download": "image"}', // 下载链接额外的 HTML 属性
      xhr: 'XMLHttpRequest{ ... }', // XMLHttpRequest Header
   }
  1. fileList 当前的文件列表。

  2. event 上传中的服务端响应内容,包含了上传进度等信息,高级浏览器支持。

FormCreate 是一个开源项目,基于 MIT 许可证发布,欢迎个人和企业用户免费使用