• Upload 上传

    文件选择上传和拖拽上传控件。

    何时使用

    上传是将信息(网页、文字、图片、视频等)通过网页或者上传工具发布到远程服务器上的过程。

    代码演示

    经典款式,用户点击按钮弹出文件选择框。

    使用 defaultFileList 设置已上传的内容。

    使用 fileList 对列表进行完全控制,可以实现各种自定义功能,以下演示三种情况:

    1) 上传列表数量的限制。

    2) 读取远程路径并显示链接。

    3) 按照服务器返回信息筛选成功上传的文件。

    上传文件为图片,可展示本地缩略图。IE8/9 不支持浏览器本地缩略图展示(Ref),可以写 thumbUrl 属性来代替。

    点击上传用户头像,并使用 beforeUpload 限制用户上传的图片格式和大小。

    beforeUpload 的返回值可以是一个 Promise 以支持也支持异步检查:示例

    用户可以上传图片并在列表中显示缩略图。当上传照片数到达限制后,上传按钮消失。

    把文件拖入指定区域,完成上传,同样支持点击上传。

    设置 multiple 后,在 IE10+ 可以一次上传多个文件。

    beforeUpload 返回 false 后,手动上传文件。

    API

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

    参数 说明 类型 默认值
    accept 接受上传的文件类型, 详见 input accept Attribute string
    action 必选参数, 上传的地址 string
    beforeUpload 上传文件之前的钩子,参数为上传的文件,若返回 false 则停止上传。支持返回一个 Promise 对象,Promise 对象 reject 时则停止上传,resolve 时开始上传。注意:IE9 不支持该方法 (file, fileList) => `boolean Promise`
    customRequest 通过覆盖默认的上传行为,可以自定义自己的上传实现 Function
    data 上传所需参数或返回上传参数的方法 object|function(file)
    defaultFileList 默认已经上传的文件列表 object[]
    disabled 是否禁用 boolean false
    fileList 已经上传的文件列表(受控),使用此参数时,如果遇到 onChange 只调用一次的问题,请参考 #2423 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
    onChange 上传文件改变时的状态,详见 onChange Function
    onPreview 点击文件链接或预览图标时的回调 Function(file)
    onRemove   点击移除文件时的回调,返回值为 false 时不移除。支持返回一个 Promise 对象,Promise 对象 resolve(false) 或 reject 时不移除。               Function(file): `boolean Promise`

    onChange

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

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

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

    antd@1.9.0 之前,multiple 模式下,此参数为一个对象数组 [file, ...]antd@1.9.0 开始无论是否多选,均为一个对象。

    1. fileList 当前的文件列表。
    2. event 上传中的服务端响应内容,包含了上传进度等信息,高级浏览器支持。

    显示下载链接

    请使用 fileList 属性设置数组项的 url 属性进行展示控制。

    customRequest

    IE note