@syncfusion/ej2-filemanager 19.4.56 → 20.1.52-10459

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

@@ -1,7 +1,8 @@
 import { Component, EmitType, L10n } from '@syncfusion/ej2-base';
 import { Dialog, ButtonPropsModel } from '@syncfusion/ej2-popups';
 import { FileManagerModel } from '../base/file-manager-model';
-import { ToolbarSettingsModel, AjaxSettingsModel } from '../models/index';
+import { ToolbarSettingsModel, AjaxSettingsModel, ToolbarItemModel } from '../models/index';
+import { DetailsViewSettingsModel } from '../models/details-view-settings-model';
 import { TreeView, ContextMenu, MenuItemModel, ItemModel } from '@syncfusion/ej2-navigations';
 import { DetailsView } from '../layout/details-view';
 import { Toolbar } from '../actions/toolbar';
@@ -11,22 +12,70 @@ import { ContextMenuSettingsModel } from '../models/contextMenu-settings-model';
 import { LargeIconsView } from '../layout';
 import { NavigationPaneSettingsModel } from '../models/navigation-pane-settings-model';
 import { Uploader } from '@syncfusion/ej2-inputs';
-import { BreadCrumbBar } from '../actions';
+import { BreadCrumbBar, Virtualization } from '../actions';
 import { PositionModel } from '@syncfusion/ej2-base/src/draggable-model';
+/**
+ * ValueType is a type that can be a number, string, Date, or boolean.
+ */
+export declare type ValueType = number | string | Date | boolean;
+/**
+ * SortComparer is a function type that takes two ValueType arguments and returns a number.
+ * The function is used for comparing two values for sorting purposes.
+ */
+export declare type SortComparer = (x: ValueType, y: ValueType) => number;
 /**
  * Defines the view type of the FileManager.
+ * ```props
+ * LargeIcons :- Displays the files and folders as large icons.
+ * Details :- Displays the files and folders in a list format.
+ * ```
  */
 export declare type ViewType = 'LargeIcons' | 'Details';
 /**
  * Defines the files sorting order in FileManager.
+ * ```props
+ * Ascending :- Indicates that the folders and files are sorted in the descending order.
+ * Descending :- Indicates that the folders and files are sorted in the ascending order.
+ * None :- Indicates that the folders and files are not sorted.
+ * ```
  */
 export declare type SortOrder = 'Ascending' | 'Descending' | 'None';
 /**
  * Defines the Toolbar items of the FileManager.
+ * ```props
+ * NewFolder :- Allows you to quickly create a new folder.
+ * Upload :- Allows you to quickly and easily upload files from your local computer.
+ * Cut :- Allows you to remove a file or folder from its current location and move it to a different location.
+ * Copy :- Allows you to create a duplicate of a file or folder and place it in a different location.
+ * Paste :- Allows you to place a previously cut or copied file or folder in a new location.
+ * Delete :- Allows you to remove a file or folder permanently.
+ * Download :- Allows you to quickly and easily download files to your local computer.
+ * Rename :- Allows you to change the name of a file or folder.
+ * SortBy :- Allows you to sort files and folder by different criteria such as name, date, size, etc.
+ * Refresh :- Allows you to refresh the current folder's content, showing the changes made on the folder.
+ * Selection :- Allows you to select one or more files or folders.
+ * View :- Allows you to change the way files and folders are displayed.
+ * Details :- Allows you to see additional information about the files and folders, such as the size and date modified.
+ * ```
  */
 export declare type ToolBarItems = 'NewFolder' | 'Upload' | 'Cut' | 'Copy' | 'Paste' | 'Delete' | 'Download' | 'Rename' | 'SortBy' | 'Refresh' | 'Selection' | 'View' | 'Details';
 /**
- * Defines the Context menu items for the FileManager.
+ * ```props
+ * NewFolder :- Allows you to quickly create a new folder
+ * Upload :- Allows you to quickly and easily upload files from your local computer.
+ * Cut :- Allows you to remove a file or folder from its current location and move it to a different location.
+ * Copy :- Allows you to create a duplicate of a file or folder and place it in a different location.
+ * Paste :- Allows you to place a previously cut or copied file or folder in a new location.
+ * Delete :- Allows you to remove a file or folder permanently.
+ * Download :- Allows you to quickly and easily download files to your local computer.
+ * Rename :- Allows you to change the name of a file or folder.
+ * SortBy :- Allows you to sort files and folder by different criteria such as name, date, size, etc.
+ * Refresh :- Allows you to refresh the current folder's content, showing the changes made on the folder.
+ * SelectAll :- Allows you to select all the files and folders in the current folder.
+ * View :- Allows you to change the way files and folders are displayed.
+ * Details :- Allows you to see additional information about the files and folders, such as the size and date modified.
+ * Open :- Allows you to open the selected file or folder.
+ * ```
  */
 export declare type MenuItems = 'NewFolder' | 'Upload' | 'Cut' | 'Copy' | 'Paste' | 'Delete' | 'Download' | 'Rename' | 'SortBy' | 'Refresh' | 'SelectAll' | 'View' | 'Details' | 'Open';
 /**
@@ -110,6 +159,92 @@ export interface FileDetails {
     multipleFiles: boolean;
     permission: Object;
 }
+/**
+ * Interfaces for permission.
+ */
+export interface Permission {
+    /**
+     * Specifies the access permission to read a file or folder.
+     */
+    read?: boolean;
+    /**
+     * Specifies the access permission to write a file or folder.
+     */
+    write?: boolean;
+    /**
+     * Specifies the access permission to download a file or folder.
+     */
+    download: boolean;
+    /**
+     * Specifies the access permission to write the content of folder.
+     */
+    writeContents?: boolean;
+    /**
+     * Specifies the access permission to upload a file or folder.
+     */
+    upload?: boolean;
+    /**
+     * Specifies the access permission message.
+     */
+    message?: string;
+    /**
+     * Specifies the access permission to copy a file or folder.
+     */
+    copy?: boolean;
+}
+/**
+ * Interfaces for fileSystemData.
+ */
+export interface FileData {
+    /**
+     * Specifies the modified data for current item.
+     */
+    dateModified?: Date;
+    /**
+     * Specifies the created data for current item.
+     */
+    dateCreated?: Date;
+    /**
+     * Specifies the filter path representing the traversal path of current item.
+     */
+    filterPath?: string;
+    /**
+     * Specifies whether the current folder has child.
+     */
+    hasChild?: boolean;
+    /**
+     * Specifies the current item id.
+     */
+    id?: number | string;
+    /**
+     * Specifies whether the item is a file or folder.
+     */
+    isFile?: boolean;
+    /**
+     * Specifies the item name.
+     */
+    name?: string;
+    /**
+     * Specifies the parent id for the item.
+     */
+    parentId?: number | string;
+    /**
+     * Specifies the item size.
+     */
+    size?: number;
+    /**
+     * Specifies the item type like ‘.png’, ‘.jpg’, etc.
+     */
+    type?: string;
+    /**
+     * Specifies the url of the image that must be loaded within File Manager.
+     */
+    imageUrl?: string;
+    /**
+     * Specifies the access control permission.
+     */
+    permission?: object;
+}
 /** @hidden */
 export interface DownloadArgs {
     files?: {
@@ -172,6 +307,14 @@ export interface BeforeDownloadEventArgs {
      * If you want to cancel this event then, set cancel to true. Otherwise, false.
      */
     cancel?: boolean;
+    /**
+     * Return the AJAX details, which are send to server.
+     */
+    ajaxSettings?: Object;
+    /**
+     * Specifies whether the download is performed through the form submit method or using an HTTP client instance.
+     */
+    useFormPost?: boolean;
 }
 /**
  * Interface for BeforeImageLoad event arguments.
@@ -186,6 +329,135 @@ export interface BeforeImageLoadEventArgs {
      */
     imageUrl?: string;
 }
+/**
+ * Interface for folder create event arguments.
+ */
+export interface FolderCreateEventArgs {
+    /**
+     * Defines whether to cancel the creation of new folder.
+     */
+    cancel?: boolean;
+    /**
+     * Defines the newly created folder name.
+     */
+    folderName?: string;
+    /**
+     * Returns the parent folder data where the new folder is created.
+     */
+    parentFolder?: {
+        [key: string]: Object;
+    }[];
+    /**
+     * Specifies the current folder path.
+     */
+    path?: string;
+}
+/**
+ * Interface for deleting event arguments.
+ */
+export interface DeleteEventArgs {
+    /**
+     * Defines whether to cancel the delete action of file or folder.
+     */
+    cancel?: boolean;
+    /**
+     * Returns the data of the deleted item.
+     */
+    itemData?: {
+        [key: string]: Object;
+    }[];
+    /**
+     * Specifies the current folder path.
+     */
+    path?: string;
+}
+/**
+ * Interface for Rename event arguments.
+ */
+export interface RenameEventArgs {
+    /**
+     * Defines whether to cancel the rename operation.
+     */
+    cancel?: boolean;
+    /**
+     * Return the new name to be set for the item.
+     */
+    newName?: string;
+    /**
+     * Returns the data of the renamed item.
+     */
+    itemData?: {
+        [key: string]: Object;
+    }[];
+    /**
+     * Specifies the current folder path.
+     */
+    path?: string;
+}
+/**
+ * Interface for Move event arguments.
+ */
+export interface MoveEventArgs {
+    /**
+     * Defines whether to cancel the moving of folder from current path.
+     */
+    cancel?: boolean;
+    /**
+     * Defines whether the current action is `copy`.
+     */
+    isCopy?: boolean;
+    /**
+     * Returns the data of the moved item.
+     */
+    itemData?: {
+        [key: string]: Object;
+    }[];
+    /**
+     * Specifies the current folder path.
+     */
+    path?: string;
+    /**
+     * Returns the data of the target folder to which the file or folder is to be pasted.
+     */
+    targetData?: {
+        [key: string]: Object;
+    };
+    /**
+     * Specifies the target folder path to which the item is pasted.
+     */
+    targetPath?: string;
+}
+/**
+ * Interface for Search event arguments.
+ */
+export interface SearchEventArgs {
+    /**
+     * Return the search results which matches the entered search character.
+     */
+    searchResults?: {
+        [key: string]: Object;
+    }[];
+    /**
+     * Specifies whether the default search action must be cancel.
+     */
+    cancel?: boolean;
+    /**
+     * Specifies the current folder path where the search action takes place.
+     */
+    path?: string;
+    /**
+     * Specifies the search text which is entered in the input element.
+     */
+    searchText?: string;
+    /**
+     * Specifies the searching of file or folder is case sensitive or not.
+     */
+    caseSensitive?: boolean;
+    /**
+     * Specifies whether the user has permission to view hidden items.
+     */
+    showHiddenItems?: boolean;
+}
 /**
  * Interface for Success event arguments.
  */
@@ -406,6 +678,43 @@ export interface MenuOpenEventArgs {
      */
     menuType?: string;
 }
+/**
+ * Interface for MenuClose event arguments.
+ */
+export interface MenuCloseEventArgs {
+    /**
+     * If you want to cancel this event then, set cancel to true. Otherwise, false.
+     */
+    cancel?: boolean;
+    /**
+     * Returns the current context menu element.
+     */
+    element?: HTMLElement;
+    /**
+     * Specifies the actual event.
+     */
+    event?: Event;
+    /**
+     * Returns whether the current context menu is focused or not.
+     */
+    isFocused?: boolean;
+    /**
+     * Returns the target folder/file item as an array of JSON object.
+     */
+    fileDetails?: Object[];
+    /**
+     * Returns the current context menu items as JSON object.
+     */
+    items?: MenuItemModel[];
+    /**
+     * Returns the parent context menu item as JSON object.
+     */
+    parentItem?: MenuItemModel;
+    /**
+     * Returns the current context menu type based on current target.
+     */
+    menuType?: string;
+}
 /**
  * Interface for UploadListCreate event arguments.
  */
@@ -492,7 +801,12 @@ export interface IFileManager extends Component<HTMLElement> {
     feParent: Object[];
     feFiles: Object[];
     ajaxSettings: AjaxSettingsModel;
+    fileSystemData: {
+        [key: string]: Object;
+    }[];
     toolbarSettings: ToolbarSettingsModel;
+    toolbarItems: ToolbarItemModel[];
+    detailsViewSettings: DetailsViewSettingsModel;
     dialogObj: Dialog;
     viewerObj: Dialog;
     extDialogObj: Dialog;
@@ -511,6 +825,7 @@ export interface IFileManager extends Component<HTMLElement> {
     navigationpaneModule: ITreeView;
     largeiconsviewModule: LargeIconsView;
     breadcrumbbarModule: BreadCrumbBar;
+    virtualizationModule: Virtualization;
     toolbarSelection: boolean;
     duplicateItems: string[];
     duplicateRecords: Object[];
@@ -533,13 +848,19 @@ export interface IFileManager extends Component<HTMLElement> {
     isBigger: boolean;
     isFile: boolean;
     allowMultiSelection: boolean;
+    showItemCheckBoxes: boolean;
     selectedItems: string[];
     layoutSelectedItems: string[];
     sortOrder: SortOrder;
     sortBy: string;
+    sortComparer: SortComparer | string;
     actionRecords: Object[];
     activeRecords: Object[];
     pasteNodes: string[];
+    responseData: {
+        [key: string]: Object;
+    };
+    existingFileCount: number;
     isCut: boolean;
     filterData: Object;
     isFiltered: boolean;
@@ -562,6 +883,7 @@ export interface IFileManager extends Component<HTMLElement> {
     folderPath: string;
     showFileExtension: boolean;
     enablePersistence: boolean;
+    enableVirtualization: boolean;
     showHiddenItems: boolean;
     persistData: boolean;
     localeObj: L10n;
@@ -593,6 +915,10 @@ export interface IFileManager extends Component<HTMLElement> {
     destinationPath: string;
     enableHtmlSanitizer: boolean;
     refreshLayout(): void;
+    traverseBackward(): void;
+    isMac: boolean;
+    oldView: string;
+    oldPath: string;
 }
 /** @hidden */
 export interface ITreeView extends Component<HTMLElement> {

package/src/file-manager/base/interface.js

@@ -1 +0,0 @@
-

package/src/file-manager/common/operations.d.ts

@@ -73,6 +73,13 @@ export declare function Delete(parent: IFileManager, items: string[], path: stri
  * @private
  */
 export declare function GetDetails(parent: IFileManager, names: string[], path: string, operation: string): void;
+/**
+ * Checks whether fileSystemData is enabled.
+ *
+ * @param {IFileManager} parent - specifies the parent element.
+ * @returns {boolean} - returns the boolean value.
+ */
+export declare function isFileSystemData(parent: IFileManager): boolean;
 /**
  * Function for search in File Manager.
  *