ant-design/components/upload/index.zh-CN.md

83 lines
4.2 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
2016-09-21 11:28:38 +08:00
subtitle: 上传
type: Data Entry
2016-09-21 11:28:38 +08:00
title: Upload
2016-03-31 14:17:09 +08:00
---
2015-08-01 14:08:04 +08:00
2015-08-05 21:18:34 +08:00
文件选择上传和拖拽上传控件。
2015-08-01 14:08:04 +08:00
2015-08-05 21:18:34 +08:00
## 何时使用
2015-08-01 14:08:04 +08:00
2015-08-25 20:29:19 +08:00
上传是将信息(网页、文字、图片、视频等)通过网页或者上传工具发布到远程服务器上的过程。
2015-08-08 23:37:35 +08:00
2015-08-05 21:18:34 +08:00
- 当需要上传一个或一些文件时。
- 当需要展现上传的进度时。
- 当需要使用拖拽交互时。
2015-08-09 18:05:50 +08:00
2015-08-08 23:37:35 +08:00
## API
2016-09-29 15:37:32 +08:00
> 服务端上传接口实现可以参考 [jQuery-File-Upload](https://github.com/blueimp/jQuery-File-Upload/wiki)。
| 参数 | 说明 | 类型 | 默认值|
|------------|--------------------------------------------------------------| ----------- |-------|
| name | 发到后台的文件参数名 | string | 'file' |
| defaultFileList | 默认已经上传的文件列表 | object[] | 无 |
| fileList | 已经上传的文件列表(受控),使用此参数时,如果遇到 `onChange` 只调用一次的问题,请参考 [#2423](https://github.com/ant-design/ant-design/issues/2423) | object[] | 无 |
| action | 必选参数, 上传的地址 | string | 无 |
| data | 上传所需参数或返回上传参数的方法 | object\|function(file) | 无 |
| headers | 设置上传的请求头部IE10 以上有效 | object | 无 |
| showUploadList | 是否展示 uploadList, 可设为一个对象,用于单独设定 showPreviewIcon 和 showRemoveIcon | Boolean or { showPreviewIcon?: boolean, showRemoveIcon?: boolean } | true |
| multiple | 是否支持多选文件,`ie10+` 支持。开启后按住 ctrl 可选择多个文件。 | boolean | false |
| accept | 接受上传的文件类型, 详见 [input accept Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-accept) | string | 无 |
2016-12-12 12:08:15 +08:00
| beforeUpload | 上传文件之前的钩子,参数为上传的文件,若返回 `false` 或者 Promise 则停止上传。**注意:该方法不支持老 IE**。 | (file, fileList) => `boolean | Promise` | 无 |
| customRequest | 通过覆盖默认的上传行为,可以自定义自己的上传实现 | Function | 无 |
2016-10-11 15:23:18 +08:00
| onChange | 上传文件改变时的状态,详见 onChange | Function | 无 |
| listType | 上传列表的内建样式,支持两种基本样式 `text` or `picture` | string | 'text'|
| onPreview | 点击文件链接或预览图标时的回调 | Function(file) | 无 |
| onRemove   | 点击移除文件时的回调,返回值为 false 时不移除。支持返回一个 Promise 对象Promise 对象 resolve(false) 或 reject 时不移除。               | Function(file): `boolean | Promise` | 无   |
| supportServerRender | 服务端渲染时需要打开这个 | boolean | false |
| disabled | 是否禁用 | boolean | false |
| withCredentials | 上传请求时是否携带 cookie | boolean | false |
### onChange
2016-05-10 17:31:15 +08:00
> 上传中、完成、失败都会调用这个函数。
文件状态改变的回调,返回为:
```js
{
2016-05-10 17:31:15 +08:00
file: { /* ... */ },
fileList: [ /* ... */ ],
event: { /* ... */ },
}
```
1. `file` 当前操作的文件对象。
```js
{
2015-09-01 11:26:33 +08:00
uid: 'uid', // 文件唯一标识,建议设置为负数,防止和内部产生的 id 冲突
name: 'xx.png' // 文件名
2015-09-14 00:28:39 +08:00
status: 'done', // 状态有uploading done error removed
2016-05-10 17:31:15 +08:00
response: '{"status": "success"}', // 服务端响应内容
}
```
> `antd@1.9.0` 之前multiple 模式下,此参数为一个对象数组 `[file, ...]``antd@1.9.0` 开始无论是否多选,均为一个对象。
2015-09-09 14:58:17 +08:00
2. `fileList` 当前的文件列表。
3. `event` 上传中的服务端响应内容,包含了上传进度等信息,高级浏览器支持。
## 显示下载链接
2015-09-01 11:26:33 +08:00
请使用 fileList 属性设置数组项的 url 属性进行展示控制。
2015-09-24 19:43:02 +08:00
## customRequest
* https://github.com/react-component/upload#customrequest
2015-09-24 19:43:02 +08:00
## IE note
- [https://github.com/react-component/upload#ie89-note](https://github.com/react-component/upload#ie89-note)