CustomSettingsPanel
Definition of a Custom Panel to add to the Adaptable Settings Panel
TypeScript
export interfaceProperties
| Property | Description |
|---|---|
| frameworkComponent | Framework-specific (Angular, React or Vue) component to be rendered |
| icon | Icon rendered inside settings-panel name, inside the navigation |
| name | Appears in Settings Panel Navigation and must be included in settingsPanelOptions.navigation for it to be displayed (by default added to the end) |
| render | Function 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
icon
Icon rendered inside settings-panel name, inside the navigation
TypeScript
icon?: AdaptableIcon;Property Value
name
Appears in Settings Panel Navigation and must be included in settingsPanelOptions.navigation for it to be displayed (by default added to 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