5.24.9

Upload
上传

文件选择上传和拖拽上传控件。
使用import { Upload } from "antd";

何时使用

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

  • 当需要上传一个或一些文件时。
  • 当需要展现上传的进度时。
  • 当需要使用拖拽交互时。

代码演示

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

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

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

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
文件上传中
image.png
image.png

图片卡的替代显示。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

Click or drag file to this area to upload

Support for a single or bulk upload. Strictly prohibited from uploading company data or other banned files.

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

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

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

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

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
xxx.png
zzz.png

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

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

通过 maxCount 限制上传数量。当为 1 时,始终用最新上传的代替当前。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

使用阿里云 OSS 上传示例.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

使用 itemRender ,我们可以集成 dnd-kit 来实现对上传列表拖拽排序。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

使用 progress 属性自定义进度条样式。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

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

beforeUpload 的返回值可以是一个 Promise 以支持异步处理,如服务端校验等:示例

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
文件上传中
image.png
image.png

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

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

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

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

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

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

支持上传一个文件夹里的所有文件。 Safari 里仍然能选择文件?

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

beforeUpload 返回 falsePromise.reject 时,只用于拦截上传行为,不会阻止文件进入上传列表(原因)。如果需要阻止列表展现,可以通过返回 Upload.LIST_IGNORE 实现。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

自定义本地预览,用于处理非图片格式文件(例如视频文件)。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

使用 beforeUpload 转换上传的文件(例如添加水印)。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

使用 showUploadList 设置列表交互图标和其他文件信息。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
+ Upload

配合 antd-img-crop 实现上传前裁切图片。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

API

通用属性参考:通用属性

参数说明类型默认值版本
accept接受上传的文件类型,详见 input accept Attributestring-
action上传的地址string | (file) => Promise<string>-
beforeUpload上传文件之前的钩子,参数为上传的文件,若返回 false 则停止上传。支持返回一个 Promise 对象,Promise 对象 reject 时则停止上传,resolve 时开始上传( resolve 传入 FileBlob 对象则上传 resolve 传入对象);也可以返回 Upload.LIST_IGNORE,此时列表中将不展示此文件。 注意:IE9 不支持该方法(file, fileList) => boolean | Promise<File> | Upload.LIST_IGNORE-
customRequest通过覆盖默认的上传行为,可以自定义自己的上传实现function-
data上传所需额外参数或返回上传额外参数的方法object|(file) => object | Promise<object>-
defaultFileList默认已经上传的文件列表object[]-
directory支持上传文件夹(caniusebooleanfalse
disabled是否禁用booleanfalse对于自定义 Upload children 时请将 disabled 属性同时传给 child node 确保 disabled 渲染效果保持一致
fileList已经上传的文件列表(受控),使用此参数时,如果遇到 onChange 只调用一次的问题,请参考 #2423UploadFile[]-
headers设置上传的请求头部,IE10 以上有效object-
iconRender自定义显示 icon(file: UploadFile, listType?: UploadListType) => ReactNode-
isImageUrl自定义缩略图是否使用 <img /> 标签进行显示(file: UploadFile) => boolean(内部实现)
itemRender自定义上传列表项(originNode: ReactElement, file: UploadFile, fileList: object[], actions: { download: function, preview: function, remove: function }) => React.ReactNode-4.16.0
listType上传列表的内建样式,支持四种基本样式 text, picture, picture-cardpicture-circlestringtextpicture-circle(5.2.0+)
maxCount限制上传数量。当为 1 时,始终用最新上传的文件代替当前文件number-4.10.0
method上传请求的 http methodstringpost
multiple是否支持多选文件,ie10+ 支持。开启后按住 ctrl 可选择多个文件booleanfalse
name发到后台的文件参数名stringfile
openFileDialogOnClick点击打开文件对话框booleantrue
previewFile自定义文件预览逻辑(file: File | Blob) => Promise<dataURL: string>-
progress自定义进度条样式ProgressProps(仅支持 type="line"{ strokeWidth: 2, showInfo: false }4.3.0
showUploadList是否展示文件列表, 可设为一个对象,用于单独设定 extra(5.20.0+), showPreviewIcon, showRemoveIcon, showDownloadIcon, removeIcondownloadIconboolean | { extra?: ReactNode | (file: UploadFile) => ReactNode, showPreviewIcon?: boolean | (file: UploadFile) => boolean, showDownloadIcon?: boolean | (file: UploadFile) => boolean, showRemoveIcon?: boolean | (file: UploadFile) => boolean, previewIcon?: ReactNode | (file: UploadFile) => ReactNode, removeIcon?: ReactNode | (file: UploadFile) => ReactNode, downloadIcon?: ReactNode | (file: UploadFile) => ReactNode }trueextra: 5.20.0, showPreviewIcon function: 5.21.0, showRemoveIcon function: 5.21.0, showDownloadIcon function: 5.21.0
withCredentials上传请求时是否携带 cookiebooleanfalse
onChange上传文件改变时的回调,上传每个阶段都会触发该事件。详见 onChangefunction-
onDrop当文件被拖入上传区域时执行的回调功能(event: React.DragEvent) => void-4.16.0
onDownload点击下载文件时的回调,如果没有指定,则默认跳转到文件 url 对应的标签页function(file): void(跳转新标签页)
onPreview点击文件链接或预览图标时的回调function(file)-
onRemove  点击移除文件时的回调,返回值为 false 时不移除。支持返回一个 Promise 对象,Promise 对象 resolve(false) 或 reject 时不移除              function(file): boolean | Promise-  

UploadFile

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

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

onChange

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

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

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

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

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

主题变量(Design Token)

组件 Token如何定制?
Token 名称描述类型默认值
actionsColor操作按扭颜色stringrgba(0,0,0,0.45)
全局 Token如何定制?

FAQ

服务端如何实现?

如何显示下载链接?

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

customRequest 怎么使用?

请参考 https://github.com/react-component/upload#customrequest

为何 fileList 受控时,上传不在列表中的文件不会触发 onChange 后续的 status 更新事件?

onChange 事件仅会作用于在列表中的文件,因而 fileList 不存在对应文件时后续事件会被忽略。请注意,在 4.13.0 版本之前受控状态存在 bug 导致不在列表中的文件也会触发。

onChange 为什么有时候返回 File 有时候返回 { originFileObj: File }?

历史原因,在 beforeUpload 返回 false 时,会返回 File 对象。在下个大版本我们会统一返回 { originFileObj: File } 对象。当前版本已经兼容所有场景下 info.file.originFileObj 获取原 File 写法。你可以提前切换。

为何有时 Chrome 点击 Upload 无法弹出文件选择框?

antd 无关,原生上传也会失败。请重启 Chrome 浏览器,让其完成升级工作。

点击 Chrome 重启启动按钮

相关 issue

文件夹上传在 Safari 仍然可以选中文件?

组件内部是以 directorywebkitdirectory 属性控制 input 来实现文件夹选择的, 但似乎在 Safari 的实现中,并不会阻止用户选择文件,请尝试额外传递无法匹配文件的 accept 属性来规避此问题 例如:

jsx
accept: `.${'n'.repeat(100)}`;