Toolbar and Context Menu
The FileManager component provides the following UI customization properties:
- The toolbar property specifies the toolbar's visibility and available commands.
- The contextMenu property specifies the context menu's availability and its commands.
The toolbar and context menu support context-invariant and context-sensitive items that can be visible or hidden depending on user action.
Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you for the feedback!
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Backend API
<template>
<DxFileManager
ref="fileManager"
:file-system-provider="fileItems"
@context-menu-item-click="onItemClick"
:height="450"
>
<DxPermissions
:create="true"
:copy="true"
:move="true"
:delete="true"
:rename="true"
/>
<DxItemView
:show-parent-folder="false"
>
<DxDetails>
<DxColumn data-field="thumbnail"/>
<DxColumn data-field="name"/>
<DxColumn
data-field="category"
caption="Category"
:width="95"
/>
<DxColumn data-field="dateModified"/>
<DxColumn data-field="size"/>
</DxDetails>
</DxItemView>
<DxToolbar>
<DxItem
name="showNavPane"
:visible="true"
/>
<DxItem name="separator"/>
<DxItem name="create"/>
<DxItem
widget="dxMenu"
location="before"
:options="newFileMenuOptions"
/>
<DxItem name="refresh"/>
<DxItem
name="separator"
location="after"
/>
<DxItem name="switchView"/>
<DxFileSelectionItem name="rename"/>
<DxFileSelectionItem name="separator"/>
<DxFileSelectionItem name="delete"/>
<DxFileSelectionItem name="separator"/>
<DxFileSelectionItem
widget="dxMenu"
location="before"
:options="changeCategoryMenuOptions"
/>
<DxFileSelectionItem name="refresh"/>
<DxFileSelectionItem name="clearSelection"/>
</DxToolbar>
<DxContextMenu>
<DxItem name="create"/>
<DxItem
text="Create new file"
icon="plus"
>
<DxItem
text="Text Document"
:options="{ extension: '.txt' }"
/>
<DxItem
text="RTF Document"
:options="{ extension: '.rtf' }"
/>
<DxItem
text="Spreadsheet"
:options="{ extension: '.xls' }"
/>
</DxItem>
<DxItem
name="rename"
:begin-group="true"
/>
<DxItem name="delete"/>
<DxItem
text="Category"
icon="tags"
:begin-group="true"
>
<DxItem
text="Work"
:options="{ category: 'Work' }"
/>
<DxItem
text="Important"
:options="{ category: 'Important' }"
/>
<DxItem
text="Home"
:options="{ category: 'Home' }"
/>
<DxItem
text="None"
:options="{ category: '' }"
/>
</DxItem>
</DxContextMenu>
</DxFileManager>
</template>
<script>
import {
DxFileManager, DxPermissions, DxToolbar, DxContextMenu, DxItem,
DxFileSelectionItem, DxItemView, DxDetails, DxColumn,
} from 'devextreme-vue/file-manager';
import { fileItems } from './data.js';
export default {
components: {
DxFileManager,
DxPermissions,
DxToolbar,
DxContextMenu,
DxItem,
DxFileSelectionItem,
DxItemView,
DxDetails,
DxColumn,
},
data() {
return {
fileItems,
newFileMenuOptions: this.getNewFileMenuOptions(),
changeCategoryMenuOptions: this.getChangeCategoryMenuOptions(),
};
},
methods: {
onItemClick({ itemData, viewArea, fileSystemItem }) {
let updated = false;
const extension = itemData.options ? itemData.options.extension : undefined;
const category = itemData.options ? itemData.options.category : undefined;
if (extension) {
updated = this.createFile(extension, fileSystemItem);
} else if (category !== undefined) {
updated = this.updateCategory(category, fileSystemItem, viewArea);
}
if (updated) {
this.$refs.fileManager.instance.refresh();
}
},
createFile(fileExtension, directory = this.$refs.fileManager.instance.getCurrentDirectory()) {
const newItem = {
__KEY__: Date.now(),
name: `New file${fileExtension}`,
isDirectory: false,
size: 0,
};
if (!directory.isDirectory) {
return false;
}
let array = null;
if (!directory.dataItem) {
array = this.fileItems;
} else {
array = directory.dataItem.items;
if (!array) {
array = [];
directory.dataItem.items = array;
}
}
array.push(newItem);
return true;
},
updateCategory(newCategory, directory, viewArea) {
let items = null;
if (viewArea === 'navPane') {
items = [directory];
} else {
items = this.$refs.fileManager.instance.getSelectedItems();
}
items.forEach((item) => {
if (item.dataItem) {
item.dataItem.category = newCategory;
}
});
return items.length > 0;
},
getNewFileMenuOptions() {
return {
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,
};
},
getChangeCategoryMenuOptions() {
return {
items: [
{
text: 'Category',
icon: 'tags',
items: [
{
text: 'Work',
options: {
category: 'Work',
},
},
{
text: 'Important',
options: {
category: 'Important',
},
},
{
text: 'Home',
options: {
category: 'Home',
},
},
{
text: 'None',
options: {
category: '',
},
},
],
},
],
onItemClick: this.onItemClick,
};
},
},
};
</script>
import { createApp } from 'vue';
import App from './App.vue';
createApp(App).mount('#app');
<!DOCTYPE html>
<html>
<head>
<title>DevExtreme Demo</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/23.1.5/css/dx.light.css" />
<script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script>
<script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script>
<script type="text/javascript" src="config.js"></script>
<script type="text/javascript">
System.import("./index.js");
</script>
</head>
<body class="dx-viewport">
<div class="demo-container">
<div id="app">
<span v-if="false">Loading...</span>
</div>
</div>
</body>
</html>
export const fileItems = [{
name: 'Documents',
isDirectory: true,
category: 'Work',
items: [{
name: 'Projects',
isDirectory: true,
category: 'Work',
items: [{
name: 'About.rtf',
isDirectory: false,
size: 1024,
}, {
name: 'Passwords.rtf',
isDirectory: false,
category: 'Important',
size: 2048,
}],
}, {
name: 'About.xml',
isDirectory: false,
size: 1024,
}, {
name: 'Managers.rtf',
isDirectory: false,
size: 2048,
}, {
name: 'ToDo.txt',
isDirectory: false,
size: 3072,
}],
}, {
name: 'Images',
isDirectory: true,
category: 'Home',
items: [{
name: 'logo.png',
isDirectory: false,
size: 20480,
}, {
name: 'banner.gif',
isDirectory: false,
size: 10240,
}],
}, {
name: 'System',
isDirectory: true,
category: 'Important',
items: [{
name: 'Employees.txt',
isDirectory: false,
category: 'Important',
size: 3072,
}, {
name: 'PasswordList.txt',
isDirectory: false,
category: 'Important',
size: 5120,
}],
}, {
name: 'Description.rtf',
isDirectory: false,
size: 1024,
}, {
name: 'Description.txt',
isDirectory: false,
size: 2048,
}];
window.exports = window.exports || {};
window.config = {
transpiler: 'plugin-babel',
meta: {
'*.vue': {
loader: 'vue-loader',
},
'*.ts': {
loader: 'demo-ts-loader',
},
'*.svg': {
loader: 'svg-loader',
},
'devextreme/localization.js': {
'esModule': true,
},
},
paths: {
'root:': '../../../../../',
'npm:': 'https://unpkg.com/',
},
map: {
'vue': 'npm:vue@3.3.4/dist/vue.esm-browser.js',
'vue-loader': 'npm:dx-systemjs-vue-browser@1.1.1/index.js',
'demo-ts-loader': 'root:utils/demo-ts-loader.js',
'svg-loader': 'root:utils/svg-loader.js',
'mitt': 'npm:mitt/dist/mitt.umd.js',
'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js',
'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js',
'es6-object-assign': 'npm:es6-object-assign@1.1.0',
'devextreme': 'npm:devextreme@23.1.6/cjs',
'devextreme-vue': 'npm:devextreme-vue@23.1.6',
'jszip': 'npm:jszip@3.7.1/dist/jszip.min.js',
'devextreme-quill': 'npm:devextreme-quill@1.6.2/dist/dx-quill.min.js',
'devexpress-diagram': 'npm:devexpress-diagram@2.2.2/dist/dx-diagram.js',
'devexpress-gantt': 'npm:devexpress-gantt@4.1.49/dist/dx-gantt.js',
'@devextreme/runtime': 'npm:@devextreme/runtime@3.0.12',
'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js',
'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js',
'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js',
'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js',
'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js',
'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js',
'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js',
'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js',
'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js',
'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js',
// Prettier
'prettier/standalone': 'npm:prettier@2.8.4/standalone.js',
'prettier/parser-html': 'npm:prettier@2.8.4/parser-html.js',
},
packages: {
'devextreme-vue': {
main: 'index.js',
},
'devextreme': {
defaultExtension: 'js',
},
'devextreme/events/utils': {
main: 'index',
},
'devextreme/events': {
main: 'index',
},
'es6-object-assign': {
main: './index.js',
defaultExtension: 'js',
},
},
packageConfigPaths: [
'npm:@devextreme/*/package.json',
'npm:@devextreme/runtime@3.0.12/inferno/package.json',
],
babelOptions: {
sourceMaps: false,
stage0: true,
},
};
System.config(window.config);