@adaptabletools/adaptable 10.0.4-canary.1 → 10.0.4-canary.5

package/package.json

@@ -1,28 +1,25 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "10.0.4-canary.1",
+  "version": "10.0.4-canary.5",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "main": "index.js",
   "typings": "index.d.ts",
   "dependencies": {
     "@infinite-table/infinite-react": "0.0.1-canary.11",
-    "@types/react": ">=16.8.0",
-    "@types/tinycolor2": "^1.4.2",
-    "babel-polyfill": "^6.26.0",
-    "babel-runtime": "^6.26.0",
     "date-fns": "2.22.1",
     "debug": "^4.3.1",
     "isomorphic-fetch": "^2.2.1",
     "lodash-es": "^4.17.15",
     "normalize.css": "^8.0.1",
     "prop-types": "^15.6.2",
+    "re-resizable": "^6.9.1",
     "react": ">=16.8.0",
     "react-beautiful-dnd": "13.1.0",
-    "react-day-picker": "8.0.0-beta.29",
+    "react-day-picker": "8.0.0-beta.36",
     "react-dom": ">=16.8.0",
     "react-redux": "7.2.4",
     "react-remove-scroll": "2.4.2",
-    "react-toastify": "^7.0.4",
+    "react-toastify": "8.1.0",
     "rebass": "^3.2.2",
     "redux": "4.0.5",
     "rxjs": "6.6.7",
@@ -33,7 +30,7 @@
     "uuid": "^3.3.2"
   },
   "peerDependencies": {
-    "@ag-grid-community/all-modules": ">=26.0.0"
+    "@ag-grid-community/all-modules": ">=26.2.0"
   },
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1637827862614;
+declare const _default: 1643056480240;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1637827862614;
+exports.default = 1643056480240;

package/src/AdaptableInterfaces/AdaptableNoCodeWizard.d.ts

@@ -36,7 +36,7 @@ export interface AdaptableNoCodeWizardOptions {
  *  userName: 'Demo User',
  *  predefinedConfig: demoConfig,
  *
- *  // note we don't need any vendorGrid info, since that's set by the wizard, when
+ *  // note we don't need any agGrid info, since that's set by the wizard, when
  *  // the user configured the columns
  * };
  *

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -1,4 +1,4 @@
-import { RowNode } from '@ag-grid-community/all-modules';
+import { Column, RowNode } from '@ag-grid-community/all-modules';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { ColumnSort } from '../PredefinedConfig/Common/ColumnSort';
@@ -18,7 +18,7 @@ import { IDataService } from '../Utilities/Services/Interface/IDataService';
 import { IReportService } from '../Utilities/Services/Interface/IReportService';
 import { IValidationService } from '../Utilities/Services/Interface/IValidationService';
 import { IModuleService } from '../Utilities/Services/Interface/IModuleService';
-import { MenuContext } from '../PredefinedConfig/Common/Menu';
+import { ContextMenuContext } from '../PredefinedConfig/Common/Menu';
 import { IEntitlementService } from '../Utilities/Services/Interface/IEntitlementService';
 import { IQueryLanguageService } from '../Utilities/Services/Interface/IQueryLanguageService';
 import { IAlertService } from '../Utilities/Services/Interface/IAlertService';
@@ -39,9 +39,7 @@ export interface IAdaptable {
     adaptableStore: IAdaptableStore;
     modules: IModuleCollection;
     /**
-     * Whether the vendor grid has its own column menu that we need to use (e.g. AG Grid Enterprise) or doesnt in which case we build one (e.g. hypergrid)
-     *
-     * Note: if AG Grid is using community or menu is not added then this should be true.
+     * If using AG Grid community (which has no menu)
      */
     embedColumnMenu: boolean;
     /**
@@ -50,6 +48,10 @@ export interface IAdaptable {
      * Avoid unnecessary store calls and rendering
      */
     isInitialised: boolean;
+    /**
+     * Set to true when adaptable is destroyed.
+     */
+    isDestroyed: boolean;
     /**
      * Adaptable contains a number of 'Services' which are created at Startup
      *
@@ -89,7 +91,7 @@ export interface IAdaptable {
     }) => void): () => void;
     _on(eventName: 'CreateAdaptableContextMenuItems', callback: (param: {
         items: AdaptableMenuItem[];
-        menuContext: MenuContext;
+        menuContext: ContextMenuContext;
     }) => void): () => void;
     _emit(eventName: 'CellEditorKeyDown', data: {
         keyDownEvent: KeyboardEvent;
@@ -114,14 +116,14 @@ export interface IAdaptable {
     jumpToRow(rowNode: RowNode): void;
     jumpToColumn(columnId: string): void;
     jumpToCell(columnId: string, rowNode: RowNode): void;
-    getGridContainerElement(): HTMLElement | null;
+    getAgGridContainerElement(): HTMLElement | null;
     setDataSource(dataSource: any): void;
     getGridData(): any[];
     getFilteredData(): any[];
     loadDataSource(dataSource: any): void;
-    updateRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): void;
-    addRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): void;
-    deleteRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): void;
+    updateRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
+    addRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
+    deleteRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
     selectColumn(columnId: string): void;
     selectColumns(columnIds: string[]): void;
     selectAll(): void;
@@ -172,7 +174,7 @@ export interface IAdaptable {
     selectCells(columnIds: string[], startNode: RowNode, endNode: RowNode): void;
     getFirstGroupedColumn(): AdaptableColumn | undefined;
     isRowNodeVisible(rowNode: RowNode): boolean;
-    getVendorColumnType(columnId: string): string | string[];
+    getAgGridColumnType(columnId: string): string | string[];
     getActiveColumnComparator(columnId: string, customSort?: CustomSort, customSortComparer?: ColumnValuesComparer): (valueA: any, valueB: any, nodeA?: RowNode, nodeB?: RowNode, isInverted?: boolean) => number | undefined;
     setColumnSort(columnSorts: ColumnSort[]): void;
     clearColumnSort(): void;
@@ -197,8 +199,8 @@ export interface IAdaptable {
     showQuickFilter(): void;
     hideQuickFilter(): void;
     isQuickFilterAvailable(): boolean;
-    getVendorGridLightThemeName(): string;
-    getVendorGridCurrentThemeName(): string;
+    getAgGridLightThemeName(): string;
+    getAgGridCurrentThemeName(): string;
     applyAdaptableTheme(theme: AdaptableTheme | string): void;
     /**
      * called when you want to destroy the instance & cleanup resources
@@ -214,11 +216,11 @@ export interface IAdaptable {
     expandRowGroupsForValues(columnValues: any[]): void;
     getExpandRowGroupsKeys(): any[];
     getAdaptableContainerElement(): HTMLElement | null;
-    getGridContainerElement(): HTMLElement | null;
+    getAgGridContainerElement(): HTMLElement | null;
     buildStandaloneColumnHeader(adaptableColumn: AdaptableColumn): AdaptableMenuItem[];
     setupColumns(): void;
     updateColDefsForSpecialColumns({ skipSetupColumns }?: {
         skipSetupColumns?: boolean;
     }): void;
-    getVendorGridColumnFieldForColumn(abColumn: AdaptableColumn): string;
+    getAgGridColumnForAdaptableColumn(abColumn: AdaptableColumn): Column;
 }

package/src/AdaptableOptions/AdaptableOptions.d.ts

@@ -18,8 +18,9 @@ import { ToolPanelOptions } from './ToolPanelOptions';
 import { FilterOptions } from './FilterOptions';
 import { QueryLanguageOptions } from './QueryLanguageOptions';
 import { DataChangeHistoryOptions } from './DataChangeHistoryOptions';
+import { SettingsPanelOptions } from './SettingsPanelOptions';
 /**
- * Group of property options enabling developers to set up AdapTable at design time to fit precise requirements - provides Vendor Grid, Predefined Config and other information required to ensure a full, rich user experience
+ * Group of property options enabling developers to set up AdapTable at design time to fit precise requirements - provides AG Grid, Predefined Config and other information required to ensure a full, rich user experience
  */
 export interface AdaptableOptions {
     /**
@@ -69,11 +70,11 @@ export interface AdaptableOptions {
      */
     userName?: string;
     /**
-     * Underlying vendor grid or grid object which AdapTable interacts with.  Note: if using React or Angular Wrapper, no need to populate this property (as `gridOptions` is a separate prop and AdapTable wires up everything)
+     * The AG Grid object which AdapTable interacts with.  Note: if using React or Angular Wrapper, no need to populate this property as AdapTable wires it up differently
      *
      * @defaultValue n/a (Mandatory)
      */
-    vendorGrid?: any;
+    agGridOptions?: any;
     /**
      * Options for managing Notifications in AdapTable
      *
@@ -81,7 +82,7 @@ export interface AdaptableOptions {
      */
     notificationsOptions?: NotificationsOptions;
     /**
-     * Options for setting the 'Div' elements in which AdapTable, the underlying grid, popups and charts are placed
+     * Options for setting the 'Div' elements in which AdapTable, AG Grid, popups and charts are placed
      */
     containerOptions?: ContainerOptions;
     /**
@@ -180,4 +181,8 @@ export interface AdaptableOptions {
      * Predicate definitions provided by developers at Design-Time
      */
     customPredicateDefs?: AdaptablePredicateDef[];
+    /**
+     * Setting panel options
+     */
+    settingsPanelOptions?: SettingsPanelOptions;
 }

package/src/AdaptableOptions/ContainerOptions.d.ts

@@ -10,20 +10,19 @@ export interface ContainerOptions {
      */
     adaptableContainer?: string | HTMLElement;
     /**
-     * Div containing underlying vendor grid- string Id or HTMLElement
+     * Div containing AG Grid instance - string Id or HTMLElement
      *
      * @defaultValue "grid"
      * @gridInfoItem
      */
-    vendorContainer?: string | HTMLElement;
+    agGridContainer?: string | HTMLElement;
     /**
-     * Useful when the vendor grid is instantiated separately (eg: by vendor wrappers like React and Angular flavors).
-     * This is how long AdapTable waits for the vendor grid before giving up connecting to it.
+     *  how long AdapTable waits for AG Grid before giving up connecting to it; useful when AG Grid is instantiated separately (eg: by React or Angular Wrappers)
      *
      * @defaultValue 60s
      * @gridInfoItem
      */
-    vendorContainerWaitTimeout?: number;
+    agGridContainerWaitTimeout?: number;
     /**
      * Name of div where modals appear (if null, will be centre of page)
      *

package/src/AdaptableOptions/DashboardOptions.d.ts

@@ -15,12 +15,12 @@ export interface DashboardOptions {
      */
     canFloat?: boolean;
     /**
-     * Shows Modules dropdown in Dashboard Header (the 'home' icon); each item connects to an AdapTable Module, opening its popup screen
+     * Displays a button which opens the Settings Panel
      *
      * @defaultValue true
      * @gridInfoItem
      */
-    showModulesDropdown?: boolean;
+    showSettingsPanel?: boolean;
     /**
      * Shows Quick Search textbox in the Dashboard Header; the UI component is still subject to the QuickSearch Entitlements
      *

package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts

@@ -4,17 +4,17 @@ import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
  */
 export interface DataChangeHistoryOptions {
     /**
-     * Whether data change history should be active by default; it may be changed at runtime via the UI controls
+     * Whether data change history should be active by default
      *
      * @defaultValue false
      * @gridInfoItem
      */
     activeByDefault?: boolean;
     /**
-     * Function enabling specific data changes to be included/excluded from the Data Change History
+     * Function specifying which data changes to include in Data Change History
      *
      * @defaultValue undefined (all data changes are logged)
      * @gridInfoItem
      */
-    filterDataChange?: (dataChangeInfo: DataChangedInfo) => boolean;
+    showDataChange?: (dataChangeInfo: DataChangedInfo) => boolean;
 }

package/src/AdaptableOptions/DateInputOptions.d.ts

@@ -44,10 +44,14 @@ export interface DateInputOptions {
  * Datepicker buttons which are displayed in the overlay footer
  */
 export declare type DatepickerButton = 
+/**
+ * Clears the datepicker value
+ */
+'clear'
 /**
  * Closes the datepicker overlay
  */
-'close'
+ | 'close'
 /**
  * Selects the current date
  */

package/src/AdaptableOptions/EditOptions.d.ts

@@ -1,6 +1,5 @@
 import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
 import { GridCell } from '../PredefinedConfig/Selection/GridCell';
-import { RowNode } from '@ag-grid-community/all-modules';
 /**
  * Options related to Editing in Adaptable.
  *
@@ -12,16 +11,16 @@ export interface EditOptions {
      */
     validateOnServer?: (dataChangedInfo: DataChangedInfo) => Promise<ValidationResult>;
     /**
-     * Displays message after Server Validation; if true, Info Message appears with ValidationMessage sent by ServerValidation; if there is no Validation Message then no popup is displayed
+     * Displays message after Server Validation
      *
      * @defaultValue true
      * @gridInfoItem
      */
     displayServerValidationMessages?: boolean;
     /**
-     * Function which returns true if given cell is editable
+     * Function which checks if given Grid Cell is editable
      */
-    isCellEditable?: (gridCell: GridCell, rowNode: RowNode) => boolean;
+    isCellEditable?: (gridCell: GridCell) => boolean;
 }
 /**
  * Used for Server Validation ie. after an edit has been made in Adaptable which should be checked on the Server
@@ -32,7 +31,7 @@ export interface ValidationResult {
      */
     ValidationMessage?: string;
     /**
-     * Value to use for edit (instead one provided by user); can be previous (i.e. unchanged) value or a new value, or left empty to accept the edit
+     * Cell Value to use for after Server Validation
      */
     NewValue?: any;
 }

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -45,7 +45,7 @@ export interface ExportOptions {
      */
     systemExportDestinations?: SystemExportDestinations;
     /**
-     * Whether to add a timestamp ('yyyyMMdd_HHmmss') as a suffix to exported file name
+     * Whether to add a timestamp as a suffix to exported file name
      *
      * @defaultValue false
      * @gridInfoItem

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -6,13 +6,13 @@ import { SystemFilterPredicateIds } from '../PredefinedConfig/FilterState';
  */
 export interface FilterOptions {
     /**
-     * Sets whether to display Dropdown in Quick Filter Bar for given Column
+     * Hides the Dropdown in Quick Filter Bar for a given Column
      *
      * @defaultValue undefined
      */
     hideQuickFilterDropdown?: (column: AdaptableColumn) => boolean;
     /**
-     * Sets whether to display the Input in Quick Filter Bar for given Column
+     * Hides the Input in Quick Filter Bar for a given Column
      *
      * @defaultValue undefined
      */
@@ -32,20 +32,20 @@ export interface FilterOptions {
      */
     indicateFilteredColumns?: boolean;
     /**
-     * Uses Adaptable's Filter Form in Column header menu for all columns if 'true' (the default) or those listed; otherwise vendor grid one will be used
+     * Uses Adaptable's Filter Form in Column Menu for all columns if 'true' (the default) or those listed, in preference to AG Grid's Filter Form
      *
      * @defaultValue true
      */
     useAdaptableFilterForm?: boolean | string[];
     /**
-     * Styles Adaptable Filter Form to match styling of current vendor grid
+     * Styles Adaptable Filter Form to match AG Grid's current styling
      *
      * @defaultValue true
      * @gridInfoItem
      */
-    useVendorFilterFormStyle?: boolean;
+    useAgGridFilterFormStyle?: boolean;
     /**
-     * Use Adaptable's Quick Filter for all columns if 'true' (the default) or those listed; otherwise vendor grid one will be used
+     * Use Adaptable's Quick Filter Bar for all columns if 'true' (the default) or those listed, in preference to AG Grid's Floating Filter
      *
      * @defaultValue true
      * @gridInfoItem
@@ -78,7 +78,7 @@ export interface FilterOptions {
      */
     filterActionOnExternalDataChange?: FilterActionOnDataChange;
     /**
-     * Apply selected filters in Filter Form as soon as they are clicked; if false an Apply Filter button is displayed
+     * Apply selected filters (in Filter Form or Quick Filter Bar) as soon as they are clicked; if false an Apply Filter button is displayed
      *
      * @defaultValue true
      * @gridInfoItem
@@ -134,7 +134,7 @@ export interface FilterOptions {
      */
     enableFilterOnSpecialColumns?: boolean;
     /**
-     * Which Adaptable System Filter Predicates are available; provide empty array for none or leave unset for all
+     * Which Adaptable System Filter Predicates are available
      */
     systemFilters?: SystemFilterPredicateIds;
 }

package/src/AdaptableOptions/FinancePluginOptions.d.ts

@@ -28,7 +28,7 @@ export interface FinancePluginOptions {
  */
 export interface InstrumentColumn {
     /**
-     * Column to be defined as an Instrument - its value will provide the `name` property in the FDC3 message
+     * Column defined as an Instrument - its value provides the `name` property in the FDC3 message
      */
     columnId: string;
     /**

package/src/AdaptableOptions/GeneralOptions.d.ts

@@ -1,8 +1,9 @@
+import { AdaptableScope } from '../../types';
 import { AdaptableComparerFunction } from '../PredefinedConfig/Common/AdaptableComparerFunction';
 import { AlternativeModuleName } from '../PredefinedConfig/Common/AlternativeModuleName';
 import { CellSummaryOperation } from '../PredefinedConfig/Common/CellSummary';
 /**
- * General options for configuring AdapTable including managing Primary Keys.
+ * General options for configuring AdapTable including managing Primary Keys
  */
 export interface GeneralOptions {
     /**
@@ -84,7 +85,7 @@ export interface ColumnValuesComparer {
     /**
      * Column for which to compare values
      */
-    columnId: string;
+    scope: AdaptableScope;
     /**
      * Comparer function to use
      */

package/src/AdaptableOptions/MenuOptions.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableMenuItem, MenuContext, UserMenuItem } from '../PredefinedConfig/Common/Menu';
+import { AdaptableMenuItem, ColumnMenuContext, ContextMenuContext, UserMenuItem } from '../PredefinedConfig/Common/Menu';
 /**
  * Options for managing menus in AdapTable
  */
@@ -9,14 +9,14 @@ export interface MenuOptions {
      * @defaultValue true
      * @gridInfoItem
      */
-    showAdaptableContextMenu?: boolean | ((menuItem: AdaptableMenuItem, menuContext: MenuContext) => boolean);
+    showAdaptableContextMenu?: boolean | ((menuItem: AdaptableMenuItem, menuContext: ContextMenuContext) => boolean);
     /**
      * Show Adaptable Column Menu (or specific items); can be boolean value or function invoked for each menu item
      *
      * @defaultValue true
      * @gridInfoItem
      */
-    showAdaptableColumnMenu?: boolean | ((menuItem: AdaptableMenuItem, menuContext: MenuContext) => boolean);
+    showAdaptableColumnMenu?: boolean | ((menuItem: AdaptableMenuItem, menuContext: ColumnMenuContext) => boolean);
     /**
      * Adds 'Ungroup' Column Menu item to a row grouped column
      *
@@ -25,25 +25,25 @@ export interface MenuOptions {
      */
     showUngroupColumnMenuItem?: boolean;
     /**
-     * Order in which Vendor, AdapTable and User Menu items will appear in Column Menu
+     * Order in which AG Grid, AdapTable and User Menu items will appear in Column Menu
      *
-     * @defaultValue 'vendor', 'adaptable', 'user'
+     * @defaultValue 'aggrid', 'adaptable', 'user'
      * @gridInfoItem
      */
-    columnMenuOrder?: ('vendor' | 'adaptable' | 'user')[];
+    columnMenuOrder?: ('aggrid' | 'adaptable' | 'user')[];
     /**
-     * Order in which Vendor, AdapTable and User Menu items will appear in Context Menu
+     * Order in which AG grid, AdapTable and User Menu items will appear in Context Menu
      *
-     * @defaultValue 'vendor', 'adaptable', 'user'
+     * @defaultValue 'aggrid', 'adaptable', 'user'
      * @gridInfoItem
      */
-    contextMenuOrder?: ('vendor' | 'adaptable' | 'user')[];
+    contextMenuOrder?: ('aggrid' | 'adaptable' | 'user')[];
     /**
-     * A collection of UserMenuItem objects to be added to the Column Header Menu (the one that appears as a dropdown in each Column Header).
+     * A collection of UserMenuItem objects to be added to the Column Menu (the one that appears as a dropdown in each Column Header).
      */
-    columnMenuItems?: UserMenuItem[];
+    columnMenuItems?: UserMenuItem<ColumnMenuContext>[];
     /**
      * A collection of UserMenuItem objects to be added to the Context Menu (the one that appears when you right-click on a cell, or cells, in the Grid).
      */
-    contextMenuItems?: UserMenuItem[];
+    contextMenuItems?: UserMenuItem<ContextMenuContext>[];
 }

package/src/AdaptableOptions/NotificationsOptions.d.ts

@@ -1,7 +1,8 @@
-import { AlertButton, AlertDefinition, FlashingAlertProperties } from '../PredefinedConfig/AlertState';
+import { AlertButton, AlertDefinition } from '../PredefinedConfig/AlertState';
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
 import { ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
 import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
+import { FlashingCellProperties } from '../PredefinedConfig/FlashingCellState';
 import { DataChangedInfo } from '../types';
 /**
  * Options related to Alerts, System Status Messages and Notifications in Adaptable.
@@ -26,7 +27,7 @@ export interface NotificationsOptions {
      *
      * @defaultValue BackColors: Green (up), Red (down), Gray (neutral), Duration: 500ms
      */
-    flashingAlertDefaultProperties?: FlashingAlertProperties;
+    flashingCellDefaultProperties?: FlashingCellProperties;
     /**
      * Where Notification will appear (if anywhere)
      *
@@ -104,7 +105,7 @@ export interface NotificationsOptions {
      * @defaultValue false
      * @gridInfoItem
      */
-    showSystemStatusMessageAsAlert?: boolean;
+    showSystemStatusMessageNotifications?: boolean;
     /**
      * How many System Status Messages to hold in State; when limit is reached, oldest Message is removed
      *
@@ -112,6 +113,14 @@ export interface NotificationsOptions {
      * @gridInfoItem
      */
     maxSystemMessagesInStore?: number;
+    /**
+     * Displays the application icon in Notifications (if provided in `UserInterfaceOptions`)
+     * @defaultValue false
+     */
+    showApplicationIcon?: boolean;
+    /**
+     * Function providing Message to display in Alert; if empty, AdapTable provides dynamically
+     */
     alertMessageText?: (alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo) => string | undefined;
 }
 /**

package/src/AdaptableOptions/SettingsPanelOptions.d.ts

@@ -0,0 +1,75 @@
+import { AdaptableApi, AdaptableFrameworkComponent, AdaptableIcon } from '../../types';
+import { AdaptableSettingsPanel } from '../PredefinedConfig/Common/Types';
+export interface SettingsPanelOptions {
+    /**
+     * Title for the Settings Panel
+     *
+     * @defaultValue 'Settings Panel'
+     * @gridInfoItem
+     */
+    title?: string;
+    /**
+     * Icon for Settings Panel  Can be `ConfigurationIcon`, `ApplicationIcon` or a custom Icon
+     *
+     * @defdefaultValueault 'ConfigurationIcon'
+     */
+    icon?: 'ConfigurationIcon' | 'ApplicationIcon' | AdaptableIcon;
+    /**
+     * Ordered items to display at side of Settings Panel
+     */
+    navigation?: {
+        items?: (AdaptableSettingsPanel | string | '-')[];
+    };
+    /**
+     * Initial position of Settings Panel window
+     *
+     * @defaultValue 'Middle of Screen'
+     */
+    position?: {
+        x: number;
+        y: number;
+    };
+    /**
+     * Initial size of Settings Panel
+     *
+     * @defaultValue 'Computed based on size of screen'
+     */
+    size?: {
+        width: number;
+        height: number;
+    };
+    /**
+     * How Settings Panel behaves: can be 'window' (movable, resizable no backdrop) or 'modal' (centre of screen with backdrop)
+     *
+     * @defaultValue 'window'
+     */
+    type?: 'modal' | 'window';
+    /**
+     * Custom Settings Panels provided by developers at design-time
+     */
+    customSettingsPanels?: CustomSettingsPanel[];
+}
+export interface CustomSettingsPanel {
+    /**
+     * Name appears in Settings Panel Navigation
+     * To be shown you must include it in settingsPanelOptions.navigation.
+     * By default is added to the end.
+     */
+    name: string;
+    /**
+     * Icon rendered inside settings-panel name, inside the navigation
+     */
+    icon?: AdaptableIcon;
+    /**
+     * Function to provide bespoke content when NOT using a Framework wrapper
+     */
+    render?: ({ visible, node, adaptableApi, }: {
+        visible: boolean;
+        node: HTMLDivElement;
+        adaptableApi: AdaptableApi;
+    }) => string | null;
+    /**
+     * Framework-specific (Angular or React) component to be rendered
+     */
+    frameworkComponent?: AdaptableFrameworkComponent;
+}

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -49,9 +49,9 @@ export interface ToolPanelOptions {
     /**
      * Order of displayed ToolPanels in Sidebar
      *
-     * @defaultValue ['filters', 'columns', 'AdaptableToolPanel']
+     * @defaultValue ['filters', 'columns', 'adaptable']
      */
-    toolPanelOrder?: ('AdaptableToolPanel' | 'columns' | 'filters')[];
+    toolPanelOrder?: ('adaptable' | 'columns' | 'filters')[];
     /**
      * Display the Modules dropdown
      *