@syncfusion/ej2-filemanager 19.4.56 → 20.1.52-10459

package/src/file-manager/base/file-manager.d.ts

@@ -3,6 +3,7 @@ import { INotifyPropertyChanged } from '@syncfusion/ej2-base';
 import { Splitter } from '@syncfusion/ej2-layouts';
 import { Dialog } from '@syncfusion/ej2-popups';
 import { ToolbarSettingsModel } from '../models/index';
+import { ToolbarItemModel } from '../models/index';
 import { NavigationPaneSettingsModel, DetailsViewSettingsModel } from '../models/index';
 import { AjaxSettingsModel, SearchSettingsModel } from '../models/index';
 import { Toolbar } from '../actions/toolbar';
@@ -12,14 +13,16 @@ import { Uploader, FileInfo } from '@syncfusion/ej2-inputs';
 import { UploadSettingsModel } from '../models/upload-settings-model';
 import { FileManagerModel } from './file-manager-model';
 import { ITreeView, IContextMenu, ViewType, SortOrder, FileDragEventArgs, RetryArgs, FileSelectionEventArgs } from './interface';
-import { BeforeSendEventArgs, SuccessEventArgs, FailureEventArgs, FileLoadEventArgs } from './interface';
-import { FileOpenEventArgs, FileSelectEventArgs, MenuClickEventArgs, MenuOpenEventArgs } from './interface';
+import { BeforeSendEventArgs, SuccessEventArgs, FailureEventArgs, FileLoadEventArgs, FolderCreateEventArgs, DeleteEventArgs, RenameEventArgs, MoveEventArgs, SearchEventArgs } from './interface';
+import { FileOpenEventArgs, FileSelectEventArgs, MenuClickEventArgs, MenuOpenEventArgs, MenuCloseEventArgs } from './interface';
 import { ToolbarClickEventArgs, ToolbarCreateEventArgs, UploadListCreateArgs } from './interface';
 import { PopupOpenCloseEventArgs, BeforePopupOpenCloseEventArgs, BeforeDownloadEventArgs, BeforeImageLoadEventArgs } from './interface';
 import { TreeView as BaseTreeView } from '@syncfusion/ej2-navigations';
 import { ContextMenuSettingsModel } from '../models/contextMenu-settings-model';
 import { BreadCrumbBar } from '../actions/breadcrumb-bar';
 import { PositionModel } from '@syncfusion/ej2-base/src/draggable-model';
+import { Virtualization } from '../actions/virtualization';
+import { SortComparer } from './interface';
 /**
  * The FileManager component allows users to access and manage the file system through the web  browser. It can performs the
  * functionalities like add, rename, search, sort, upload and delete files or folders. And also it
@@ -45,6 +48,8 @@ export declare class FileManager extends Component<HTMLElement> implements INoti
     contextmenuModule: IContextMenu;
     /** @hidden */
     breadcrumbbarModule: BreadCrumbBar;
+    /** @hidden */
+    virtualizationModule: Virtualization;
     private keyboardModule;
     private keyConfigs;
     filterData: Object;
@@ -76,6 +81,10 @@ export declare class FileManager extends Component<HTMLElement> implements INoti
     nextPath: string[];
     fileAction: string;
     pasteNodes: string[];
+    responseData: {
+        [key: string]: Object;
+    };
+    existingFileCount: number;
     isLayoutChange: boolean;
     replaceItems: string[];
     createdItem: {
@@ -94,7 +103,6 @@ export declare class FileManager extends Component<HTMLElement> implements INoti
     isMobile: boolean;
     isBigger: boolean;
     isFile: boolean;
-    sortBy: string;
     actionRecords: Object[];
     activeRecords: Object[];
     isCut: boolean;
@@ -142,6 +150,14 @@ export declare class FileManager extends Component<HTMLElement> implements INoti
     destinationPath: string;
     uploadingCount: number;
     uploadedCount: number;
+    isMac: boolean;
+    oldView: string;
+    oldPath: string;
+    private viewElem;
+    private dragSelectElement;
+    private dragX;
+    private dragY;
+    private dragSelectedItems;
     /**
      * Specifies the AJAX settings of the file manager.
      *
@@ -153,6 +169,16 @@ export declare class FileManager extends Component<HTMLElement> implements INoti
      * }
      */
     ajaxSettings: AjaxSettingsModel;
+    /**
+     * Specifies the array of data to populate folders/files in the File Manager.
+     * The mandatory fields to be included in the JSON data are defined in fileData interface.
+     * This interface can be extended to add additional fields as required.
+     *
+     * @default []
+     */
+    fileSystemData: {
+        [key: string]: Object;
+    }[];
     /**
      * Enables or disables drag-and-drop of files.
      *
@@ -165,6 +191,12 @@ export declare class FileManager extends Component<HTMLElement> implements INoti
      * @default true
      */
     allowMultiSelection: 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.
+     *
+     * @default true
+     */
+    showItemCheckBoxes: boolean;
     /**
      * Specifies the context menu settings of the file manager.
      *
@@ -210,6 +242,14 @@ export declare class FileManager extends Component<HTMLElement> implements INoti
      * @default false
      */
     enablePersistence: 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.
+     *
+     * @default false
+     */
+    enableVirtualization: boolean;
     /**
      * Specifies the height of the file manager.
      *
@@ -299,6 +339,30 @@ export declare class FileManager extends Component<HTMLElement> implements INoti
      * @default 'Ascending'
      */
     sortOrder: SortOrder;
+    /**
+     * Specifies the field name being used as the sorting criteria to sort the files of the file manager component.
+     *
+     * @default 'name'
+     */
+    sortBy: string;
+    /**
+     * Defines the custom sorting function.
+     * The sort comparer function has the same functionality like
+     * [`Array.sort`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) sort comparer.
+     * This can be used to customize the default sorting functionalities with required comparison values.
+     *
+     * @default null
+     * @aspType string
+     */
+    sortComparer: SortComparer | string;
+    /**
+     * Gets or sets a value that indicates whether the File Manager allows multiple items selection with mouse dragging.
+     * Set this property to true to allow users to select multiple items with mouse drag as like file explorer. Hover over
+     * the files or folders and drag the mouse to select the required items.
+     *
+     * @default false
+     */
+    enableRangeSelection: boolean;
     /**
      * Specifies the group of items aligned horizontally in the toolbar.
      *
@@ -309,6 +373,16 @@ export declare class FileManager extends Component<HTMLElement> implements INoti
      * }
      */
     toolbarSettings: ToolbarSettingsModel;
+    /**
+     * An array of items that are used to configure File Manager toolbar items.
+     *
+     * @remarks
+     * Use this property if you want to include custom toolbar items along with existing toolbar items. If both `toolbarSettings` and `toolbarItems` are defined, then items will be rendered based on toolbarItems.
+     *
+     * @default []
+     *
+     */
+    toolbarItems: ToolbarItemModel[];
     /**
      * Specifies the upload settings for the file manager.
      *
@@ -317,7 +391,8 @@ export declare class FileManager extends Component<HTMLElement> implements INoti
      *  minFileSize: 0,
      *  maxFileSize: 30000000,
      *  allowedExtensions: '',
-     *  autoClose: false
+     *  autoClose: false,
+     *  directoryUpload: false
      * }
      */
     uploadSettings: UploadSettingsModel;
@@ -330,144 +405,205 @@ export declare class FileManager extends Component<HTMLElement> implements INoti
     /**
      * Triggers before the file/folder is rendered.
      *
-     * @event
+     * @event fileLoad
      */
     fileLoad: EmitType<FileLoadEventArgs>;
     /**
      * Triggers before the file/folder is opened.
      *
-     * @event
+     * @event fileOpen
      */
     fileOpen: EmitType<FileOpenEventArgs>;
     /**
      * Triggers before sending the download request to the server.
      *
-     * @event
+     * @event beforeDownload
      */
     beforeDownload: EmitType<BeforeDownloadEventArgs>;
     /**
      * Triggers before sending the getImage request to the server.
      *
-     * @event
+     * @event beforeImageLoad
      */
     beforeImageLoad: EmitType<BeforeImageLoadEventArgs>;
     /**
      * Triggers before the dialog is closed.
      *
-     * @event
+     * @event beforePopupClose
      */
     beforePopupClose: EmitType<BeforePopupOpenCloseEventArgs>;
     /**
      * Triggers before the dialog is opened.
      *
-     * @event
+     * @event beforePopupOpen
      */
     beforePopupOpen: EmitType<BeforePopupOpenCloseEventArgs>;
     /**
      * Triggers before sending the AJAX request to the server.
      *
-     * @event
+     * @event beforeSend
      */
     beforeSend: EmitType<BeforeSendEventArgs>;
     /**
      * Triggers when the file manager component is created.
      *
-     * @event
+     * @event created
      */
     created: EmitType<Object>;
+    /**
+     * This event is triggered before a folder is created. It allows for the restriction of folder creation based on the application's use case.
+     *
+     * @event beforeFolderCreate
+     */
+    beforeFolderCreate: EmitType<FolderCreateEventArgs>;
+    /**
+     * This event is triggered when a folder is successfully created. It provides an opportunity to retrieve details about the newly created folder.
+     *
+     * @event folderCreate
+     */
+    folderCreate: EmitType<FolderCreateEventArgs>;
     /**
      * Triggers when the file manager component is destroyed.
      *
-     * @event
+     * @event destroyed
      */
     destroyed: EmitType<Object>;
+    /**
+     * This event is triggered before the deletion of a file or folder occurs. It can be utilized to prevent the deletion of specific files or folders. Any actions, such as displaying a spinner for deletion, can be implemented here.
+     *
+     * @event beforeDelete
+     */
+    beforeDelete: EmitType<DeleteEventArgs>;
+    /**
+     * This event is triggered after the file or folder is deleted successfully. The deleted file or folder details can be retrieved here. Additionally, custom elements' visibility can be managed here based on the application's use case.
+     *
+     * @event delete
+     */
+    delete: EmitType<DeleteEventArgs>;
+    /**
+     * This event is triggered when a file or folder is about to be renamed. It allows for the restriction of the rename action for specific folders or files by utilizing the cancel option.
+     *
+     * @event beforeRename
+     */
+    beforeRename: EmitType<RenameEventArgs>;
+    /**
+     * This event is triggered when a file or folder is successfully renamed. It provides an opportunity to fetch details about the renamed file.
+     *
+     * @event rename
+     */
+    rename: EmitType<RenameEventArgs>;
+    /**
+     * This event is triggered when a file or folder begins to move from its current path through a copy/cut and paste action.
+     *
+     * @event beforeMove
+     */
+    beforeMove: EmitType<MoveEventArgs>;
+    /**
+     * This event is triggered when a file or folder is pasted into the destination path.
+     *
+     * @event move
+     */
+    move: EmitType<MoveEventArgs>;
+    /**
+     * This event is triggered when a search action occurs in the search bar of the File Manager component. It triggers each character entered in the input during the search process.
+     *
+     * @event search
+     */
+    search: EmitType<SearchEventArgs>;
     /**
      * Triggers when the file/folder dragging is started.
      *
-     * @event
+     * @event fileDragStart
      */
     fileDragStart: EmitType<FileDragEventArgs>;
     /**
      * Triggers while dragging the file/folder.
      *
-     * @event
+     * @event fileDragging
      */
     fileDragging: EmitType<FileDragEventArgs>;
     /**
      * Triggers when the file/folder is about to be dropped at the target.
      *
-     * @event
+     * @event fileDragStop
      */
     fileDragStop: EmitType<FileDragEventArgs>;
     /**
      * Triggers when the file/folder is dropped.
      *
-     * @event
+     * @event fileDropped
      */
     fileDropped: EmitType<FileDragEventArgs>;
     /**
      * Triggers before the file/folder is selected.
      *
-     * @event
+     * @event fileSelection
      */
     fileSelection: EmitType<FileSelectionEventArgs>;
     /**
      * Triggers when the file/folder is selected/unselected.
      *
-     * @event
+     * @event fileSelect
      */
     fileSelect: EmitType<FileSelectEventArgs>;
     /**
      * Triggers when the context menu item is clicked.
      *
-     * @event
+     * @event menuClick
      */
     menuClick: EmitType<MenuClickEventArgs>;
     /**
      * Triggers before the context menu is opened.
      *
-     * @event
+     * @event menuOpen
      */
     menuOpen: EmitType<MenuOpenEventArgs>;
+    /**
+     * Triggers before the context menu is closed.
+     *
+     * @event menuClose
+     */
+    menuClose: EmitType<MenuCloseEventArgs>;
     /**
      * Triggers when the AJAX request is failed.
      *
-     * @event
+     * @event failure
      */
     failure: EmitType<FailureEventArgs>;
     /**
      * Triggers when the dialog is closed.
      *
-     * @event
+     * @event popupClose
      */
     popupClose: EmitType<PopupOpenCloseEventArgs>;
     /**
      * Triggers when the dialog is opened.
      *
-     * @event
+     * @event popupOpen
      */
     popupOpen: EmitType<PopupOpenCloseEventArgs>;
     /**
      * Triggers when the AJAX request is success.
-     * @event
+     *
+     * @event success
      */
     success: EmitType<SuccessEventArgs>;
     /**
      * Triggers when the toolbar item is clicked.
      *
-     * @event
+     * @event toolbarClick
      */
     toolbarClick: EmitType<ToolbarClickEventArgs>;
     /**
      * Triggers before creating the toolbar.
      *
-     * @event
+     * @event toolbarCreate
      */
     toolbarCreate: EmitType<ToolbarCreateEventArgs>;
     /**
      * Triggers before rendering each file item in upload dialog box.
      *
-     * @event
+     * @event uploadListCreate
      */
     uploadListCreate: EmitType<UploadListCreateArgs>;
     constructor(options?: FileManagerModel, element?: string | HTMLElement);
@@ -538,8 +674,14 @@ export declare class FileManager extends Component<HTMLElement> implements INoti
     private onDetailsInit;
     private resizeHandler;
     private keyActionHandler;
+    private wireSelectOnDragEvent;
     private wireEvents;
     private unWireEvents;
+    private onDragStart;
+    private onDrag;
+    private onDragStop;
+    private selectItems;
+    private onLayoutChange;
     private setPath;
     /**
      * Called internally if any of the property value changed.
@@ -666,6 +808,12 @@ export declare class FileManager extends Component<HTMLElement> implements INoti
      * @returns {void}
      */
     selectAll(): void;
+    /**
+     * Specifies the method that must be invoked to traverse the path backwards in the file manager.
+     *
+     * @returns {void}
+     */
+    traverseBackward(): void;
     /**
      * Deselects the currently selected folders and files in current path.
      *
@@ -692,6 +840,12 @@ export declare class FileManager extends Component<HTMLElement> implements INoti
      * @returns {void}
      */
     uploadFiles(): void;
+    /**
+     * Specifies the method which must be invoked to programmatically close the dialog popup in the file manager.
+     *
+     * @returns {void}
+     */
+    closeDialog(): void;
     /**
      * Specifies the direction of FileManager
      *