Vue FileUploader API

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.

import DxFileUploader from "devextreme-vue/file-uploader"

Type: DxFileUploaderTypes.default

View Demo Read Guides

Props

An object defining configuration options for the FileUploader widget.

Name	Description
abortUpload	A function that cancels the file upload.
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.
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 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. Required to access uploaded files on the server.
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 used in JavaScript frameworks to save the widget instance.
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	Specifies whether the editor 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.
uploadChunk	A function that uploads a file in chunks.
uploadedMessage	The message displayed by the widget when uploading is finished.
uploadFailedMessage	The message displayed by the widget 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 widget 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 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 without reloading data. Call it to update the widget's markup.
reset()	Resets the value option to the default value.
resetOption(optionName)	Resets an option to its 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.

Vue FileUploader API

See Also

Props

See Also

Methods

Events

See Also