Interface ToolbarOptions

Toolbar options. These options control the toolbar that is displayed at the top of the grid. The toolbar is a collection of buttons and filters that allow the user to interact with the grid. The toolbar is enabled by default. You can disable it by setting enableToolbar to false. You can also customize the toolbar by providing your own renderers for the toolbar, the filter builder, and the global search. You can also enable/disable individual buttons on the toolbar.

Hierarchy

  • ToolbarOptions

Properties

changeDelay?: number

The delay for the global search. The default is 500ms.

enableExcel?: boolean

The flag to enable excel export. This is the excel export button that allows the user to export the grid to excel. The default is true, but for the excel export to work, you need to add the excelExportBehavior to the behaviors property on the grid. Please see https://reactdatagrid.com/examples/?example=Single_Level for an example, and https://github.com/flexicious/euxdt-example/blob/main/src/app/examples/single-level.tsx for the code.

enableExpander?: boolean

For hierarchical grids, the flag to enable the expand all/collapse all buttons. The default is true.

enableFilterchips?: boolean

The flag to enable the filter chips. This is the filter icon that allows the user to open the filter chips dialog. The default is true, but for the filter chips to work, you need to add the filterBehavior to the behaviors property on the grid. Please see the user guide for more information.

enableGlobalSearch?: boolean

The flag to enable global search. This is the search box that allows the user to search all columns. The default is true, but for the global search to work, you need to add the filterBehavior to the behaviors property on the grid. Please see the user guide for more information.

enableGroupingDropzone?: boolean

Flag to enable grouping drop zone. This is the drop zone that allows the user to drag and drop columns to group by. The default is false. Please see https://reactdatagrid.com/examples/?example=Grouping for an example, and https://github.com/flexicious/euxdt-example/blob/main/src/app/examples/grouping-grid.tsx for the code.

enablePdf?: boolean

The flag to enable pdf export. This is the pdf export button that allows the user to export the grid to pdf. The default is true, but for the pdf export to work, you need to add the pdfExportBehavior to the behaviors property on the grid. Please see https://reactdatagrid.com/examples/?example=Single_Level for an example, and https://github.com/flexicious/euxdt-example/blob/main/src/app/examples/single-level.tsx for the code.

enableQuickFind?: boolean

The flag to enable the quick find. Quick find allows the user to search for a value in the grid, and the grid will scroll to the first row that matches the value. The default is true

enableSettings?: boolean

Flag to enable the column chooser. This is the column chooser button that allows the user to show/hide columns. The default is true. This also controls the appearance of the save settings and manage settings buttons, which are enabled if settingsOptions.storageSettingsKey is provided

filterBuilderRenderer?: ((node: RendererProps) => unknown)

Type declaration

leftToolbarRenderer?: ((node: RendererProps) => unknown)

Type declaration

rightToolbarRenderer?: ((node: RendererProps) => unknown)

Type declaration

toolbarRenderer?: ((node: RendererProps) => unknown)

Type declaration

    • (node: RendererProps): unknown
    • toolbarRenderer allows you to provide your own renderer for the toolbar. This allows you to completely customize the toolbar.

      Parameters

      Returns unknown

Generated using TypeDoc