# CustomToolbar

Canonical page: https://www.adaptabletools.com/docs/reference/customtoolbar

Custom Toolbar (which AdapTable will manage) enabling devs to populate
Dashboard with bespoke content.

```ts title="TypeScript"
export interface CustomToolbar<TData extends AdaptableFormData = AdaptableFormData> 
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [frameworkComponent](https://www.adaptabletools.com/docs/reference/customtoolbar.md#frameworkcomponent) | [`AdaptableFrameworkComponent`](https://www.adaptabletools.com/docs/reference/adaptableframeworkcomponent.md) | The Framework-specific (Angular, React or Vue) component to be rendered |
| [name](https://www.adaptabletools.com/docs/reference/customtoolbar.md#name) | `string` | How Toolbar is referenced (e.g. in Dashboard Popup when managing toolbars) |
| [onToolbarFormChange](https://www.adaptabletools.com/docs/reference/customtoolbar.md#ontoolbarformchange) | `(formData: TData, context: `[`CustomToolbarFormContext`](https://www.adaptabletools.com/docs/reference/customtoolbarformcontext.md)`<TData>) => void` | Callback invoked whenever the user changes a value in the toolbar form |
| [render](https://www.adaptabletools.com/docs/reference/customtoolbar.md#render) | `(customRenderContext: `[`CustomRenderContext`](https://www.adaptabletools.com/docs/reference/customrendercontext.md)`) => string \| null` | Function to provide custom content when NOT using a Framework wrapper |
| [title](https://www.adaptabletools.com/docs/reference/customtoolbar.md#title) | `string` | Title to display in Toolbar; if unset or empty string, nothing will show |
| [toolbarActions](https://www.adaptabletools.com/docs/reference/customtoolbar.md#toolbaractions) | [`ToolbarActions`](https://www.adaptabletools.com/docs/reference/toolbaractions.md) | Actions available in a Custom Dashboard Toolbar |
| [toolbarButtons](https://www.adaptabletools.com/docs/reference/customtoolbar.md#toolbarbuttons) | [`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`<`[`CustomToolbarButtonContext`](https://www.adaptabletools.com/docs/reference/customtoolbarbuttoncontext.md)`>[]` | Optional set of buttons to show in the Toolbar |
| [toolbarForm](https://www.adaptabletools.com/docs/reference/customtoolbar.md#toolbarform) | [`AdaptableForm`](https://www.adaptabletools.com/docs/reference/adaptableform.md)`<`[`CustomToolbarFormContext`](https://www.adaptabletools.com/docs/reference/customtoolbarformcontext.md)`<TData>, TData>` | Optional inline form to render in the Toolbar (e.g. selects, checkboxes,<br/>inputs).<br/><br/>Use this when you want to expose interactive controls - rather than just<br/>buttons - in your Custom Toolbar without resorting to bespoke `render`<br/>or `frameworkComponent` content.<br/><br/>The form&#39;s `fields` are rendered side-by-side using the `inline` form<br/>layout. When the user changes any value the <br/>callback is invoked. Buttons declared on the form receive a<br/> which includes the current `formData`. |

## Property Details

### frameworkComponent

The Framework-specific (Angular, React or Vue) component to be rendered

```ts title="TypeScript"
frameworkComponent?: AdaptableFrameworkComponent;
```

###### Property Value

[`AdaptableFrameworkComponent`](https://www.adaptabletools.com/docs/reference/adaptableframeworkcomponent.md)

### name

How Toolbar is referenced (e.g. in Dashboard Popup when managing toolbars)

```ts title="TypeScript"
name: string;
```

###### Property Value

`string`

### onToolbarFormChange

Callback invoked whenever the user changes a value in the toolbar form

```ts title="TypeScript"
onToolbarFormChange?: (formData: TData, context: CustomToolbarFormContext<TData>) => void;
```

###### Property Value

`(formData: TData, context: `[`CustomToolbarFormContext`](https://www.adaptabletools.com/docs/reference/customtoolbarformcontext.md)`<TData>) => void`

### render

Function to provide custom content when NOT using a Framework wrapper

```ts title="TypeScript"
render?: (customRenderContext: CustomRenderContext) => string | null;
```

###### Property Value

`(customRenderContext: `[`CustomRenderContext`](https://www.adaptabletools.com/docs/reference/customrendercontext.md)`) => string | null`

### title

Title to display in Toolbar; if unset or empty string, nothing will show

```ts title="TypeScript"
title?: string;
```

###### Property Value

`string`

### toolbarActions

Actions available in a Custom Dashboard Toolbar

```ts title="TypeScript"
toolbarActions?: ToolbarActions;
```

###### Property Value

[`ToolbarActions`](https://www.adaptabletools.com/docs/reference/toolbaractions.md)

### toolbarButtons

Optional set of buttons to show in the Toolbar

```ts title="TypeScript"
toolbarButtons?: AdaptableButton<CustomToolbarButtonContext>[];
```

###### Property Value

[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`<`[`CustomToolbarButtonContext`](https://www.adaptabletools.com/docs/reference/customtoolbarbuttoncontext.md)`>[]`

### toolbarForm

Optional inline form to render in the Toolbar (e.g. selects, checkboxes,
inputs).

Use this when you want to expose interactive controls - rather than just
buttons - in your Custom Toolbar without resorting to bespoke `render`
or `frameworkComponent` content.

The form&#39;s `fields` are rendered side-by-side using the `inline` form
layout. When the user changes any value the 
callback is invoked. Buttons declared on the form receive a
 which includes the current `formData`.

```ts title="TypeScript"
toolbarForm?: AdaptableForm<CustomToolbarFormContext<TData>, TData>;
```

###### Property Value

[`AdaptableForm`](https://www.adaptabletools.com/docs/reference/adaptableform.md)`<`[`CustomToolbarFormContext`](https://www.adaptabletools.com/docs/reference/customtoolbarformcontext.md)`<TData>, TData>`
