

<DemoTitle title="Upload" desc="文件选择上传和拖拽上传控件。">
#### API

<AntdApiRef url="https://ant.design/components/upload-cn/#api"></AntdApiRef>


## antd API

通用属性参考：[通用属性](/docs/react/common-props)

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| accept | 接受上传的文件类型，详见  | string | - |  | 
| action | 上传的地址 | string \| (file) => Promise | - |  | 
| beforeUpload | 上传文件之前的钩子，参数为上传的文件，若返回  | (file, fileList) => boolean \| Promise \|  | - |  | 
| customRequest | 通过覆盖默认的上传行为，可以自定义自己的上传实现 | function | - |  | 
| data | 上传所需额外参数或返回上传额外参数的方法 | object\|(file) => object \| Promise | - |  | 
| defaultFileList | 默认已经上传的文件列表 | object[] | - |  | 
| directory | 支持上传文件夹（ | boolean | false |  | 
| disabled | 是否禁用 | boolean | false | 对于自定义 Upload children 时请将 disabled 属性同时传给 child node 确保 disabled 渲染效果保持一致 | 
| fileList | 已经上传的文件列表（受控），使用此参数时，如果遇到  |  | - |  | 
| headers | 设置上传的请求头部，IE10 以上有效 | object | - |  | 
| iconRender | 自定义显示 icon | (file: UploadFile, listType?: UploadListType) => ReactNode | - |  | 
| isImageUrl | 自定义缩略图是否使用  标签进行显示 | (file: UploadFile) => boolean |  |  | 
| itemRender | 自定义上传列表项 | (originNode: ReactElement, file: UploadFile, fileList: object[], actions: { download: function, preview: function, remove: function }) => React.ReactNode | - | 4.16.0 | 
| listType | 上传列表的内建样式，支持四种基本样式  | string | text | picture-circle | 
| maxCount | 限制上传数量。当为 1 时，始终用最新上传的文件代替当前文件 | number | - | 4.10.0 | 
| method | 上传请求的 http method | string | post |  | 
| multiple | 是否支持多选文件， | boolean | false |  | 
| name | 发到后台的文件参数名 | string | file |  | 
| openFileDialogOnClick | 点击打开文件对话框 | boolean | true |  | 
| pastable | 是否支持粘贴文件 | boolean | false | 5.25.0 | 
| previewFile | 自定义文件预览逻辑 | (file: File \| Blob) => Promise | - |  | 
| progress | 自定义进度条样式 |  | { strokeWidth: 2, showInfo: false } | 4.3.0 | 
| showUploadList | 是否展示文件列表, 可设为一个对象，用于单独设定  | boolean \| { 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 } | true | extra | 
| withCredentials | 上传请求时是否携带 cookie | boolean | false |  | 
| onChange | 上传文件改变时的回调，上传每个阶段都会触发该事件。详见  | function | - |  | 
| 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，附带额外属性用于渲染。

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| crossOrigin | CORS 属性设置 | 'anonymous' | - | 4.20.0 | 
| name | 文件名 | string | - | - | 
| percent | 上传进度 | number | - | - | 
| status | 上传状态，不同状态展示颜色也会有所不同 | error | - | - | 
| 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` 上传中的服务端响应内容，包含了上传进度等信息，高级浏览器支持。