CustomSettingsPanel

Definition of a Custom Panel to add to the Adaptable Settings Panel

TypeScript
export interface

Properties

PropertyTypeDescription
frameworkComponentAdaptableFrameworkComponentFramework-specific (Angular, React or Vue) component to be rendered
iconAdaptableIconIcon rendered inside settings-panel name, inside the navigation
namestringAppears in Settings Panel Navigation. Include in navigation to choose placement (by default added to a Custom Panels group at the end).
render(customRenderContext:CustomRenderContext) => string | nullFunction to provide bespoke content when NOT using a Framework wrapper

Property Details

frameworkComponent

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

TypeScript
frameworkComponent?: AdaptableFrameworkComponent;
Property Value

AdaptableFrameworkComponent

icon

Icon rendered inside settings-panel name, inside the navigation

TypeScript
icon?: AdaptableIcon;
Property Value

AdaptableIcon

name

Appears in Settings Panel Navigation. Include in navigation to choose placement (by default added to a Custom Panels group at the end).

TypeScript
name: string;
Property Value

string

render

Function to provide bespoke content when NOT using a Framework wrapper

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

(customRenderContext:CustomRenderContext) => string | null

PreviousCustomRenderFunctionNextCustomSharedEntity