FileManagerModel API in React FileManager API component

Interface for a class FileManager

Properties

beforeDownload

EmitType<BeforeDownloadEventArgs>

Triggers before sending the download request to the server.

beforeImageLoad

EmitType<BeforeImageLoadEventArgs>

Triggers before sending the getImage request to the server.

beforePopupClose

EmitType<BeforePopupOpenCloseEventArgs>

Triggers before the dialog is closed.

beforePopupOpen

EmitType<BeforePopupOpenCloseEventArgs>

Triggers before the dialog is opened.

beforeSend

EmitType<BeforeSendEventArgs>

Triggers before sending the AJAX request to the server.

created

EmitType<Object>

Triggers when the file manager component is created.

destroyed

EmitType<Object>

Triggers when the file manager component is destroyed.

failure

EmitType<FailureEventArgs>

Triggers when the AJAX request is failed.

fileDragStart

EmitType<FileDragEventArgs>

Triggers when the file/folder dragging is started.

fileDragStop

EmitType<FileDragEventArgs>

Triggers when the file/folder is about to be dropped at the target.

fileDragging

EmitType<FileDragEventArgs>

Triggers while dragging the file/folder.

fileDropped

EmitType<FileDragEventArgs>

Triggers when the file/folder is dropped.

fileLoad

EmitType<FileLoadEventArgs>

Triggers before the file/folder is rendered.

fileOpen

EmitType<FileOpenEventArgs>

Triggers before the file/folder is opened.

fileSelect

EmitType<FileSelectEventArgs>

Triggers when the file/folder is selected/unselected.

fileSelection

EmitType<FileSelectionEventArgs>

Triggers before the file/folder is selected.

menuClick

EmitType<MenuClickEventArgs>

Triggers when the context menu item is clicked.

menuOpen

EmitType<MenuOpenEventArgs>

Triggers before the context menu is opened.

popupClose

EmitType<PopupOpenCloseEventArgs>

Triggers when the dialog is closed.

popupOpen

EmitType<PopupOpenCloseEventArgs>

Triggers when the dialog is opened.

success

EmitType<SuccessEventArgs>

Triggers when the AJAX request is success.

toolbarClick

EmitType<ToolbarClickEventArgs>

Triggers when the toolbar item is clicked.

toolbarCreate

EmitType<ToolbarCreateEventArgs>

Triggers before creating the toolbar.

uploadListCreate

EmitType<UploadListCreateArgs>

Triggers before rendering each file item in upload dialog box.

ajaxSettings

AjaxSettingsModel

Specifies the AJAX settings of the file manager.

allowDragAndDrop

boolean

Enables or disables drag-and-drop of files.

allowMultiSelection

boolean

Enables or disables the multiple files selection of the file manager.

contextMenuSettings

ContextMenuSettingsModel

Specifies the context menu settings of the file manager.

cssClass

string

Specifies the root CSS class of the file manager that allows you to customize the appearance by overriding the styles.

detailsViewSettings

DetailsViewSettingsModel

Specifies the details view settings of the file manager.

enableHtmlSanitizer

boolean

Defines whether to allow the cross-scripting site or not.

enablePersistence

boolean

Enables or disables persisting component’s state between page reloads. If enabled, the following APIs will persist:

1. view: Represents the previous view of the file manager.
2. path: Represents the previous path of the file manager.
3. selectedItems: Represents the previous selected items in the file manager.

enableRtl

boolean

Enable or disable rendering component in right to left direction.

enableVirtualization

boolean

Gets or sets a value that enables/disables the virtualization feature of the File Manager. When enabled, the File Manager will only load a subset of files and folders based on the size of the view port, with the rest being loaded dynamically as the user scrolls vertically through the list. This can improve performance when dealing with a large number of files and folders, as it reduces the initial load time and memory usage.

height

string | number

Specifies the height of the file manager.

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

navigationPaneSettings

NavigationPaneSettingsModel

Specifies the navigationpane settings of the file manager.

path

string

Specifies the current path of the file manager.

popupTarget

HTMLElement | string

Specifies the target element in which the File Manager’s dialog will be displayed. The default value is null, which refers to the File Manager element.

rootAliasName

string

Specifies the root folder alias name in file manager

searchSettings

SearchSettingsModel

Specifies the search settings of the file manager.

selectedItems

string[]

Specifies the selected folders and files name of the file manager.

showFileExtension

boolean

Shows or hides the file extension in file manager.

showHiddenItems

boolean

Shows or hides the files and folders that are marked as hidden.

showItemCheckBoxes

boolean

Gets or sets a boolean value that determines whether to display checkboxes in the file manager. If enabled, checkboxes are shown for files or folders on hover.

showThumbnail

boolean

Shows or hides the thumbnail images in largeicons view.

sortBy

string

Specifies the field name being used as the sorting criteria to sort the files of the file manager component.

sortComparer

SortComparer | string

Defines the custom sorting function. The sort comparer function has the same functionality like Array.sort sort comparer. This can be used to customize the default sorting functionalities with required comparison values.

sortOrder

SortOrder

Specifies a value that indicates whether the folders and files are sorted in the ascending or descending order, or they are not sorted at all. The available types of sort orders are, None - Indicates that the folders and files are not sorted. Ascending - Indicates that the folders and files are sorted in the ascending order. Descending - Indicates that the folders and files are sorted in the descending order.

toolbarItems

ToolbarItemModel[]

An array of items that are used to configure File Manager toolbar items.

toolbarSettings

ToolbarSettingsModel

Specifies the group of items aligned horizontally in the toolbar.

uploadSettings

UploadSettingsModel

Specifies the upload settings for the file manager.

view

ViewType

Specifies the initial view of the file manager. With the help of this property, initial view can be changed to details or largeicons view. The available views are:

• LargeIcons
• Details

width

string | number

Specifies the width of the file manager.