JavaScript/jQuery FileManager - Custom

A custom file system provider allows you to implement custom APIs to access and use file systems.

import CustomFileSystemProvider from "devextreme/file_management/custom_provider"
Type:

Object

Use the custom provider's methods to handle file operations (add, delete, rename, and so on).

The following code shows how to create a custom file system provider and bind the FileManager UI component to it:

jQuery
index.js
$(function () {
    $("#file-manager").dxFileManager({ 
        fileSystemProvider: new DevExpress.fileManagement.CustomFileSystemProvider({ 
            getItems: function(pathInfo) { 
                // Your code goes here
            }, 
            renameItem: function(item, name) { 
                // Your code goes here
            }, 
            createDirectory: function(parentDir, name) { 
                // Your code goes here
            }, 
            deleteItem: function(item) { 
                // Your code goes here
            }, 
            moveItem: function(item, destinationDir) { 
                // Your code goes here
            }, 
            copyItem: function(item, destinationDir) { 
                // Your code goes here
            }, 
            uploadFileChunk: function(fileData, chunksInfo, destinationDir) { 
                // Your code goes here
            }, 
            abortFileUpload: function(fileData, chunksInfo, destinationDir) { 
                // Your code goes here
            }, 
            uploadChunkSize: 1000 
        }) 
    });
});

Configuration

This section describes properties that configure a custom file system provider.

Name Description
abortFileUpload

A function that cancels the file upload.
copyItem

A function that copies files or folders.
createDirectory

A function that creates a directory.
dateModifiedExpr

Specifies which data field provides timestamps that indicate when a file was last modified.
deleteItem

A function that deletes a file or folder.
downloadItems

A function that downloads files.
getItems

A function that gets file system items.
getItemsContent

A function that get items content.
hasSubDirectoriesExpr

A function or the name of a data source field that provides information on whether a file or folder contains sub directories.
isDirectoryExpr

Specifies which data field provides information about whether a file system item is a directory.
keyExpr

Specifies the data field that provides keys.
moveItem

A function that moves files and folders.
nameExpr

Specifies which data field provides file and directory names.
renameItem

A function that renames files and folders.
sizeExpr

Specifies which data field provides file sizes.
thumbnailExpr

Specifies which data field provides icons to be used as thumbnails.
uploadFileChunk

A function that uploads a file in chunks.

Methods

This section describes members used to manage file system items.

Name Description
abortFileUpload()

Cancels the file upload.
copyItems()

Copies files or folders.
createDirectory()

Creates a directory.
deleteItems()

Deletes files or folders.
downloadItems()

Downloads files.
getItems()

Gets file system items.
getItemsContent()

Gets items content.
moveItems()

Moves files and folders.
renameItem()

Renames a file or folder.
uploadFileChunk()

Uploads a file in chunks.