ant-design/components/upload/index.en-US.md
Wei Zhu 77b78a9389 docs: Unify type naming (#4636)
* Unify name of ReactNode type in document

* Lowser all string type name

* Lowercase all number type name

* Lowercase all boolean type name

* Unify array type

* Lowercase all object type name

* Unify mutilple types
2017-01-20 20:10:50 +08:00

4.1 KiB
Raw Blame History

category type title
Components Data Entry Upload

Upload file by selecting or dragging.

When To Use

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

You can consult jQuery-File-Upload about how to implement server side upload interface.

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 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 uploadList. 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 string -
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 by old IE (file, fileList) => `boolean Promise`
customRequest override for the default xhr behavior allowing for additional customization and ability to implement your own XMLHttpRequest Function -
onChange A callback function, can be executed when uploading state is changing. See onChange Function -
listType Built-in stylesheets, support for two types: text or picture string 'text'
onPreview A callback function, will be executed when file link is clicked. Function(file) -
onRemove A callback function, will be executed when removing file button is clicked Function(file) -
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

onChange

The function will be called when uploading is in progress, completed or failed

When uploading state change, it returns:

{
  file: { /* ... */ },
  fileList: [ /* ... */ ],
  event: { /* ... */ },
}
  1. file File object for the current operation.

    {
       uid: 'uid',      // unique identifiernegative is recommendto prevent interference with internal generated id
       name: 'xx.png'   // file name
       status: 'done',  // optionsuploading, done, error, removed
       response: '{"status": "success"}',  // response from server
    }
    

    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.

  2. fileList current list of files

  3. event response from server, including uploading progress, supported by advanced browsers.

Please set property url of property fileList to control content of link

customRequest

IE note