@syncfusion/ej2-filemanager 29.2.4 → 30.1.37

package/dist/ts/file-manager/models/contextMenu-settings.d.ts

@@ -0,0 +1,33 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+export declare const fileItems: string[];
+export declare const folderItems: string[];
+export declare const layoutItems: string[];
+/**
+ * Specifies the ContextMenu settings of the File Manager.
+ */
+export declare class ContextMenuSettings extends ChildProperty<ContextMenuSettings> {
+    /**
+     * Specifies the array of string or object that is used to configure file items.
+     *
+     * @default fileItems
+     */
+    file: string[];
+    /**
+     * An array of string or object that is used to configure folder items.
+     *
+     * @default folderItems
+     */
+    folder: string[];
+    /**
+     * An array of string or object that is used to configure layout items.
+     *
+     * @default layoutItems
+     */
+    layout: string[];
+    /**
+     * Enables or disables the ContextMenu.
+     *
+     * @default true
+     */
+    visible: boolean;
+}

package/dist/ts/file-manager/models/contextMenu-settings.ts

@@ -0,0 +1,44 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+
+export const fileItems: string[] = ['Open', '|', 'Cut', 'Copy', '|', 'Delete', 'Download', 'Rename', '|', 'Details'];
+export const folderItems: string[] = ['Open', '|', 'Cut', 'Copy', 'Paste', '|', 'Delete', 'Rename', 'Download', '|', 'Details'];
+export const layoutItems: string[] = [
+    'SortBy', 'View', 'Refresh', '|', 'Paste', '|', 'NewFolder', 'Upload', '|', 'Details', '|', 'SelectAll'
+];
+
+/**
+ * Specifies the ContextMenu settings of the File Manager.
+ */
+export class ContextMenuSettings extends ChildProperty<ContextMenuSettings> {
+    /**
+     * Specifies the array of string or object that is used to configure file items.
+     *
+     * @default fileItems
+     */
+    @Property(fileItems)
+    public file: string[];
+
+    /**
+     * An array of string or object that is used to configure folder items.
+     *
+     * @default folderItems
+     */
+    @Property(folderItems)
+    public folder: string[];
+
+    /**
+     * An array of string or object that is used to configure layout items.
+     *
+     * @default layoutItems
+     */
+    @Property(layoutItems)
+    public layout: string[];
+
+    /**
+     * Enables or disables the ContextMenu.
+     *
+     * @default true
+     */
+    @Property(true)
+    public visible: boolean;
+}

package/dist/ts/file-manager/models/default-locale.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Specifies the default locale of FileManager component
+ */
+export declare const defaultLocale: Object;

package/dist/ts/file-manager/models/default-locale.ts

@@ -0,0 +1,101 @@
+/**
+ * Specifies the default locale of FileManager component
+ */
+
+export const defaultLocale: Object = {
+    'NewFolder': 'New folder',
+    'Upload': 'Upload',
+    'Delete': 'Delete',
+    'Rename': 'Rename',
+    'Download': 'Download',
+    'Cut': 'Cut',
+    'Copy': 'Copy',
+    'Paste': 'Paste',
+    'SortBy': 'Sort by',
+    'Refresh': 'Refresh',
+    'Item-Selection': 'item selected',
+    'Items-Selection': 'items selected',
+    'View': 'View',
+    'Details': 'Details',
+    'SelectAll': 'Select all',
+    'Open': 'Open',
+    'Tooltip-NewFolder': 'New folder',
+    'Tooltip-Upload': 'Upload',
+    'Tooltip-Delete': 'Delete',
+    'Tooltip-Rename': 'Rename',
+    'Tooltip-Download': 'Download',
+    'Tooltip-Cut': 'Cut',
+    'Tooltip-Copy': 'Copy',
+    'Tooltip-Paste': 'Paste',
+    'Tooltip-SortBy': 'Sort by',
+    'Tooltip-Refresh': 'Refresh',
+    'Tooltip-Selection': 'Clear selection',
+    'Tooltip-View': 'View',
+    'Tooltip-Details': 'Details',
+    'Tooltip-SelectAll': 'Select all',
+    'Name': 'Name',
+    'Size': 'Size',
+    'DateModified': 'Modified',
+    'DateCreated': 'Date created',
+    'Path': 'Path',
+    'Modified': 'Modified',
+    'Created': 'Created',
+    'Location': 'Location',
+    'Type': 'Type',
+    'Permission': 'Permission',
+    'Ascending': 'Ascending',
+    'Descending': 'Descending',
+    'None': 'None',
+    'View-LargeIcons': 'Large icons',
+    'View-Details': 'Details',
+    'Search': 'Search',
+    'Button-Ok': 'OK',
+    'Button-Cancel': 'Cancel',
+    'Button-Yes': 'Yes',
+    'Button-No': 'No',
+    'Button-Create': 'Create',
+    'Button-Save': 'Save',
+    'Header-NewFolder': 'Folder',
+    'Content-NewFolder': 'Enter your folder name',
+    'Header-Rename': 'Rename',
+    'Content-Rename': 'Enter your new name',
+    'Header-Rename-Confirmation': 'Rename Confirmation',
+    'Content-Rename-Confirmation': 'If you change a file name extension, the file might become unstable. ' +
+        'Are you sure you want to change it?',
+    'Header-Delete': 'Delete File',
+    'Content-Delete': 'Are you sure you want to delete this file?',
+    'Header-Folder-Delete': 'Delete Folder',
+    'Content-Folder-Delete': 'Are you sure you want to delete this folder?',
+    'Header-Multiple-Delete': 'Delete Multiple Items',
+    'Content-Multiple-Delete': 'Are you sure you want to delete these {0} items?',
+    'Header-Duplicate': 'File/Folder exists',
+    'Content-Duplicate': '{0} already exists. Do you want to rename and paste?',
+    'Header-Upload': 'Upload Files',
+    'Error': 'Error',
+    'Validation-Empty': 'The file or folder name cannot be empty.',
+    'Validation-Invalid': 'The file or folder name {0} contains invalid characters. Please use a different name. ' +
+        // eslint-disable-next-line no-useless-escape
+        'Valid file or folder names cannot end with a dot or space, and cannot contain any of the following characters: \\/:*?\"<>|',
+    'Validation-NewFolder-Exists': 'A file or folder with the name {0} already exists.',
+    'Validation-Rename-Exists': 'Cannot rename {0} to {1}: destination already exists.',
+    'Folder-Empty': 'This folder is empty',
+    'File-Upload': 'Drag files here to upload',
+    'Search-Empty': 'No results found',
+    'Search-Key': 'Try with different keywords',
+    'Filter-Empty': 'No results found',
+    'Filter-Key': 'Try with different filter',
+    'Sub-Folder-Error': 'The destination folder is the subfolder of the source folder.',
+    'Same-Folder-Error': 'The destination folder is the same as the source folder.',
+    'Access-Denied': 'Access Denied',
+    'Access-Details': 'You don"t have permission to access this folder.',
+    'Header-Retry': 'File Already Exists',
+    'Content-Retry': 'A file with this name already exists in this folder. What would you like to do?',
+    'Button-Keep-Both': 'Keep both',
+    'Button-Replace': 'Replace',
+    'Button-Skip': 'Skip',
+    'ApplyAll-Label': 'Do this for all current items',
+    'KB': 'KB',
+    'Access-Message': '{0} is not accessible. You need permission to perform the {1} action.',
+    'Network-Error': 'NetworkError: Failed to send on XMLHTTPRequest: Failed to load',
+    'Server-Error': 'ServerError: Invalid response from'
+};

package/dist/ts/file-manager/models/details-view-settings-model.d.ts

@@ -0,0 +1,30 @@
+import { Property, ChildProperty, initializeCSPTemplate } from '@syncfusion/ej2-base';import { ColumnModel } from './index';
+
+/**
+ * Interface for a class DetailsViewSettings
+ */
+export interface DetailsViewSettingsModel {
+
+    /**
+     * If `columnResizing` is set to true, Grid columns can be resized.
+     *
+     * @default true
+     */
+    columnResizing?: boolean;
+
+    /**
+     * Specifies the customizable details view.
+     *
+     * @default {
+     * columns: [{
+     * field: 'name', headerText: 'Name', minWidth: 120, customAttributes: { class: 'e-fe-grid-name' },
+     * template: '\<span class="e-fe-text">${name}\</span>'},{field: 'size', headerText: 'Size',
+     * minWidth: 50, width: '110', template: '\<span class="e-fe-size">${size}\</span>'},
+     * { field: '_fm_modified', headerText: 'DateModified',
+     * minWidth: 50, width: '190'}
+     * ]
+     * }
+     */
+    columns?: ColumnModel[];
+
+}

package/dist/ts/file-manager/models/details-view-settings.d.ts

@@ -0,0 +1,31 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { ColumnModel } from './index';
+/**
+ * Specifies the columns in the details view of the file manager.
+ */
+export declare const columnArray: ColumnModel[];
+/**
+ * Specifies the grid settings of the File Manager.
+ */
+export declare class DetailsViewSettings extends ChildProperty<DetailsViewSettings> {
+    /**
+     * If `columnResizing` is set to true, Grid columns can be resized.
+     *
+     * @default true
+     */
+    columnResizing: boolean;
+    /**
+     * Specifies the customizable details view.
+     *
+     * @default {
+     * columns: [{
+     * field: 'name', headerText: 'Name', minWidth: 120, customAttributes: { class: 'e-fe-grid-name' },
+     * template: '\<span class="e-fe-text">${name}\</span>'},{field: 'size', headerText: 'Size',
+     * minWidth: 50, width: '110', template: '\<span class="e-fe-size">${size}\</span>'},
+     * { field: '_fm_modified', headerText: 'DateModified',
+     * minWidth: 50, width: '190'}
+     * ]
+     * }
+     */
+    columns: ColumnModel[];
+}

package/dist/ts/file-manager/models/details-view-settings.ts

@@ -0,0 +1,54 @@
+import { Property, ChildProperty, initializeCSPTemplate } from '@syncfusion/ej2-base';
+import { ColumnModel } from './index';
+/**
+ * Specifies the columns in the details view of the file manager.
+ */
+export const columnArray: ColumnModel[] = [
+    {
+        field: 'name', headerText: 'Name', minWidth: 120,
+        template: '<span class="e-fe-text">${name}</span>',
+        customAttributes: { class: 'e-fe-grid-name'}
+    },
+    {
+        field: '_fm_modified', headerText: 'DateModified', type: 'dateTime',
+        format: 'MMMM dd, yyyy HH:mm', minWidth: 120, width: '190'
+    },
+    {
+        field: 'size', headerText: 'Size', minWidth: 90, width: '110',
+
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        template: initializeCSPTemplate(function(data: any): string | Function  {
+            return `<span class="e-fe-size">${data.size}</span>`;
+        }) as string | Function, format: 'n2'
+    }
+];
+/**
+ * Specifies the grid settings of the File Manager.
+ */
+export class DetailsViewSettings extends ChildProperty<DetailsViewSettings> {
+
+    /**
+     * If `columnResizing` is set to true, Grid columns can be resized.
+     *
+     * @default true
+     */
+    @Property(true)
+    public columnResizing: boolean;
+
+    /**
+     * Specifies the customizable details view.
+     *
+     * @default {
+     * columns: [{
+     * field: 'name', headerText: 'Name', minWidth: 120, customAttributes: { class: 'e-fe-grid-name' },
+     * template: '\<span class="e-fe-text">${name}\</span>'},{field: 'size', headerText: 'Size',
+     * minWidth: 50, width: '110', template: '\<span class="e-fe-size">${size}\</span>'},
+     * { field: '_fm_modified', headerText: 'DateModified',
+     * minWidth: 50, width: '190'}
+     * ]
+     * }
+     */
+    @Property(columnArray)
+    public columns: ColumnModel[];
+
+}

package/dist/ts/file-manager/models/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * FileExplorer common modules
+ */
+export * from './ajax-settings';
+export * from './ajax-settings-model';
+export * from './toolbar-settings';
+export * from './toolbar-settings-model';
+export * from './search-settings';
+export * from './search-settings-model';
+export * from './details-view-settings-model';
+export * from './details-view-settings';
+export * from './contextMenu-settings';
+export * from './contextMenu-settings-model';
+export * from './navigation-pane-settings-model';
+export * from './navigation-pane-settings';
+export * from './upload-settings';
+export * from './upload-settings-model';
+export * from './column';
+export * from './column-model';

package/dist/ts/file-manager/models/index.ts

@@ -0,0 +1,19 @@
+/**
+ * FileExplorer common modules
+ */
+export * from './ajax-settings';
+export * from './ajax-settings-model';
+export * from './toolbar-settings';
+export * from './toolbar-settings-model';
+export * from './search-settings';
+export * from './search-settings-model';
+export * from './details-view-settings-model';
+export * from './details-view-settings';
+export * from './contextMenu-settings';
+export * from './contextMenu-settings-model';
+export * from './navigation-pane-settings-model';
+export * from './navigation-pane-settings';
+export * from './upload-settings';
+export * from './upload-settings-model';
+export * from './column';
+export * from './column-model';

package/dist/ts/file-manager/models/navigation-pane-settings-model.d.ts

@@ -0,0 +1,40 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+
+/**
+ * Interface for a class NavigationPaneSettings
+ */
+export interface NavigationPaneSettingsModel {
+
+    /**
+     * Specifies the maximum width of navigationpane.
+     *
+     * @default '650px'
+     */
+    maxWidth?: string | number;
+
+    /**
+     * Specifies the minimum width of navigationpane.
+     *
+     * @default '240px'
+     */
+    minWidth?: string | number;
+
+    /**
+     * Enables or disables the navigation pane.
+     *
+     * @default true
+     */
+    visible?: boolean;
+
+    /**
+     * Specifies a value that indicates how to sort the folders in the navigation pane of the file manager component.
+     *
+     * If the sortOrder is Ascending, the folders are sorted in ascending order.
+     * If the sortOrder is Descending, the folders are sorted in descending order.
+     * If the sortOrder is None, the folders are not sorted.
+     *
+     * @default 'None'
+     */
+    sortOrder?: 'None' | 'Ascending' | 'Descending';
+
+}

package/dist/ts/file-manager/models/navigation-pane-settings.d.ts

@@ -0,0 +1,34 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+/**
+ * Specifies the navigationpane settings of the File Manager.
+ */
+export declare class NavigationPaneSettings extends ChildProperty<NavigationPaneSettings> {
+    /**
+     * Specifies the maximum width of navigationpane.
+     *
+     * @default '650px'
+     */
+    maxWidth: string | number;
+    /**
+     * Specifies the minimum width of navigationpane.
+     *
+     * @default '240px'
+     */
+    minWidth: string | number;
+    /**
+     * Enables or disables the navigation pane.
+     *
+     * @default true
+     */
+    visible: boolean;
+    /**
+     * Specifies a value that indicates how to sort the folders in the navigation pane of the file manager component.
+     *
+     * If the sortOrder is Ascending, the folders are sorted in ascending order.
+     * If the sortOrder is Descending, the folders are sorted in descending order.
+     * If the sortOrder is None, the folders are not sorted.
+     *
+     * @default 'None'
+     */
+    sortOrder: 'None' | 'Ascending' | 'Descending';
+}

package/dist/ts/file-manager/models/navigation-pane-settings.ts

@@ -0,0 +1,42 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+
+/**
+ * Specifies the navigationpane settings of the File Manager.
+ */
+export class NavigationPaneSettings extends ChildProperty<NavigationPaneSettings> {
+    /**
+     * Specifies the maximum width of navigationpane.
+     *
+     * @default '650px'
+     */
+    @Property('650px')
+    public maxWidth: string | number;
+
+    /**
+     * Specifies the minimum width of navigationpane.
+     *
+     * @default '240px'
+     */
+    @Property('240px')
+    public minWidth: string | number;
+
+    /**
+     * Enables or disables the navigation pane.
+     *
+     * @default true
+     */
+    @Property(true)
+    public visible: boolean;
+
+    /**
+     * Specifies a value that indicates how to sort the folders in the navigation pane of the file manager component.
+     *
+     * If the sortOrder is Ascending, the folders are sorted in ascending order.
+     * If the sortOrder is Descending, the folders are sorted in descending order.
+     * If the sortOrder is None, the folders are not sorted.
+     *
+     * @default 'None'
+     */
+    @Property('None')
+    public sortOrder: 'None' | 'Ascending' | 'Descending';
+}

package/dist/ts/file-manager/models/search-settings-model.d.ts

@@ -0,0 +1,42 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+import {FilterType} from "./search-settings";
+
+/**
+ * Interface for a class SearchSettings
+ */
+export interface SearchSettingsModel {
+
+    /**
+     * Enables or disables the allowSearchOnTyping.
+     *
+     * @default true
+     */
+    allowSearchOnTyping?: boolean;
+
+    /**
+     * Specifies the filter type while searching the content. The available filter types are:
+     * * `contains`
+     * * `startsWith`
+     * * `endsWith`
+     *
+     * @default 'contains'
+     */
+    filterType?: FilterType;
+
+    /**
+     * If ignoreCase is set to false, searches files that match exactly,
+     * else searches files that are case insensitive(uppercase and lowercase letters treated the same).
+     *
+     * @default true
+     */
+    ignoreCase?: boolean;
+
+    /**
+     * Specifies the placeholder value to the search input of the File Manager component.
+     * It accepts string.
+     *
+     * @default null
+     */
+    placeholder?: string;
+
+}

package/dist/ts/file-manager/models/search-settings.d.ts

@@ -0,0 +1,44 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+/**
+ * Specifies the filter type for Search settings of the File Manager.
+ * ```props
+ * contains :- It will only show files and folders whose names contain the entered word.
+ * startsWith :- It will only show files and folders whose names start with entered word.
+ * endsWith :- It will only show files and folders whose names end with entered word.
+ * ```
+ */
+export declare type FilterType = 'contains' | 'startsWith' | 'endsWith';
+/**
+ * Specifies the Search settings of the File Manager.
+ */
+export declare class SearchSettings extends ChildProperty<SearchSettings> {
+    /**
+     * Enables or disables the allowSearchOnTyping.
+     *
+     * @default true
+     */
+    allowSearchOnTyping: boolean;
+    /**
+     * Specifies the filter type while searching the content. The available filter types are:
+     * * `contains`
+     * * `startsWith`
+     * * `endsWith`
+     *
+     * @default 'contains'
+     */
+    filterType: FilterType;
+    /**
+     * If ignoreCase is set to false, searches files that match exactly,
+     * else searches files that are case insensitive(uppercase and lowercase letters treated the same).
+     *
+     * @default true
+     */
+    ignoreCase: boolean;
+    /**
+     * Specifies the placeholder value to the search input of the File Manager component.
+     * It accepts string.
+     *
+     * @default null
+     */
+    placeholder: string;
+}

package/dist/ts/file-manager/models/search-settings.ts

@@ -0,0 +1,53 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+/**
+ * Specifies the filter type for Search settings of the File Manager.
+ * ```props
+ * contains :- It will only show files and folders whose names contain the entered word.
+ * startsWith :- It will only show files and folders whose names start with entered word.
+ * endsWith :- It will only show files and folders whose names end with entered word.
+ * ```
+ */
+export type FilterType = 'contains' | 'startsWith' | 'endsWith';
+
+/**
+ * Specifies the Search settings of the File Manager.
+ */
+export class SearchSettings extends ChildProperty<SearchSettings> {
+    /**
+     * Enables or disables the allowSearchOnTyping.
+     *
+     * @default true
+     */
+    @Property(true)
+    public allowSearchOnTyping: boolean;
+
+    /**
+     * Specifies the filter type while searching the content. The available filter types are:
+     * * `contains`
+     * * `startsWith`
+     * * `endsWith`
+     *
+     * @default 'contains'
+     */
+    @Property('contains')
+    public filterType: FilterType;
+
+    /**
+     * If ignoreCase is set to false, searches files that match exactly,
+     * else searches files that are case insensitive(uppercase and lowercase letters treated the same).
+     *
+     * @default true
+     */
+    @Property(true)
+    public ignoreCase: boolean;
+
+    /**
+     * Specifies the placeholder value to the search input of the File Manager component.
+     * It accepts string.
+     *
+     * @default null
+     */
+    @Property(null)
+    public placeholder: string;
+}
+