Vue FileManager - toolbar.items

Configures toolbar items' settings.

Type:

Array<dxFileManagerToolbarItem | String>

Default Value: [ 'showNavPane', 'create', 'upload', 'switchView', { name: 'separator', location: 'after' }, 'refresh' ]
Accepted Values: 'showNavPane' | 'create' | 'upload' | 'refresh' | 'switchView' | 'download' | 'move' | 'copy' | 'rename' | 'delete' | 'clearSelection' | 'separator'

The FileManager UI component allows you to add default and create custom toolbar items.

jQuery
JavaScript
$(function () {
    $("#file-manager").dxFileManager({
        toolbar: {
            items: [
                {
                    name: "showNavPane",
                    visible: true
                },
                "separator", "create",
                {
                    widget: "dxMenu",
                    location: "before",
                    options: {
                        items: [
                            {
                                text: "Create new file",
                                items: [
                                    {
                                        text: "Plain text document",
                                        extension: ".txt",
                                        onClick: onItemClick
                                    },]
                            }
                        ]
                    }
                }]
        }
    });
});

cssClass

Specifies a CSS class to be applied to the item.

Type:

String

Default Value: undefined

disabled

Specifies whether the UI component item responds to user interaction.

Type:

Boolean

Default Value: false

locateInMenu

Specifies when to display an item in the toolbar's overflow menu.

Type:

String

Default Value: 'never'
Accepted Values: 'always' | 'auto' | 'never'

Use the ToolbarItemLocateInMenuMode enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Always, Never, and Auto.

location

Specifies the toolbar item's location.

Type:

String

Default Value: 'before'
Accepted Values: 'after' | 'before' | 'center'

Whatever template you use for UI component items (default or a custom) will be located according to the value specified for the location field in the item data source object.

Use the ToolbarItemLocation enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Before, After, and Center.

See Also

name

Specifies the toolbar item's name.

Type:

String

Accepted Values: 'showNavPane' | 'create' | 'upload' | 'refresh' | 'switchView' | 'download' | 'move' | 'copy' | 'rename' | 'delete' | 'clearSelection' | 'separator'

options

Configures the DevExtreme UI component used as a toolbar item.

Type:

Object

options should contain the properties of the DevExtreme UI component specified in the widget property. Because of this dependency, options cannot be typed and are not implemented as nested configuration components in Angular, Vue, and React. In these frameworks, specify options with an object. We recommend that you declare the object outside the configuration component in Vue and React to prevent possible issues caused by unnecessary re-rendering.

Angular
app.component.html
app.module.ts
<dx-file-manager ... >
    <dxo-toolbar>
        <dxi-item
            widget="dxCheckBox"
            [options]="{ text: 'Show IDs' }">
        </dxi-item>
    </dxo-toolbar>
</dx-file-manager>
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxFileManagerModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxFileManagerModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxFileManager ... >
        <DxToolbar>
            <DxItem
                widget="dxCheckBox"
                :options="checkBoxOptions"
            />
        </DxToolbar>
    </DxFileManager>
</template>

<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import DxFileManager, {
    DxToolbar,
    DxItem
} from 'devextreme-vue/file-manager';

export default {
    components: {
        DxFileManager,
        DxToolbar,
        DxItem
    },
    data() {
        return {
            checkBoxOptions: { text: 'Show IDs' }
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import FileManager, {
    Toolbar,
    Item
} from 'devextreme-react/file-manager';

class App extends React.Component {
    checkBoxOptions = { text: 'Show IDs' };

    render() {
        return (
            <FileManager ... >
                <Toolbar>
                    <Item
                        widget="dxCheckBox"
                        options={this.checkBoxOptions}
                    />
                </Toolbar>
            </FileManager>
        );
    }
}
export default App;
NOTE
If you use the Menu UI component as a toolbar item, the adaptivityEnabled property does not apply.

showText

Specifies when to display the text for the UI component item.

Type:

String

Default Value: 'always'
Accepted Values: 'always' | 'inMenu'

The text should be specified in the options configuration object.

NOTE
This property is available only for the dxButton widget that presents a toolbar item.

Use the ToolbarItemShowTextMode enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Always and InMenu.

text

Specifies text displayed for the UI component item.

Type:

String

visible

Specifies the toolbar item's visibility.

Type:

Boolean

Default Value: undefined

widget

A UI component that presents a toolbar item. To configure it, use the options object.

Type:

String

Accepted Values: 'dxAutocomplete' | 'dxButton' | 'dxCheckBox' | 'dxDateBox' | 'dxMenu' | 'dxSelectBox' | 'dxTabs' | 'dxTextBox' | 'dxButtonGroup' | 'dxDropDownButton'

NOTE

  • Import the specified UI component's module when using DevExtreme modules.

  • You can specify the widget option for custom toolbar items only.

When using ASP.NET MVC 5 Controls or DevExtreme-Based ASP.NET Core Controls, configure this property with a lambda expression as follows:

Razor C#
Razor VB
@(Html.DevExtreme().FileManager()
    .Toolbar(t => {
        t.Items(i => {
            i.Add().Widget(w => w
                // Instead of Button here you can use any other UI component
                .Button()
                .Text("Back")
            );
        })
    })
)
@(Html.DevExtreme().FileManager() _
    .Toolbar(Sub(t)
        t.Items(Sub(i)
            i.Add().Widget(Function(w)
                ' Instead of Button here you can use any other UI component
                Return w.Button().Text("Back")
            End Function)
        End Sub)
    End Sub)
)