FileUploader

The FileUploader widget 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.mobile.js, dx.web.js, dx.viz-web.js, dx.all.js
Export: default
FileUploader interactive configuration
Copy Code
Copy to Codepen
$("#fileuploader").dxFileUploader({
});

                    

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the FileUploader widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery
JavaScript
HTML
$(function () {
    $("#fileUploader").dxFileUploader({
        accept:"image/*"
    });
});
<div id="fileUploader"></div>
Angular
HTML
TypeScript
<dx-file-uploader accept="image/*"></dx-file-uploader>
import { DxFileUploaderModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxFileUploaderModule
    ],
    // ...
})
AngularJS
HTML
<div dx-file-uploader="{
    accept: 'image/*'
}"></div>
Knockout
HTML
<div data-bind="dxFileUploader: {
    accept: 'image/*'
}"></div>
ASP.NET MVC Controls
Razor C#
Razor VB
@(Html.DevExtreme().FileUploader()
    .ID("fileUploader")
    .Accept("image/*")
)
@(Html.DevExtreme().FileUploader() _
    .ID("fileUploader") _
    .Accept("image/*")
)

View Demo Watch Video

See Also

Configuration

An object defining configuration options for the FileUploader widget.

Name Description
accept

Specifies a file type or several types accepted by the widget.

accessKey

Specifies the shortcut key that sets focus on the widget.

activeStateEnabled

Specifies whether or not the widget 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.

disabled

Specifies whether the widget responds to user interaction.

elementAttr

Specifies the attributes to be attached to the widget's root element.

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

height

Specifies the widget's height.

hint

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

hoverStateEnabled

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

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 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 widget 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.

onContentReady

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

onDisposing

A function that is executed before the widget is disposed of.

onInitialized

A function that is executed only once, after the widget is initialized.

onOptionChanged

A function that is executed after a widget option 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

A Boolean value specifying whether or not the widget is read-only.

readyToUploadMessage

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

rtlEnabled

Switches the widget to a right-to-left representation.

selectButtonText

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

showFileList

Specifies whether or not the widget displays the list of selected files.

tabIndex

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

uploadButtonText

The text displayed on the button that starts uploading.

uploadedMessage

The message displayed by the widget when uploading is finished.

uploadFailedMessage

The message displayed by the widget on uploading failure.

uploadHeaders

Specifies headers for the upload request.

uploadMethod

Specifies the method for the upload request.

uploadMode

Specifies how the widget uploads files.

uploadUrl

Specifies a target Url for the upload request.

validationError

Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option.

value

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

visible

Specifies whether the widget is visible.

width

Specifies the widget's width.

Methods

This section describes the members used to manipulate the widget.

Name Description
beginUpdate()

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

defaultOptions(rule)

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

dispose()

Disposes of all the resources allocated to the FileUploader instance.

element()

Gets the root widget element.

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

focus()

Sets focus on the widget.

getInstance(element)

Gets the instance of a widget found using its DOM node.

instance()

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

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 widget options.

option(optionName)

Gets the value of a single option.

option(optionName, optionValue)

Updates the value of a single option.

option(options)

Updates the values of several options.

registerKeyHandler(key, handler)

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

repaint()

Repaints the widget. Call it if you made modifications that changed the widget's state to invalid.

reset()

Resets the value option to the default value.

Events

This section describes events fired by this widget.

Name Description
contentReady

Raised when the widget's content is ready.

disposing

Raised before the widget is disposed of.

initialized

Raised only once, after the widget is initialized.

optionChanged

Raised after a widget option 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