ant-design-vue/components/upload/index.zh-CN.md

3.4 KiB
Raw Blame History

API

服务端上传接口实现可以参考 jQuery-File-Upload

参数 说明 类型 默认值
accept 接受上传的文件类型, 详见 input accept Attribute string
action 上传的地址 string|(file) => Promise
directory 支持上传文件夹(caniuse boolean false
beforeUpload 上传文件之前的钩子,参数为上传的文件,若返回 false 则停止上传。支持返回一个 Promise 对象Promise 对象 reject 时则停止上传resolve 时开始上传( resolve 传入 FileBlob 对象则上传 resolve 传入对象)。注意IE9 不支持该方法 (file, fileList) => `boolean Promise`
customRequest 通过覆盖默认的上传行为,可以自定义自己的上传实现 Function
data 上传所需参数或返回上传参数的方法 object|(file) => object
defaultFileList 默认已经上传的文件列表 object[]
disabled 是否禁用 boolean false
fileList 已经上传的文件列表(受控) object[]
headers 设置上传的请求头部IE10 以上有效 object
listType 上传列表的内建样式,支持三种基本样式 text, picturepicture-card string 'text'
multiple 是否支持多选文件,ie10+ 支持。开启后按住 ctrl 可选择多个文件。 boolean false
name 发到后台的文件参数名 string 'file'
showUploadList 是否展示 uploadList, 可设为一个对象,用于单独设定 showPreviewIcon 和 showRemoveIcon Boolean or { showPreviewIcon?: boolean, showRemoveIcon?: boolean } true
supportServerRender 服务端渲染时需要打开这个 boolean false
withCredentials 上传请求时是否携带 cookie boolean false
openFileDialogOnClick 点击打开文件对话框 boolean true
remove   点击移除文件时的回调,返回值为 false 时不移除。支持返回一个 Promise 对象Promise 对象 resolve(false) 或 reject 时不移除。               Function(file): `boolean Promise`

事件

事件名称 说明 回调参数
change 上传文件改变时的状态,详见 change Function
preview 点击文件链接或预览图标时的回调 Function(file)
reject 拖拽文件不符合accept类型时的回调 Function(fileList)

change

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

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

{
  file: { /* ... */ },
  fileList: [ /* ... */ ],
  event: { /* ... */ },
}
  1. file 当前操作的文件对象。

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

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