Vue FileManager API CTP

The FileManager is a widget that allows users to upload, select, and manage files and directories in different file storages.

NOTE

DevExtreme FileManager is available as a community technology preview (CTP). Should you have any questions or suggestions prior to its official release, please email your comments to support@devexpress.com.

import DxFileManager from "devextreme-vue/file-manager"

Type: DxFileManagerTypes.default

View Demo

Configuration

This section describes options that configure the FileManager widget's contents, behavior, and appearance.

Name	Description
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.
allowedFileExtensions	Specifies the allowed upload file extensions.
contextMenu	Configures the context menu settings.
currentPath	Specifies the path that is used when the FileManager is initialized.
customizeDetailColumns	Customizes columns in details view. Applies only if itemView.mode is "details".
customizeThumbnail	Allows you to provide custom icons to be used as thumbnails.
disabled	Specifies whether the widget responds to user interaction.
elementAttr	Specifies the attributes to be attached to the widget's root element.
fileProvider	Specifies the file provider.
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.
itemView	Configures the file and folder view.
onContentReady	A function that is executed when the widget's content is ready and each time the content is changed.
onCurrentDirectoryChanged	A function that is executed when the current directory 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.
onSelectedFileOpened	A function that is executed when the selected file is opened.
permissions	Specifies actions that a user is allowed to perform on files and folders.
rootFolderName	Specifies the root folder name.
rtlEnabled	Switches the widget to a right-to-left representation.
selectionMode	Specifies whether a user can select a single or multiple files and folders in the item view simultaneously.
tabIndex	Specifies the number of the element when the Tab key is used for navigating.
toolbar	Configures toolbar settings.
upload	Configures upload settings.
visible	Specifies whether the widget is visible.
width	Specifies the widget's width.

Methods

This section describes methods that control the FileManager 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 FileManager instance.
element()	Gets the root widget element.
endUpdate()	Refreshes the widget after a call of the beginUpdate() method.
focus()	Sets focus on the widget.
getCurrentDirectory()	Gets the current directory object.
getInstance(element)	Gets the instance of a widget found using its DOM node.
getSelectedItems()	Gets the selected items.
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.
refresh()	Reloads data and repaints the widget.
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.
resetOption(optionName)	Resets an option to its default value.

Events

This section describes events that the FileManager widget raises.

Name	Description
contentReady	Raised when the widget's content is ready.
currentDirectoryChanged	Raised when the current directory is changed.
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.
selectedFileOpened	Raised when the selected file is opened.

File Providers

File providers are components that provide APIs used to access and modify virtual file systems. This section describes file providers supported by the FileManager.