ContextQMD
Back to Ant Design

Upload

components/upload/index.zh-CN.md

6.3.713.5 KB
Original Source

何时使用 {#when-to-use}

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

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

代码演示 {#examples}

<!-- prettier-ignore -->

<code src="./demo/basic.tsx">点击上传</code> <code src="./demo/avatar.tsx">用户头像</code> <code src="./demo/defaultFileList.tsx">已上传的文件列表</code> <code src="./demo/picture-card.tsx">照片墙</code> <code src="./demo/picture-circle.tsx">圆形照片墙</code> <code src="./demo/fileList.tsx">完全控制的上传列表</code> <code src="./demo/drag.tsx">拖拽上传</code> <code src="./demo/paste.tsx" version="5.25.0">粘贴上传</code> <code src="./demo/directory.tsx">文件夹上传</code> <code src="./demo/upload-manually.tsx">手动上传</code> <code src="./demo/upload-png-only.tsx">只上传 png 图片</code> <code src="./demo/picture-style.tsx">图片列表样式</code> <code src="./demo/preview-file.tsx">自定义预览</code> <code src="./demo/max-count.tsx">限制数量</code> <code src="./demo/transform-file.tsx">上传前转换文件</code> <code src="./demo/upload-with-aliyun-oss.tsx">阿里云 OSS</code> <code src="./demo/file-type.tsx" debug>自定义显示 icon</code> <code src="./demo/upload-custom-action-icon.tsx">自定义交互图标和文件信息</code> <code src="./demo/drag-sorting.tsx">上传列表拖拽排序</code> <code src="./demo/crop-image.tsx">上传前裁切图片</code> <code src="./demo/customize-progress-bar.tsx">自定义进度条样式</code> <code src="./demo/style-class.tsx" version="6.0.0">自定义语义结构的样式和类</code> <code src="./demo/component-token.tsx" debug>组件 Token</code> <code src="./demo/debug-disabled.tsx" debug>Debug Disabled Styles</code>

API

通用属性参考：通用属性

参数说明类型默认值版本
accept接受上传的文件类型，详见 input accept Attributestring | AcceptObject-
action上传的地址string | (file) => Promise<string>-
beforeUpload上传文件之前的钩子，参数为上传的文件，若返回 false 则停止上传。支持返回一个 Promise 对象，Promise 对象 reject 时则停止上传，resolve 时开始上传（ resolve 传入 File 或 Blob 对象则上传 resolve 传入对象）；也可以返回 Upload.LIST_IGNORE，此时列表中将不展示此文件。 注意：IE9 不支持该方法(file: RcFile, fileList: RcFile[]) => boolean | Promise<File> | Upload.LIST_IGNORE-
customRequest通过覆盖默认的上传行为，可以自定义自己的上传实现( options: RequestOptions, info: { defaultRequest: (option: RequestOptions) => void; } ) => void-defaultRequest: 5.28.0
classNames用于自定义组件内部各语义化结构的 class，支持对象或函数Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string>-
data上传所需额外参数或返回上传额外参数的方法object|(file) => object | Promise<object>-
defaultFileList默认已经上传的文件列表object[]-
directory支持上传文件夹（caniuse）booleanfalse
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-card 和 picture-circlestringtextpicture-circle(5.2.0+)
maxCount限制上传数量。当为 1 时，始终用最新上传的文件代替当前文件number-4.10.0
method上传请求的 http methodstringpost
multiple是否支持多选文件，ie10+ 支持。开启后按住 ctrl 可选择多个文件booleanfalse
name发到后台的文件参数名stringfile
openFileDialogOnClick点击打开文件对话框booleantrue
pastable是否支持粘贴文件booleanfalse5.25.0
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, removeIcon 和 downloadIconboolean | { 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
styles用于自定义组件内部各语义化结构的行内 style，支持对象或函数Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties>-
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-

Interface

RcFile

继承自 File。

参数说明类型默认值版本
uid唯一标识符，不设置时会自动生成string--
lastModifiedDate上次修改文件的日期和时间date--

UploadFile

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

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

RequestOptions {#request-options}

参数说明类型默认值版本
action上传的地址string--
data上传所需额外参数或返回上传额外参数的方法Record<string, unknown>--
filename文件名string--
file文件信息UploadFile--
withCredentials上传请求时是否携带 cookieboolean--
headers上传的请求头部Record<string, string>--
method上传请求的 http methodstring--
onProgress上传进度回调(event: object, file: UploadFile) => void--
onError上传失败回调(event: object, body?: object) => void--
onSuccess上传成功回调(body: object, fileOrXhr?: UploadFile | XMLHttpRequest) => void--

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 上传中的服务端响应内容，包含了上传进度等信息，高级浏览器支持。

AcceptObject

typescript
{
  format: string;
  filter?: 'native' | ((file: RcFile) => boolean);
}

用于配置文件类型接受的规则对象。

参数说明类型默认值版本
format接受的文件类型，与原生 input accept 属性相同，支持 MIME 类型、文件扩展名等格式。详见 input accept Attributestring-
filter文件过滤规则。设置为 'native' 时使用浏览器原生过滤行为；设置为函数时可以自定义过滤逻辑，函数返回 true 表示接受该文件，返回 false 表示拒绝'native' | (file: RcFile) => boolean-

Semantic DOM

<code src="./demo/_semantic.tsx" simplify="true"></code>

主题变量（Design Token）{#design-token}

<ComponentTokenTable component="Upload"></ComponentTokenTable>

FAQ

服务端如何实现？ {#faq-server-implement}

如何显示下载链接？ {#faq-show-download-link}

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

customRequest 怎么使用？ {#faq-custom-request}

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

为何 fileList 受控时，上传不在列表中的文件不会触发 onChange 后续的 status 更新事件？ {#faq-filelist-controlled-status}

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

onChange 为什么有时候返回 File 有时候返回 { originFileObj: File }？ {#faq-on-change-return-type}

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

为何有时 Chrome 点击 Upload 无法弹出文件选择框？ {#faq-chrome-file-picker}

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

相关 issue：

文件夹上传在 Safari 仍然可以选中文件? {#faq-safari-folder-upload}

组件内部是以 directory、webkitdirectory 属性控制 input 来实现文件夹选择的, 但似乎在 Safari 的实现中，并不会阻止用户选择文件。可以通过 accept 配置来解决此问题，例如：

tsx
accept = {
  // 不允许选择任何文件
  format: `.${'n'.repeat(100)}`,
  // 当选择文件夹后，接受所有文件夹内的文件
  filter: () => true,
};