Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ElUpload

Upload 上传 https://element.eleme.cn/#/zh-CN/component/upload

Hierarchy

  • VueInputBase
    • ElUpload

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • config: any

    Returns ElUpload

Properties

accept

accept: string

接受上传的文件类型（thumbnail-mode 模式下此参数无效）

action

action: string

必选参数，上传的地址

activeColor

activeColor: string

upload 打开时的背景色

autoUpload

autoUpload: boolean

是否在选取文件后立即进行上传 默认值:true

beforeRemove

beforeRemove: string

删除文件之前的钩子，参数为上传的文件和文件列表，若返回 false 或者返回 Promise 且被 reject，则停止删除。

beforeUpload

beforeUpload: string

上传文件之前的回调，参数为上传的文件，若返回 false 或者返回 Promise 且被 reject，则停止上传。

css

css: ElUploadStyle

data

data: string

domName

domName: string

upload 对应的 name 属性

drag

drag: boolean

是否启用拖拽上传

fileList

fileList: any[]

上传的文件列表, 例如: [{name: 'food.jpg', url: 'https://xxx.cdn.com/xxx.jpg'}]

headers

headers: object

设置上传的请求头部

httpRequest

httpRequest: string

覆盖默认的上传行为，可以自定义上传的实现

inactiveColor

inactiveColor: string

upload 关闭时的背景色

isTip

isTip: boolean

limit

limit: number

最大允许上传个数

listType

listType: ElUploadListType

组件列表样式

multiple

multiple: boolean

关闭时所显示图标的类名，设置此项会忽略 inactive-text

onChange

onChange: string

文件状态改变时的回调，添加文件、上传成功和上传失败时都会被调用

onError

onError: string

文件上传失败时的回调

onExceed

onExceed: string

文件超出个数限制时的回调

onProgress

onProgress: string

文件上传时的回调

onRemove

onRemove: string

文件列表移除文件时的回调

onSuccess

onSuccess: string

文件上传成功时的回调

showFileList

showFileList: boolean

是否显示已上传文件列表

tip

tip: string

validateEvent

validateEvent: boolean

upload 改变 upload 状态时是否触发表单的校验

withCredentials

withCredentials: boolean

支持发送 cookie 凭证信息

Methods

Protected addFile

  • addFile(file: IUploadFile): void

  • 增加新上传的文件不管成功还是失败

    Parameters

    • file: IUploadFile

      上传对象

    Returns void

Protected addFiles

  • addFiles(files: IUploadFile[]): void

  • 增加新上传的文件不管成功还是失败

    Parameters

    • files: IUploadFile[]

      上传对象数组

    Returns void

doGetClassName

  • doGetClassName(): any

  • Returns any

doGetCss

  • doGetCss(): ElUploadStyle

  • Returns ElUploadStyle

doGetMethods

  • doGetMethods(): {} & {} & { handleOnPreview: any }

  • 事件

    Returns {} & {} & { handleOnPreview: any }

doGetVueData

  • doGetVueData(): object

  • 设置默认值

    Returns object

doGetVueHtml

  • doGetVueHtml(): string

  • 获取组件的html

    Returns string

getAttrEditors

  • getAttrEditors(): AttributeEditorBase[]

  • 注意:使用注解注册属性编辑器这里不能少

    Returns AttributeEditorBase[]

getInputElem

  • getInputElem(): JQuery<HTMLElement>

  • Returns JQuery<HTMLElement>

getUploadValue

  • getUploadValue(): IUploadFile[]

  • 得到上传组件的值数组对象

    Returns IUploadFile[]

    返回数组

Protected getVueUploadVal

  • getVueUploadVal(): IElUpload[]

  • 得到上传组件的vue的值数组对象

    Returns IElUpload[]

    返回数组

hookMethodhandleParams

  • hookMethodhandleParams(attr: string, argArray: any): any[]

  • Parameters

    • attr: string
    • argArray: any

    Returns any[]

Protected removeFile

  • removeFile(fileName: any): void

  • 移除文件

    Parameters

    • fileName: any

      文件名

    Returns void

Generated using TypeDoc