React TreeList - toolbar.items
The toolbar can contain the following elements as items:
Predefined controls
Predefined controls appear on the toolbar depending on whether a specific TreeList feature is enabled. The following table illustrates the dependency:Control Name Image Prerequisites addRowButton editing.allowAdding is true applyFilterButton filterRow.visible is true and filterRow.applyFilter is set to "onClick" columnChooserButton columnChooser.enabled is true revertButton editing.mode is set to "batch" saveButton editing.mode is set to "batch" and editing.allowUpdating is true searchPanel searchPanel.visible is true If you need to customize a predefined control, add an object to the items[] array. This object must contain the control's name and properties that you want to customize. If a control does not need customization, simply include its name in the toolbar.items[] array.
The example below customizes the Column Chooser button, adds an Add Row button, and enables the corresponding TreeList features:
App.js- import TreeList, { Editing, Toolbar, Item, ColumnChooser } from 'devextreme-react/tree-list';
- // ...
- function App() {
- return (
- <TreeList ... >
- <Editing allowAdding={true} />
- <ColumnChooser enabled={true} />
- <Toolbar>
- <Item name="addRowButton" />
- <Item
- name="columnChooserButton"
- locateInMenu="auto"
- location="after"
- />
- </Toolbar>
- </TreeList>
- );
- }
IMPORTANTThe TreeList does not display controls missing from the items[] array. Ensure that this array includes controls for all enabled features.DevExtreme components
You can use DevExtreme components as toolbar items. Declare an
Item
element to add a supported component:App.js- import { SelectBox } from 'devextreme-react/select-box';
- import TreeList, { Toolbar, Item } from 'devextreme-react/tree-list';
- // ...
- function App() {
- return (
- <TreeList ... >
- <Toolbar>
- <Item>
- <SelectBox>
- {/* SelectBox properties are specified here */}
- </SelectBox>
- </Item>
- </Toolbar>
- </TreeList>
- );
- }
Custom controls
To use a custom control, specify a template for it.
component
An alias for the template property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
html
The TreeList component evaluates the html property's value. This evaluation, however, makes the TreeList potentially vulnerable to XSS attacks. To guard against these attacks, encode the HTML markup before you assign it to the html property. Refer to the following help topic for more information: Potentially Vulnerable API - html.
You can use the text property as a safe alternative.
location
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
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
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.
- import React from 'react';
- import Toolbar, { Item } from 'devextreme-react/toolbar';
- const renderMenuItem = (data) => {
- return <div><i class="dx-icon-favorites"></i> {data.options.text}</div>;
- }
- function App() {
- return (
- <Toolbar>
- <Item ...
- menuItemRender={renderMenuItem}
- >
- </Item>
- </Toolbar>
- );
- }
- export default App;
See Also
options
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.
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Toolbar, {
- Item
- } from 'devextreme-react/toolbar';
- class App extends React.Component {
- checkBoxOptions = { text: 'Show IDs' };
- render() {
- return (
- <Toolbar ... >
- <Item
- widget="dxCheckBox"
- options={this.checkBoxOptions}
- />
- </Toolbar>
- );
- }
- }
- export default App;
See Also
render
An alias for the template property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
template
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.
The following example adds a custom item to the component. Note that Angular and Vue use custom templates instead of the template property. In React, specify the render or component properties.
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import TreeList, {
- Toolbar, Item
- } from 'devextreme-react/tree-list';
- const renderCustomItem = () => {
- return <div>Custom Item</div>;
- }
- function App() {
- return (
- <TreeList ... >
- <Toolbar>
- <Item ...
- render={renderCustomItem}
- >
- </Item>
- </Toolbar>
- </TreeList>
- );
- }
- export default App;
See Also
widget
A UI component that presents a toolbar item. To configure it, use the options object.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.