Toolbars
Toolbars
- Toolbars enhance user interactivity by providing quick access to actions-ensure that all commands referenced in the toolbar are properly defined in the Commands section to avoid missing functionality.
- You can extend
toolbars.jsonand pass the reference name within the component props to use the default toolbar. Alternatively, you can define a custom toolbar and commands directly in your widget configuration file.
"toolbars": [
{
"name": "toolbar",
"commands": [
{
"name": "dataGroup",
"isMenu": false
},
{
"name": "expandAll",
"isMenu": false
},
{
"name": "SEPARATOR"
},
{
"name": "csvExport",
"isMenu": false
},
{
"name": "exportExcel",
"isMenu": false
}
]
}
]
Separators
Add a thin vertical divider between commands by referencing the built-in "SEPARATOR" token in the commands list (the same idea as "DEFAULT_SEPARATOR" for table columns). It renders a non-interactive divider and takes no other properties. Works in both table and form toolbars.
"commands": [
{ "name": "edit" },
{ "name": "SEPARATOR" },
{ "name": "delete" }
]
Selection criteria
Any table toolbar command can declare a selectionCriteria to control when it is enabled based on the number of selected rows. The command is always visible; when the criteria is not met it renders disabled.
| Value | Command is enabled when… |
|---|---|
none (default) | Always enabled — independent of selection. |
one | Exactly one row is selected. |
multiple | One or more rows are selected (supports multi-select). |
"commands": {
"closeContext": { "type": "closeContext", "selectionCriteria": "multiple" },
"editRow": { "label": "Edit", "selectionCriteria": "one" }
}
The built-in closeContext command defaults to selectionCriteria: "multiple", so it stays disabled until at least one closeable row is selected. Selection criteria applies to table toolbars (form toolbars have no row selection, so commands are always enabled).
Toolbar properties
| Prop Name | Description | Data Type | Required | Example |
|---|---|---|---|---|
name | Unique identifier for the toolbar. | string | yes | "toolbar_issue_details" |
commands | References to commands displayed in the toolbar. Each entry may override label, icon, settings, or selectionCriteria from the shared command definition. Supports typed commands such as panel (table: use useSelectedRow; form: uses source form context), genericService, and export, plus built-in commands such as expandAll (table) and edit (form). Use the built-in "SEPARATOR" token to insert a thin vertical divider between commands. | array string | no | ["dataGroup", "SEPARATOR", "csvExport"] |