ant-design/components/upload/index.en-US.md

84 lines
4.4 KiB
Markdown
Raw Normal View History

2016-08-25 09:46:19 +08:00
---
category: Components
type: Data Entry
2016-09-21 11:28:38 +08:00
title: Upload
2016-08-25 09:46:19 +08:00
---
2016-09-18 11:08:54 +08:00
Upload file by selecting or dragging.
2016-08-25 09:46:19 +08:00
2016-09-10 13:43:30 +08:00
## When To Use
2016-08-25 09:46:19 +08:00
Uploading is the process of publishing information (web pages, text, pictures, video, etc.) to a remote server via a web page or upload tool.
- When you need to upload one or more files.
- When you need to show the process of uploading.
- When you need to upload files by dragging and dropping.
## API
2016-09-29 15:37:32 +08:00
> You can consult [jQuery-File-Upload](https://github.com/blueimp/jQuery-File-Upload/wiki) about how to implement server side upload interface.
2016-08-25 09:46:19 +08:00
| Property | Description | Type | Default|
|------------|----------------------------------------------------| ----------- |--------|
| name | The name of uploading file | string | 'file' |
| defaultFileList | Default list of files that have been uploaded. | object[] | - |
| fileList | List of files that have been uploaded (controlled). Here is a common issue [#2423](https://github.com/ant-design/ant-design/issues/2423) when using it | object[] | - |
| action | Required. Uploading URL | string | - |
| data | Uploading params or function which can return uploading params. | object\|function(file) | - |
| headers | Set request headers, valid above IE10. | object | - |
| showUploadList | Whether to show default upload list, could be an object to specify `showPreviewIcon` and `showRemoveIcon` individually | Boolean or { showPreviewIcon?: boolean, showRemoveIcon?: boolean } | true |
| multiple | Whether to support selected multiple file. `IE10+` supported. You can select multiple files with CTRL holding down while multiple is set to be true | boolean | false |
| accept | File types that can be accepted. See [input accept Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-accept) | string | - |
2017-08-24 18:37:26 +08:00
| beforeUpload | Hook function which will be executed before uploading. Uploading will be stopped with `false` or a rejected Promise returned. **Warningthis function is not supported in IE9**。 | (file, fileList) => `boolean | Promise` | - |
| customRequest | override for the default xhr behavior allowing for additional customization and ability to implement your own XMLHttpRequest | Function | - |
2016-10-11 15:23:18 +08:00
| onChange | A callback function, can be executed when uploading state is changing. See [onChange](#onChange) | Function | - |
2017-08-11 12:39:26 +08:00
| listType | Built-in stylesheets, support for three types: `text`, `picture` or `picture-card` | string | 'text'|
| onPreview | A callback function, will be executed when file link or preview icon is clicked. | Function(file) | - |
| onRemove | A callback function, will be executed when removing file button is clicked, remove event will be prevented when return value is `false` or a Promise which resolve(false) or reject. | Function(file): `boolean | Promise` | - |
| supportServerRender | Need to be turned on while the server side is rendering.| boolean | false |
| disabled | disable upload button | boolean | false |
| withCredentials | ajax upload with cookie sent | boolean | false |
2016-08-25 09:46:19 +08:00
### onChange
> The function will be called when uploading is in progress, completed or failed
When uploading state change, it returns:
```js
{
file: { /* ... */ },
fileList: [ /* ... */ ],
event: { /* ... */ },
}
```
1. `file` File object for the current operation.
```js
{
2016-09-18 11:08:54 +08:00
uid: 'uid', // unique identifiernegative is recommendto prevent interference with internal generated id
2016-08-25 09:46:19 +08:00
name: 'xx.png' // file name
2017-10-09 13:23:20 +08:00
status: 'done', // optionsuploading, done, error, removed
response: '{"status": "success"}', // response from server
linkProps: '{"download": "image"}', // additional html props of file link
2016-08-25 09:46:19 +08:00
}
```
2016-09-18 11:08:54 +08:00
> Before `antd@1.9.0`, this parameter will be Array Object `[file, ...]` in multiple mode, while in `antd@1.9.0+`, it will always be an Object.
2016-08-25 09:46:19 +08:00
2. `fileList` current list of files
3. `event` response from server, including uploading progress, supported by advanced browsers.
## show download links
2016-11-16 21:33:37 +08:00
Please set property `url` of property `fileList` to control content of link
2016-08-25 09:46:19 +08:00
## customRequest
* https://github.com/react-component/upload#customrequest
2016-08-25 09:46:19 +08:00
## IE note
- [https://github.com/react-component/upload#ie89-note](https://github.com/react-component/upload#ie89-note)