All docs
V20.2
21.1
20.2
20.1
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

FileUploader

The FileUploader UI component enables an end user to upload files to the server. An end user can select files in the file explorer or drag and drop files to the FileUploader area on the page.

Included in: dx.web.js, dx.all.js
Export: default
FileUploader interactive configuration
Copy Code
Copy to Codepen
import FileUploader from "devextreme/ui/file_uploader";

new FileUploader(container, {
});

                    
Type:

Object

Configuration

An object defining configuration properties for the FileUploader UI component.

Name Description
abortUpload

A function that cancels the file upload.

accept

Specifies a file type or several types accepted by the UI component.

accessKey

Specifies the shortcut key that sets focus on the UI component.

activeStateEnabled

Specifies whether or not the UI component changes its state when interacting with a user.

allowCanceling

Specifies if an end user can remove a file from the selection and interrupt uploading.

allowedFileExtensions

Restricts file extensions that can be uploaded to the server.

chunkSize

Specifies the chunk size in bytes. Applies only if uploadMode is "instantly" or "useButtons". Requires a server that can process file chunks.

dialogTrigger

Specifies the HTML element which invokes the file upload dialog.

disabled

Specifies whether the UI component responds to user interaction.

dropZone

Specifies the HTML element in which users can drag and drop files for upload.

elementAttr

Specifies the global attributes to be attached to the UI component's container element.

focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.

height

Specifies the UI component's height.

hint

Specifies text for a hint that appears when a user pauses on the UI component.

hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.

inputAttr

Specifies the attributes to be passed on to the underlying <input> element of the file type.

invalidFileExtensionMessage

The text displayed when the extension of the file being uploaded is not an allowed file extension.

invalidMaxFileSizeMessage

The text displayed when the size of the file being uploaded is greater than the maxFileSize.

invalidMinFileSizeMessage

The text displayed when the size of the file being uploaded is less than the minFileSize.

isValid

Specifies or indicates whether the editor's value is valid.

labelText

Specifies the text displayed on the area to which an end-user can drop a file.

maxFileSize

Specifies the maximum file size (in bytes) allowed for uploading. Applies only if uploadMode is "instantly" or "useButtons".

minFileSize

Specifies the minimum file size (in bytes) allowed for uploading. Applies only if uploadMode is "instantly" or "useButtons".

multiple

Specifies whether the UI component enables an end-user to select a single file or multiple files.

name

Specifies the value passed to the name attribute of the underlying input element. Required to access uploaded files on the server.

onBeforeSend

A function that allows you to customize the request before it is sent to the server.

onContentReady

A function that is executed when the UI component's content is ready and each time the content is changed.

onDisposing

A function that is executed before the UI component is disposed of.

onDropZoneEnter

A function that is executed when the mouse enters a drop zone while dragging a file.

onDropZoneLeave

A function that is executed when the mouse leaves a drop zone as it drags a file.

onFilesUploaded

A function that is executed when all files are successfully uploaded.

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

onOptionChanged

A function that is executed after a UI component property is changed.

onProgress

A function that is executed when a file segment is uploaded.

onUploadAborted

A function that is executed when the file upload is aborted.

onUploaded

A function that is executed when a file is successfully uploaded.

onUploadError

A function that is executed when an error occurs during the file upload.

onUploadStarted

A function that is executed when the file upload is started.

onValueChanged

A function that is executed when one or several files are added to or removed from the selection.

progress

Gets the current progress in percentages.

readOnly

Specifies whether the editor is read-only.

readyToUploadMessage

The message displayed by the UI component when it is ready to upload the specified files.

rtlEnabled

Switches the UI component to a right-to-left representation.

selectButtonText

The text displayed on the button that opens the file browser.

showFileList

Specifies whether or not the UI component displays the list of selected files.

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

uploadAbortedMessage

The message displayed by the UI component when the file upload is cancelled.

uploadButtonText

The text displayed on the button that starts uploading.

uploadChunk

A function that uploads a file in chunks.

uploadCustomData

Specifies custom data for the upload request.

uploadedMessage

The message displayed by the UI component when uploading is finished.

uploadFailedMessage

The message displayed by the UI component on uploading failure.

uploadFile

A function that uploads a file.

uploadHeaders

Specifies headers for the upload request.

uploadMethod

Specifies the method for the upload request.

uploadMode

Specifies how the UI component uploads files.

uploadUrl

Specifies a target Url for the upload request.

validationError

Information on the broken validation rule. Contains the first item from the validationErrors array.

validationErrors

An array of the validation rules that failed.

validationStatus

Indicates or specifies the current validation status.

value

Specifies a File instance representing the selected file. Read-only when uploadMode is "useForm".

visible

Specifies whether the UI component is visible.

width

Specifies the UI component's width.

See Also

Methods

This section describes methods that manage the FileUploader UI component.

Name Description
abortUpload()

Cancels the file upload.

abortUpload(file)

Cancels the file upload.

abortUpload(fileIndex)

Cancels the file upload.

beginUpdate()

Prevents the UI component from refreshing until the endUpdate() method is called.

defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.

dispose()

Disposes of all the resources allocated to the FileUploader instance.

element()

Gets the root UI component element.

endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.

focus()

Sets focus on the UI component.

getInstance(element)

Gets the instance of a UI component found using its DOM node.

instance()

Gets the UI component's instance. Use it to access other methods of the UI component.

off(eventName)

Detaches all event handlers from a single event.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

on(eventName, eventHandler)

Subscribes to an event.

on(events)

Subscribes to events.

option()

Gets all UI component properties.

option(optionName)

Gets the value of a single property.

option(optionName, optionValue)

Updates the value of a single property.

option(options)

Updates the values of several properties.

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

removeFile(file)

Removes a file.

removeFile(fileIndex)

Removes a file with the specified index.

repaint()

Repaints the UI component without reloading data. Call it to update the UI component's markup.

reset()

Resets the value property to the default value.

resetOption(optionName)

Resets an property to its default value.

upload()

Uploads all the selected files.

upload(file)

Uploads the specified file.

upload(fileIndex)

Uploads a file with the specified index.

Events

This section describes events fired by this UI component.

Name Description
beforeSend

Raised before the request is sent to the server and allows you to customize this request.

contentReady

Raised when the UI component's content is ready.

disposing

Raised before the UI component is disposed of.

dropZoneEnter

Raised when the mouse enters a drop zone as it drags a file.

dropZoneLeave

Raised when the mouse leaves a drop zone as it drags a file.

filesUploaded

Raised when all files are successfully uploaded.

initialized

Raised only once, after the UI component is initialized.

optionChanged

Raised after a UI component property is changed.

progress

Raised when a file segment is uploaded.

uploadAborted

Raised when the file upload is aborted.

uploaded

Raised when a file is successfully uploaded.

uploadError

Raised when an error occurs during the file upload.

uploadStarted

Raised when the file upload is started.

valueChanged

Raised when one or several files are added to or removed from the selection.

See Also