Skip to main content

API overview

File Manager properties

activePanelOptional. Defines the active panel
dataOptional. An array of objects containing the files structure data
driveOptional. An object with the information about file system such as the total storage capacity and the used space
extraInfoOptional. Adds additional information about files/folders to the preview panel
iconsOptional. Defines the appearance of icons for files and folders
menuOptionsOptional. The function takes the context menu type name (and a file/folder data if necessary) as an input and returns customized context menu options
modeOptional. Defines a display mode of the File Manager
panelsOptional. Defines initially opened folder and selected files/folders
previewsOptional. Defines how previews are generated for a file
readonlyOptional. Enables/disables the readonly mode

File Manager actions

copy-filesFires when copying a file or folder within File Manager
create-fileFires when creating a file
delete-filesFires when deleting a file or folder
download-fileFires when downloading a file or folder
filter-filesFires when the filter state is changed
move-filesFires when moving a file or folder (cutting and pasting it)
open-fileFires when opening a file
open-tree-folderFires when opening or closing a folder that has child folders
provide-dataAllows parsing data to the File Manager widget
rename-fileFires when renaming a file
request-dataFires when folder data is requested
select-fileFires when selecting a file
set-active-panelFires when active panel is changed
set-modeFires when the mode type is changed
set-pathFires when a path is changed
show-previewFires when the visibility of the Preview panel changes
sort-filesFires when sorting files

File Manager methods

detachAllows removing/detaching action handlers
execAllows triggering the File Manager actions
getFileAllows getting data for a file or folder
getReactiveStateGets an object with the reactive properties of File Manager
getStateGets the state object that stores current values of most File Manager properties
getStoresGets an object with the DataStore properties of the Filemanager
interceptAllows intercepting and blocking/modifying actions
onAllows attaching a handler to the inner events
serializeAllows getting the current file structure as a plain array
setNextAllows adding some action into the Event Bus order