JavaScript/jQuery FileManager - toolbar.items

Configures toolbar items' settings.

Type:

Array<dxFileManagerToolbarItem | FileManagerPredefinedToolbarItem>

Default Value: [ 'showNavPane', 'create', 'upload', 'switchView', { name: 'separator', location: 'after' }, 'refresh' ]

cssClass

Specifies a CSS class to be applied to the item.

Type:

String

| undefined
Default Value: undefined

disabled

Specifies whether the UI component item responds to user interaction.

Type:

Boolean

Default Value: false

icon

Specifies the icon to be displayed on the toolbar item.

Type:

String

Default Value: ''

This property accepts one of the following:

locateInMenu

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

Type:

LocateInMenuMode

Default Value: 'never'

location

Specifies the toolbar item's location.

Type:

ToolbarItemLocation

Default Value: 'before'

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.

See Also

name

Specifies the toolbar item's name.

Type:

FileManagerPredefinedToolbarItem

|

String

options

Configures the DevExtreme UI component used as a toolbar item.

Type: any

Angular

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. Specify options with an object.

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

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. Specify options with an object. We recommend that you declare the object outside the configuration component to prevent possible issues caused by unnecessary re-rendering.

App.vue
<template>
    <DxFileManager ... >
        <DxToolbar>
            <DxItem ...
                widget="dxCheckBox"
                :options="checkBoxOptions"
            />
        </DxToolbar>
    </DxFileManager>
</template>

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

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

export default {
    components: {
        DxFileManager,
        DxToolbar
    },
    data() {
        return {
            checkBoxOptions: { text: 'Show IDs' }
        }
    }
}
</script>
React

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. Specify options with an object. We recommend that you declare the object outside the configuration component to prevent possible issues caused by unnecessary re-rendering.

App.js
import React from 'react';

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

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

const App = () => {
    checkBoxOptions = { text: 'Show IDs' };

    return (
        <FileManager ... >
            <Toolbar>
                <Item
                    widget="dxCheckBox"
                    options={this.checkBoxOptions}
                />
            </Toolbar>
        </FileManager>
    );
};

export default App;

Default toolbar items support the following options:

  • accessKey
  • elementAttr
  • height
  • hint
  • icon
  • stylingMode
  • tabIndex
  • text
  • width
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:

ShowTextMode

Default Value: 'always'

The text should be specified in the options configuration object.

NOTE
This property is available only if the widget property's value is "dxButton".

text

Specifies text displayed for the UI component item.

Type:

String

If you use both this property and a template, the template overrides the text.

visible

Specifies the toolbar item's visibility.

Type:

Boolean

| undefined
Default Value: undefined

widget

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

Type:

ToolbarItemComponent

NOTE

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

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