附件上传 | v-form-antd

# 附件上传

我们默认您的附件上传数据结构和 ant-design-vue Upload (opens new window)一致，否则我们建议您使用自定义控件处理上传业务

# 使用方式

<template>
  <div>
    <v-form-create :formConfig="formConfig" :formData="formData" v-model="fApi" />
  </div>
</template>
<script>
export default {
  name: 'Demo',
  data() {
    return {
      fApi: {},
      formData: {
        fileList: [
          {
            uid: '1',
            name: 'xxx.png',
            status: 'done',
            response: 'Server Error 500', // custom error message to show
            url: 'http://www.baidu.com/xxx.png'
          },
          {
            uid: '2',
            name: 'yyy.png',
            status: 'done',
            url: 'http://www.baidu.com/yyy.png'
          },
          {
            uid: '3',
            name: 'zzz.png',
            status: 'error',
            response: 'Server Error 500', // custom error message to show
            url: 'http://www.baidu.com/zzz.png'
          }
        ]
      },
      formConfig: {
        formItems: [
          {
            type: 'upload',
            label: '上传',
            field: 'fileList',
            span: 24,
            props: {}
          }
        ],
        config: {
          layout: 'horizontal',
          labelLayout: 'flex',
          labelWidth: 100,
          labelCol: {},
          wrapperCol: {}
        }
      }
    }
  }
}
</script>

复制代码

# 服务端响应

在使用时，请确保您的服务端响应数据结构

interface Response {
  code: number // 为 0 时表示上传成功
  data: {
    // 附件数据
    uid: number
    url: string
    thumbUrl: string
    name?: string
  }
  msg: string // 错误提示，code 非 0 时抛出
}

1
2
3
4
5
6
7
8
9
10
11

# API

参数	说明	类型	默认值
accept	接受上传的文件类型, 详见input accept Attribute (opens new window)	string	-
action	上传地址	string	(file) => Promise
method	上传请求的 `http method`	string	'post'
directory	支持上传文件夹	boolean	false
beforeUpload	上传文件之前的钩子，参数为上传的文件，若返回 `false` 则停止上传。支持返回一个 `Promise` 对象，`Promise` 对象 `reject` 时则停止上传，`resolve` 时开始上传（ `resolve` 传入 `File` 或 `Blob` 对象则上传 `resolve` 传入对象）。	(file, fileList) => boolean	Promise
customRequest	通过覆盖默认的上传行为，可以自定义自己的上传实现	Function	-
disabled	是否禁用	boolean	false
headers	设置上传的请求头部，IE10 以上有效	object	-
multiple	是否支持多选文件，ie10+ 支持。开启后按住 ctrl 可选择多个文件。	boolean	false
name	发到后台的文件参数名	string	'file'
showUploadList	是否展示 uploadList, 可设为一个对象，用于单独设定 showPreviewIcon 和 showRemoveIcon	Boolean or { showPreviewIcon?: boolean, showRemoveIcon?: boolean }	true
withCredentials	上传请求时是否携带 cookie	boolean	false
remove	点击移除文件时的回调，返回值为 false 时不移除。支持返回一个 Promise 对象，Promise 对象 resolve(false) 或 reject 时不移除。	Function(file): boolean	Promise
transformFile	在上传之前转换文件。支持返回一个 Promise 对象	Function(file): string \| Blob \| File \| Promise<string \| Blob \| File>	无
valueFormat	指定fileList的格式	'JSON'	'Array'

# 事件

事件名称	说明	回调参数
change	上传文件改变时的状态，详见 change (opens new window)	Function
preview	点击文件链接或预览图标时的回调	Function(file)
download	点击下载文件时的回调，如果没有指定，则默认跳转到文件 url 对应的标签页。	Function(file): void
reject	拖拽文件不符合 accept 类型时的回调	Function(fileList)

← 自定义控件异步属性 →