Vue FileManager Props
This section describes properties that configure the FileManager UI component's contents, behavior, and appearance.
accessKey
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
activeStateEnabled
The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.
Use this property when you display the component on a platform whose guidelines include the active state change for UI components. See the following GitHub repository for an example of this type of platform: MUI.
allowedFileExtensions
The FileManager UI component cannot upload a file and displays an error message when the file's extension is not allowed.
- <template>
- <DxFileManager
- :allowed-file-extensions="allowedFileExtensions" >
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager
- } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- },
- data() {
- return {
- allowedFileExtensions: ['.js', '.json', '.css']
- };
- }
- };
- </script>
currentPath
- <template>
- <DxFileManager
- :current-path="Documents/Images" >
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager
- } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- },
- data() {
- return {
- // ...
- };
- }
- };
- </script>
currentPathKeys
Each path part has each own key. For example, path "folder1/folder2" has two parts: 'folder1' with the 'f1' key and folder2 with the 'f2' key. To open this location, assign the ["f1","f2"] array of strings to the currentPathKeys property value.
- <template>
- <DxFileManager
- :current-path-keys="keys" >
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager
- } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- },
- data() {
- return {
- keys: ['EB458000-0341-6943', '92F5-4722-A7D6-98EB']
- };
- }
- };
- </script>
customizeDetailColumns
Customizes columns in details view. Applies only if itemView.mode is "details".
- <template>
- <DxFileManager ...
- :customize-detail-columns="fileManager_customizeDetailColumns"
- />
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import DxFileManager from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- },
- methods: {
- fileManager_customizeDetailColumns(columns) {
- // ...
- // Customize the "columns" array objects here
- // ...
- return columns;
- }
- }
- }
- </script>
customizeThumbnail
This function should return one of the following:
- The icon's URL
- The icon's name if the icon is from the DevExtreme icon library
- The icon's CSS class if the icon is from an external icon library (see External Icon Libraries)
- The icon in the Base64 format
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
- <template>
- <DxFileManager ...
- :element-attr="fileManagerAttributes">
- </DxFileManager>
- </template>
- <script>
- import DxFileManager from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- },
- data() {
- return {
- fileManagerAttributes: {
- id: 'elementId',
- class: 'class-name'
- }
- }
- }
- }
- </script>
fileSystemProvider
File system providers are components that provide APIs used to access and modify virtual file systems.
The following example illustrates how to configure an Object file system provider:
- <template>
- <DxFileManager
- :file-system-provider="fileSystem">
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager
- } from 'devextreme-vue/file-manager';
- import { fileSystem } from "./data.js";
- export default {
- components: {
- DxFileManager
- },
- data() {
- return {
- fileSystem
- };
- }
- };
- </script>
- export const fileSystem = [{
- 'name': 'Documents',
- 'isDirectory': true,
- 'items': [{
- 'name': 'Projects',
- 'isDirectory': true,
- 'items': [{
- 'name': 'About.rtf',
- 'isDirectory': false,
- 'size': 1024
- }, {
- 'name': 'Passwords.rtf',
- 'isDirectory': false,
- 'size': 2048
- }]
- }, {
- 'name': 'About.xml',
- 'isDirectory': false,
- 'size': 1024
- }]
- }];
Refer to File System Providers for information on supported file system providers.
height
This property accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScript- height: function() {
- return window.innerHeight / 1.5;
- }
itemView
- <template>
- <DxFileManager>
- <DxItemView
- mode="thumbnails"
- :show-folders="false"
- :show-parent-folder="false"
- >
- </DxItemView>
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager,
- DxItemView
- } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager,
- DxItemView
- },
- data() {
- return {
- //...
- };
- }
- };
- </script>
onContentReady
A function that is executed when the UI component's content is ready and each time the content is changed.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model | any |
Model data. Available only when using Knockout. |
onContextMenuItemClick
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
fileSystemItem |
The file system item for which you invoke the context menu. |
|
itemData |
The clicked item's data. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemIndex |
The clicked item's index. |
|
model | any |
Model data. Available only if you use Knockout. |
viewArea | 'navPane' | 'itemView' |
Specifies whether the context menu is invoked in the navigation panel or in the items area. |
- <template>
- <DxFileManager
- :on-context-menu-item-click="onItemClick" >
- <DxContextMenu>
- <DxItem text="Create .txt Document" :options="{ extension: '.txt' }" />
- <DxItem text="Create .rtf Document" :options="{ extension: '.rtf' }" />
- <DxItem text="Create .xls Document" :options="{ extension: '.xls' }" />
- </DxContextMenu>
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager,
- DxContextMenu,
- DxItem
- // ...
- } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager,
- DxContextMenu,
- DxItem
- // ...
- },
- methods: {
- onItemClick(e) {
- if(e.itemData.options.extension) {
- // your code
- }
- }
- },
- data() {
- return {
- //...
- };
- }
- };
- </script>
onContextMenuShowing
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel showing the context menu. |
|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
fileSystemItem |
The file system item for which you invoke the context menu. |
|
model | any |
Model data. Available only if you use Knockout. |
targetElement |
The file system item's container. It is an HTML Element or a jQuery Element when you use jQuery. This element can be a grid element or a thumbnail (for the items view area), or a tree view node (for the navigation panel). The targetElement field value is 'undefined' if you click on empty space in the items view area. |
|
viewArea | 'navPane' | 'itemView' |
Specifies whether the context menu is invoked in the navigation panel or in the items view area. |
- <template>
- <DxFileManager
- ...
- @context-menu-showing="onContextMenuShowing"
- />
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import DxFileManager from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- },
- methods: {
- onContextMenuShowing(e) {
- const contextMenuItems = ['create', 'rename', 'delete'];
- if (e.viewArea === 'itemView'){
- // your code
- e.cancel = true;
- } else {
- // your code
- e.component.option('contextMenu.items', contextMenuItems);
- }
- }
- }
- }
- </script>
See Also
onCurrentDirectoryChanged
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
directory |
The current directory. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model | any |
The model data. Available only if you use Knockout. |
- <template>
- <DxFileManager
- :on-current-directory-changed="onDirectoryChanged" >
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager
- // ...
- } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- // ...
- },
- methods: {
- onDirectoryChanged(e) {
- // your code
- }
- },
- data() {
- return {
- //...
- };
- }
- };
- </script>
onDisposing
A function that is executed before the UI component is disposed of.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model | any |
Model data. Available only if you use Knockout. |
onErrorOccurred
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
errorCode |
The error code. The following error codes are supported:
|
|
errorText |
The error message. |
|
fileSystemItem |
The processed file or directory. |
|
model | any |
Model data. Available only if you use Knockout. |
- <template>
- <DxFileManager
- :on-error-occurred="onError" >
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager
- // ...
- } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- // ...
- },
- methods: {
- onError(e) {
- // your code
- }
- },
- data() {
- return {
- //...
- };
- }
- };
- </script>
onFocusedItemChanged
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
item |
The currently focused file or directory. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model | any |
The model data. Available only if you use Knockout. |
- <template>
- <DxFileManager
- :on-focused-item-changed="onFocusedItemChangedEv" >
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager
- // ...
- } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- // ...
- },
- methods: {
- onFocusedItemChangedEv(e) {
- // your code
- }
- },
- data() {
- return {
- //...
- };
- }
- };
- </script>
onInitialized
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onOptionChanged
Name | Type | Description |
---|---|---|
model | any |
Model data. Available only if you use Knockout. |
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
value | any |
The modified property's new value. |
The following example shows how to subscribe to component property changes:
- <template>
- <DxFileManager ...
- @option-changed="handlePropertyChange"
- />
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import DxFileManager from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- },
- // ...
- methods: {
- handlePropertyChange: function(e) {
- if(e.name === "changedProperty") {
- // handle the property change here
- }
- }
- }
- }
- </script>
onSelectedFileOpened
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
file |
The opened file. |
|
model | any |
Model data. Available only if you use Knockout. |
- <template>
- <DxFileManager ...
- :on-selected-file-opened="fileManager_onSelectedFileOpened"
- />
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import DxFileManager from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- },
- methods: {
- fileManager_onSelectedFileOpened(e) {
- // Your code goes here
- }
- }
- }
- </script>
onSelectionChanged
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
currentDeselectedItemKeys |
The keys of the file system items whose selection has been cleared. |
|
currentSelectedItemKeys |
The keys of the file system items that have been selected. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model | any |
Model data. Available only if you use Knockout. |
selectedItemKeys |
The keys of all selected file system items. |
|
selectedItems |
The currently selected file system items. |
- <template>
- <DxFileManager ...
- :on-selection-changed="fileManager_onSelectionChanged"
- />
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import DxFileManager from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- },
- methods: {
- fileManager_onSelectionChanged(e) {
- // Your code goes here
- }
- }
- }
- </script>
onToolbarItemClick
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
itemData |
The clicked item's data. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemIndex |
The clicked item's index. |
|
model | any |
Model data. Available only if you use Knockout. |
- <template>
- <DxFileManager ...
- :on-toolbar-item-click="fileManager_onToolbarItemClick"
- />
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import DxFileManager from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- },
- methods: {
- fileManager_onToolbarItemClick(e) {
- // Your code goes here
- }
- }
- }
- </script>
permissions
- <template>
- <DxFileManager>
- <DxPermissions
- :create="true"
- :copy="true"
- :move="true"
- :delete="true"
- :rename="true"
- :upload="true"
- :download="true"
- />
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import { DxFileManager, DxPermissions } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager,
- DxPermissions
- },
- data() {
- return {
- // ...
- }
- }
- }
- </script>
rootFolderName
- <template>
- <DxFileManager
- root-folder-name="Custom Root Folder"
- >
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager
- } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- },
- data() {
- return {
- // ...
- };
- }
- };
- </script>
rtlEnabled
When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.
- DevExpress.config({
- rtlEnabled: true
- });
selectedItemKeys
- <template>
- <DxFileManager
- :selected-item-keys="keys" >
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager
- } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- },
- data() {
- return {
- keys: ['item1_key', 'item2_key', 'item3_key']
- };
- }
- };
- </script>
selectionMode
Specifies whether a user can select a single or multiple files and folders in the item view simultaneously.
- <template>
- <DxFileManager
- :selection-mode="single" >
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager
- } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager
- },
- data() {
- return {
- // ...
- };
- }
- };
- </script>
tabIndex
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
toolbar
The FileManager UI component allows you to add default and custom toolbar items.
Predefined Items
Predefined toolbar items include:
- 'showNavPane' - Shows or hides the navigation panel.
- 'create' - Creates a new directory.
- 'upload' - Uploads a file.
- 'refresh' - Refreshes the file manager content and shows the progress panel.
- 'download' - Downloads a file.
- 'move' - Moves files and directories.
- 'copy' - Copies files and directories.
- 'rename' - Renames files and directories.
- 'delete' - Deletes files and directories.
- 'switchView' - Switches between the 'Details' and 'Thumbnails' file system representation modes.
- 'clearSelection' - Clears selection from files and directories in the Item View area.
To add a predefined item to the toolbar, specify its name and optional settings ('visible', 'location', 'locateInMenu', 'text', 'icon', 'disabled') and add the item to one of the following collections:
items - Displays toolbar items when no file system item is selected.
fileSelectionItems - Displays toolbar items when one or more file system items are selected.
- <template>
- <DxFileManager>
- <DxToolbar>
- <!-- Specifies a predefined item's name and optional settings -->
- <DxItem name="create" text="Create a directory" icon="newfolder" />
- <!-- Specifies a predefined item's name only -->
- <DxItem name="switchView"/>
- <DxItem name="separator"/>
- <!-- Specifies items that are visible when users select files -->
- <DxFileSelectionItem name="copy"/>
- <DxFileSelectionItem name="rename"/>
- </DxToolbar>
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager,
- DxToolbar,
- DxItem,
- DxFileSelectionItem
- } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager,
- DxToolbar,
- DxItem,
- DxFileSelectionItem
- },
- data() {
- return {
- //...
- };
- }
- };
- </script>
Custom Items
To add a custom toolbar item, specify its text and optional settings (for example, a file extension for the toolbar item that creates a new file) and add the item to one of the following collections:
items - Displays toolbar items when no file system item is selected.
fileSelectionItems - Displays toolbar items when one or more file system items are selected.
The widget property allows you to specify a UI component for a custom toolbar item (dxButton is the default UI component). Use the toolbarItemClick event to handle clicks on custom toolbar items.
- <template>
- <DxFileManager>
- <DxToolbar>
- <DxItem
- widget="dxMenu"
- :options="fileMenuOptions"
- />
- </DxToolbar>
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager,
- DxToolbar,
- DxItem
- } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager,
- DxToolbar,
- DxItem
- },
- data() {
- return {
- fileMenuOptions: {
- items: [
- {
- text: "Create new file",
- icon: "plus",
- items: [
- {
- text: "Text Document",
- options: {
- extension: ".txt",
- }
- },
- {
- text: "RTF Document",
- options: {
- extension: ".rtf",
- }
- },
- {
- text: "Spreadsheet",
- options: {
- extension: ".xls",
- }
- }
- ]
- }
- ],
- onItemClick: this.onItemClick
- };
- },
- methods:{
- onItemClick() {
- // ...
- }
- }
- };
- </script>
upload
- <template>
- <DxFileManager>
- <DxUpload
- :chunk-size="500000"
- :max-file-size="1000000"
- />
- </DxFileManager>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import {
- DxFileManager,
- DxUpload
- } from 'devextreme-vue/file-manager';
- export default {
- components: {
- DxFileManager,
- DxUpload
- },
- data() {
- return {
- //...
- };
- }
- };
- </script>
width
This property accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScript- width: function() {
- return window.innerWidth / 1.5;
- }
If you have technical questions, please create a support ticket in the DevExpress Support Center.