文件选择上传和拖拽上传控件。
上传是将信息(网页、文字、图片、视频等)通过网页或者上传工具发布到远程服务器上的过程。
经典款式,用户点击按钮弹出文件选择框。
使用 nzFileList
设置已上传的内容。
使用 nzFilter
对列表进行过滤控制,可以实现各种自定义功能,以下演示三种情况:
上传文件为图片,可展示本地缩略图。IE8/9
不支持浏览器本地缩略图展示(Ref),可以写 thumbUrl
属性来代替。
点击上传用户头像,并使用 beforeUpload
限制用户上传的图片格式和大小。
用户可以上传图片并在列表中显示缩略图。当上传照片数到达限制后,上传按钮消失。
把文件拖入指定区域,完成上传,同样支持点击上传。
设置 nzMultiple
后,在 IE10+
可以一次上传多个文件。
beforeUpload
返回 false
后,手动上传文件。
服务端上传接口实现可以参考 jQuery-File-Upload。
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
nzAccept | 接受上传的文件类型, 详见 input accept Attribute | string | 无 |
nzAction | 必选参数, 上传的地址 | string | 无 |
nzBeforeUpload | 上传文件之前的钩子,参数为上传的文件,若返回 false 则停止上传。注意:IE9 不支持该方法。注意:务必什么 => 定义处理方法。 |
(file, fileList) => boolean | Observable<boolean> |
无 |
nzCustomRequest | 通过覆盖默认的上传行为,可以自定义自己的上传实现。注意:务必什么 => 定义处理方法。 |
(item) => Subscription |
无 |
nzData | 上传所需参数或返回上传参数的方法。注意:务必什么 => 定义处理方法。 |
Object | ((file: UploadFile) => Object) | 无 |
nzDisabled | 是否禁用 | boolean | false |
nzFileList | 文件列表,双向绑定 | UploadFile[] | 无 |
nzLimit | 限制单次最多上传数量,nzMultiple 打开时有效;0 表示不限 |
number | 0 |
nzSize | 限制文件大小,单位:KB;0 表示不限 |
number | 0 |
nzFileType | 限制文件类型,例如:image/png,image/jpeg,image/gif,image/bmp |
string | 无 |
nzFilter | 自定义过滤器 | UploadFilter[] | 无 |
nzHeaders | 设置上传的请求头部,IE10 以上有效 | object | 无 |
nzListType | 上传列表的内建样式,支持三种基本样式 text , picture 和 picture-card |
string | 'text' |
nzMultiple | 是否支持多选文件,IE10+ 支持。开启后按住 ctrl 可选择多个文件。 |
boolean | false |
nzName | 发到后台的文件参数名 | string | 'file' |
nzShowUploadList | 是否展示列表, 可设为一个对象,用于单独设定 showPreviewIcon 和 showRemoveIcon | Boolean or { showPreviewIcon?: boolean, showRemoveIcon?: boolean } | true |
nzShowButton | 是否展示上传按钮 | boolean | true |
nzWithCredentials | 上传请求时是否携带 cookie | boolean | false |
nzPreview | 点击文件链接或预览图标时的回调。注意:务必什么 => 定义处理方法。 |
(file: UploadFile) => void | 无 |
nzRemove | 点击移除文件时的回调,返回值为 false 时不移除。支持返回 Observable<boolean> 对象。注意:务必什么 => 定义处理方法。 |
(file: UploadFile) => boolean | Observable<boolean> | 无 |
(nzChange) | 上传文件状态变更时回调 | EventEmitter |
开始、上传进度、完成、失败都会调用这个函数。
文件状态改变的回调,返回为:
file
当前操作的文件对象。
fileList
当前的文件列表。
event
上传中的服务端响应内容,包含了上传进度等信息,高级浏览器支持。
默认使用HTML5方式上传(即:使用 HttpClient
),允许覆盖默认行为实现定制需求,例如直接与阿里云交互等。
nzCustomRequest
回调传递以下参数:
onProgress: (event: { percent: number }): void
onError: (event: Error): void
onSuccess: (body: Object, xhr?: Object): void
data: Object
filename: String
file: File
withCredentials: Boolean
action: String
headers: Object