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

TypeScript
export interface

Properties

PropertyDescription
frameworkComponentThe Framework-specific (Angular, React or Vue) component to be rendered
nameHow Toolbar is referenced (e.g. in Dashboard Popup when managing toolbars)
renderFunction to provide custom content when NOT using a Framework wrapper
titleTitle to display in Toolbar; if unset or empty string, nothing will show
toolbarActionsActions available in a Custom Dashboard Toolbar
toolbarButtonsOptional set of buttons to show in the Toolbar

Property Details

frameworkComponent

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

TypeScript
frameworkComponent?: AdaptableFrameworkComponent;
Property Value

AdaptableFrameworkComponent

name

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

TypeScript
name: string;
Property Value

string

render

Function to provide custom content when NOT using a Framework wrapper

TypeScript
render?: (customRenderContext: CustomRenderContext) => string | null;
Property Value

(customRenderContext:CustomRenderContext) => string | null

title

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

TypeScript
title?: string;
Property Value

string

toolbarActions

Actions available in a Custom Dashboard Toolbar

TypeScript
toolbarActions?: ToolbarActions;
Property Value

ToolbarActions

toolbarButtons

Optional set of buttons to show in the Toolbar

TypeScript
toolbarButtons?: AdaptableButton<CustomToolbarButtonContext>[];
Property Value

AdaptableButton<CustomToolbarButtonContext>[]