Defines a Custom ToolPanel - provided by Users and contains custom content

TypeScript
export interface

Properties

PropertyDescription
buttonsOptional set of buttons to show in the ToolPanel
frameworkComponentFramework-specific (Angular, React or Vue) component to be rendered
nameName of Custom ToolPanel - should be unique
renderFunction to provide bespoke content when using AdapTable Vanilla
titleTitle to display in Custom ToolPanel; if undefined, will default to name property

Property Details

buttons

Optional set of buttons to show in the ToolPanel

TypeScript
buttons?: AdaptableButton<CustomToolPanelButtonContext>[];
Property Value

AdaptableButton<CustomToolPanelButtonContext>[]

frameworkComponent

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

TypeScript
frameworkComponent?: AdaptableFrameworkComponent;
Property Value

AdaptableFrameworkComponent

name

Name of Custom ToolPanel - should be unique

TypeScript
name: string;
Property Value

string

render

Function to provide bespoke content when using AdapTable Vanilla

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

(customRenderContext:CustomRenderContext) => string | null

title

Title to display in Custom ToolPanel; if undefined, will default to name property

TypeScript
title?: string;
Property Value

string