React FileManager - toolbar.items

Configures toolbar items' settings.

Type:

Array<dxFileManagerToolbarItem | String>

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

The FileManager widget 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
                                    },]
                            }
                        ]
                    }
                }]
        }
    });
});

component

An alias for the template property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

cssClass

Specifies a CSS class to be applied to the item.

Type:

String

Default Value: undefined

disabled

Specifies whether the widget item responds to user interaction.

Type:

Boolean

Default Value: false

html

Specifies html code inserted into the widget item element.

Type:

String

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 option when the widget 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 widget 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 option when the widget 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

menuItemComponent

An alias for the menuItemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

menuItemRender

An alias for the menuItemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

menuItemTemplate

Specifies a template that should be used to render a menu item.

Type:

template

Template Data: undefined

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a jQuery object of the template's container.
  • Assign a DOM Node of the template's container.
  • Assign a function that returns the jQuery object or a DOM Node of the template's container.
See Also

name

Specifies the toolbar item's name.

Type:

String

Accepted Values: 'showNavPane' | 'create' | 'upload' | 'refresh' | 'viewSwitcher' | 'download' | 'move' | 'copy' | 'rename' | 'delete' | 'clear' | 'separator'

options

Configures the DevExtreme widget used as a toolbar item.

Type:

Object

options should contain the options of the DevExtreme widget specified in the widget option. 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 widget as a toolbar item, the adaptivityEnabled option does not apply.

render

An alias for the template property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

showText

Specifies when to display the text for the widget item.

Type:

String

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

The text should be specified in the options configuration object.

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

Use the ToolbarItemShowTextMode enum to specify this option when the widget 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.

template

Specifies a template that should be used to render this item only.

Type:

template

Template Data: undefined

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a jQuery object of the template's container.
  • Assign a DOM Node of the template's container.
  • Assign a function that returns the jQuery object or a DOM Node of the template's container.
See Also

text

Specifies text displayed for the widget item.

Type:

String

visible

Specifies the toolbar item's visibility.

Type:

Boolean

Default Value: undefined

widget

A widget 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 widget's module when using DevExtreme modules.

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

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