@adaptabletools/adaptable 12.0.0-canary.2 → 12.0.0-canary.5

package/index.css

@@ -1177,7 +1177,7 @@ template {
   padding: 0 !important;
   overflow: hidden !important;
   clip: rect(1px, 1px, 1px, 1px) !important;
-  border: 0 !important
+  border: 0 !important;
 }
 
 /* Buttons */
@@ -1201,22 +1201,23 @@ template {
   border: 2px solid transparent;
 }
 
-.rdp-button[disabled] {
+.rdp-button[aria-disabled='true'] {
   opacity: 0.25;
+  pointer-events: none;
 }
 
-.rdp-button:not([disabled]) {
+.rdp-button:not([aria-disabled='true']) {
   cursor: pointer;
 }
 
-.rdp-button:focus:not([disabled]),
-.rdp-button:active:not([disabled]) {
+.rdp-button:focus,
+.rdp-button:active {
   color: inherit;
   border: var(--rdp-outline);
   background-color: var(--rdp-background-color);
 }
 
-.rdp-button:hover:not([disabled]) {
+.rdp-button:hover:not([aria-disabled='true']) {
   background-color: var(--rdp-background-color);
 }
 
@@ -1347,8 +1348,8 @@ template {
   color: unset;
 }
 
-.rdp-dropdown:focus:not([disabled])+.rdp-caption_label,
-.rdp-dropdown:active:not([disabled])+.rdp-caption_label {
+.rdp-dropdown:focus:not([disabled]) + .rdp-caption_label,
+.rdp-dropdown:active:not([disabled]) + .rdp-caption_label {
   border: var(--rdp-outline);
   border-radius: 6px;
   background-color: var(--rdp-background-color);
@@ -1382,7 +1383,7 @@ template {
   border: 0;
 }
 
-.rdp-foot {
+.rdp-tfoot {
   margin: 0.5em;
 }
 
@@ -1417,15 +1418,15 @@ template {
   font-weight: bold;
 }
 
-.rdp-day_selected:not([disabled]),
-.rdp-day_selected:focus:not([disabled]),
-.rdp-day_selected:active:not([disabled]),
-.rdp-day_selected:hover:not([disabled]) {
+.rdp-day_selected:not([aria-disabled='true']),
+.rdp-day_selected:focus:not([aria-disabled='true']),
+.rdp-day_selected:active:not([aria-disabled='true']),
+.rdp-day_selected:hover:not([aria-disabled='true']) {
   color: white;
   background-color: var(--rdp-accent-color);
 }
 
-.rdp-day_selected:focus:not([disabled]) {
+.rdp-day_selected:focus:not([aria-disabled='true']) {
   border: var(--rdp-outline-selected);
 }
 
@@ -2451,6 +2452,11 @@ template {
   --ab-cmp-progress-indicator__background: var(--ab-color-primary);
   --ab-cmp-progress-indicator__color: var(--ab-color-text-on-primary); }
 
+:root {
+  --ab-cmp-icon__fill: var(--ab-icon-fill);
+  --ab-cmp-icon__height: 17px;
+  --ab-cmp-icon__width: 17px; }
+
 :root {
   --ab-cmp-wizard__padding: var(--ab-space-5);
   --ab-cmp-wizard__margin: var(--ab-space-1);
@@ -4107,6 +4113,29 @@ button.ab-StatusBar__SubPanel:hover {
   background-color: var(--ab-cmp-adaptable-statusbar-sub-panel-icon__background-color-hover);
   cursor: pointer; }
 
+.ab-StatusBar {
+  display: flex;
+  border-right: var(--ab-cmp-adaptable-statusbar__border);
+  border-left: var(--ab-cmp-adaptable-statusbar__border); }
+
+.ab-StatusBar__SubPanel {
+  padding: var(--ab-cmp-adaptable-statusbar-sub-panel__padding);
+  border: 0;
+  background: none;
+  font-weight: 400;
+  border-right: var(--ab-cmp-adaptable-statusbar__border); }
+
+.ab-StatusBar__SubPanel:last-child {
+    border-right: 0; }
+
+.ab-StatusBar__SubPanel,
+  .ab-StatusBar__SubPanel .ab-SimpleButton {
+    color: var(--ab-cmp-adaptable-statusbar__color); }
+
+button.ab-StatusBar__SubPanel:hover {
+  background-color: var(--ab-cmp-adaptable-statusbar-sub-panel-icon__background-color-hover);
+  cursor: pointer; }
+
 .ab-alert--error {
   background: var(--ab-color-error); }
 
@@ -4160,6 +4189,12 @@ button.ab-StatusBar__SubPanel:hover {
 .ab-ActionColumn > button.ab-SimpleButton {
     height: 100%; }
 
+.adaptableRowActionButtons.ag-cell {
+  padding: 0; }
+
+.adaptableRowActionButtons.ag-cell .ab-ActionColumn {
+    column-gap: 0; }
+
 .Toastify__toast-container {
   border-style: none;
   border-width: 0px; }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "12.0.0-canary.2",
+  "version": "12.0.0-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",
   "keywords": [
     "web-components",
@@ -31,7 +31,7 @@
   "main": "agGrid.js",
   "typings": "types.d.ts",
   "dependencies": {
-    "@infinite-table/infinite-react": "0.3.10",
+    "@infinite-table/infinite-react": "0.3.12",
     "date-fns": "2.22.1",
     "debug": "^4.3.1",
     "isomorphic-fetch": "^2.2.1",
@@ -41,7 +41,7 @@
     "re-resizable": "^6.9.1",
     "react": "^16.8.0 || ^17.0.0",
     "react-beautiful-dnd": "13.1.0",
-    "react-day-picker": "8.0.0-beta.38",
+    "react-day-picker": "8.0.6",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react-redux": "7.2.4",
     "react-remove-scroll": "2.4.2",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1654688737709;
+declare const _default: 1655288118527;
 export default _default;

package/publishTimestamp.js

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

package/src/AdaptableOptions/ActionOptions.d.ts

@@ -1 +1,181 @@
-export {};
+import { RowNode } from '@ag-grid-community/all-modules';
+import { ActionRowSubmittedInfo, ActionRowType, AdaptableButton, AdaptableColumn, AdaptableObject, BaseContext, FormContext } from '../types';
+/**
+ * Options related to Action Columns and Buttons in Adaptable.
+ */
+export interface ActionOptions {
+    /**
+     * Columns which contain an AdapTable Button - used for performing Actions
+     */
+    actionColumns?: ActionColumn[];
+    /**
+     * Action buttons to display for each row.
+     *
+     * @defaultValue undefined
+     */
+    actionRowButtons?: ('clone' | 'create' | 'edit' | 'delete')[];
+    /**
+     * Position of supplied Action Buttons
+     *
+     * @defaultValue 'pinnedLeft'
+     */
+    actionRowButtonsPosition?: 'pinnedLeft' | 'pinnedRight';
+    /**
+     * If set to true, the Action Row Buttons will be handled by AdapTable and the grid data model will be automatically updated with the created/edited/deleted rows
+     *
+     * @defaultValue false
+     */
+    autoHandleActionRowButtons?: boolean;
+    /**
+     * Function which is called when auto-handling the 'create' Action Row Button. The returned row value should have a valid(unique) primary key value.
+     *
+     * @defaultValue undefined
+     */
+    setPrimaryKeyValue?: (context: SetPrimaryKeyValueContext) => any;
+    /**
+     * Options for managing the Form which the Action Row displays
+     */
+    actionRowFormOptions?: ActionRowFormOptions;
+}
+/**
+ * The context for the SetPrimaryKeyValueContext function
+ */
+export interface SetPrimaryKeyValueContext extends BaseContext {
+    rowData: any;
+}
+/**
+ * A Special Column that wraps an AdapTable Button
+ */
+export interface ActionColumn extends AdaptableObject {
+    /**
+     * Mandatory 'Id'; if no value set for `FriendlyName`, this will also be Column name
+     */
+    columnId: string;
+    /**
+     * How Column appears in Column Header, Menus; if no value set, `ColumnId` is used
+     */
+    friendlyName?: string;
+    /**
+     * Button (or list of buttons) to display in the Column
+     */
+    actionColumnButton: AdaptableButton<ActionColumnContext> | AdaptableButton<ActionColumnContext>[];
+    /**
+     * Shows Action Column also in grouped rows
+     */
+    includeGroupedRows?: boolean;
+    /**
+     * Additional optional properties for Column (e.g. filterable, resizable)
+     */
+    actionColumnSettings?: ActionColumnSettings;
+}
+/**
+ * Context required by functions when using an Action Column Button
+ */
+export interface ActionColumnContext extends BaseContext {
+    /**
+     * Action Column in question
+     */
+    actionColumn: ActionColumn;
+    /**
+     * Primary Key Value in current row
+     */
+    primaryKeyValue: any;
+    /**
+     * Current AG Grid Row Node
+     */
+    rowNode: RowNode;
+}
+/**
+ * Set of optional properties that define an Action Columns behaviour
+ */
+export interface ActionColumnSettings {
+    /**
+     * Preferred width (in pixels) for Column; if unset, calculated dynamically by AG Grid
+     */
+    width?: number;
+    /**
+     * Whether Column can be resized (by dragging column header edges)
+     * @defaultValue true
+     */
+    resizable?: boolean;
+    /**
+     * Whether no menu should be shown for this Column header.
+     * @defaultValue false
+     */
+    suppressMenu?: boolean;
+    /**
+     * Whether if this Column should be movable via dragging
+     * @defaultValue false
+     */
+    suppressMovable?: boolean;
+}
+/**
+ * Options for editing (create/update/delete) row entries in the grid
+ */
+export interface ActionRowFormOptions {
+    /**
+     * Custom form title provider
+     * @defaultValue 'Create New Row'/'Edit Row'
+     */
+    formTitle?: string | ((context: ActionRowParamContext) => string);
+    /**
+     * Custom form description provider
+     * @defaultValue undefined
+     */
+    formDescription?: string | ((context: ActionRowParamContext) => string);
+    /**
+     * Custom form field label provider
+     * @defaultValue undefined
+     */
+    formFieldLabel?: (context: FormFieldLabelContext) => string;
+    /**
+     * Custom form buttons provider. If provided, the custom implementation is responsible for firing the 'ActionRowSubmitted' and/or invoking the 'onFormSubmit' callback (if necessary).
+     */
+    formButtons?: AdaptableButton<FormContext>[];
+    /**
+     * Function which is invoked when the form in an Action Row is submitted via a standard button (provided by AdapTable). This is not invoked when custom form buttons are provided!
+     *
+     * @param actionRowSubmittedInfo the form submitted info
+     * @defaultValue undefined
+     */
+    onFormSubmit?: (actionRowSubmittedInfo: ActionRowSubmittedInfo) => void;
+}
+/**
+ * Context passed into a Row Form - can be `CreateActionRowContext` or `EditActionRowContext`
+ */
+export declare type ActionRowContext = CreateActionRowContext | EditActionRowContext;
+/**
+ * Context used in a Create Row Form
+ */
+export interface CreateActionRowContext extends FormContext {
+    /**
+     * Type of the Context
+     */
+    type: Extract<ActionRowType, 'rowCreated'>;
+    /**
+     * The RowNode being cloned
+     */
+    clonedRowNode?: RowNode;
+}
+/**
+ * Context used in an Edit Row Form
+ */
+export interface EditActionRowContext extends FormContext {
+    /**
+     * Type of the Context
+     */
+    type: Extract<ActionRowType, 'rowEdited'>;
+    /**
+     * The RowNode being edited
+     */
+    rowNode: RowNode;
+}
+export interface ActionRowParamContext extends BaseContext {
+    type: Extract<ActionRowType, 'rowEdited' | 'rowCreated'>;
+    rowNode?: RowNode;
+}
+export interface FormFieldLabelContext extends BaseContext {
+    type: Extract<ActionRowType, 'rowEdited' | 'rowCreated'>;
+    column: AdaptableColumn;
+    rowNode?: RowNode;
+}

package/src/AdaptableOptions/AdaptableOptions.d.ts

@@ -22,6 +22,7 @@ import { FlashingCellOptions } from './FlashingCellOptions';
 import { AlertOptions } from './AlertOptions';
 import { AdaptableQLOptions } from './AdaptableQLOptions';
 import { ColumnOptions } from './ColumnOptions';
+import { ActionOptions } from './ActionOptions';
 /**
  * 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
  */
@@ -81,6 +82,10 @@ export interface AdaptableOptions {
      * @gridInfoItem
      */
     userName?: string;
+    /**
+     * Options for managing Action Columns and Action Rows
+     */
+    actionOptions?: ActionOptions;
     /**
      * Options for managing AdapTableQL
      */

package/src/AdaptableOptions/AlertOptions.d.ts

@@ -1,7 +1,7 @@
-import { BaseContext } from '../../types';
+import { FormContext } from '../../types';
 import { AlertButton, AlertDefinition } from '../PredefinedConfig/AlertState';
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
-import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
+import { AdaptableForm } from '../PredefinedConfig/Common/AdaptableForm';
 import { CellDataChangedInfo } from '../types';
 /**
  * Options related to Alerts in Adaptable.
@@ -65,7 +65,7 @@ export declare type ActionHandler = {
     /**
      * Handler function to call when the Button is clicked
      */
-    handler: (button: AlertButton<AlertButtonContext>, context: AlertButtonContext) => void;
+    handler: (button: AlertButton<AlertFormContext>, context: AlertFormContext) => void;
 };
 /**
  * Form to show in an Alert
@@ -78,20 +78,16 @@ export declare type AlertForm = {
     /**
      * The Form to display in the Alert
      */
-    form: AdaptableForm<AlertButtonContext>;
+    form: AdaptableForm<AlertFormContext>;
 };
 /**
  * Context required by functions when using an Alert Button
  */
-export interface AlertButtonContext extends BaseContext {
+export interface AlertFormContext extends FormContext {
     /**
      * Alert that has been triggered
      */
     alert: AdaptableAlert;
-    /**
-     * Data in the Alert Form
-     */
-    formData?: AdaptableFormData;
 }
 /**
  * Context used for creating bespoke Alert messages

package/src/AdaptableOptions/ColumnOptions.d.ts

@@ -5,10 +5,14 @@ import { Column } from '@ag-grid-community/all-modules';
 export interface ColumnOptions {
     /**
      * Provide an alternative Friendly Name for a Column
+     *
+     * @defaultValue  undefined
      */
     columnFriendlyName?: (columnFriendlyNameContext: ColumnFriendlyNameContext) => string | undefined;
     /**
      * Optional list of Column Types - used primarily for Special Columns
+     *
+     * @defaultValue  []
      */
     columnTypes?: string[];
     /**

package/src/AdaptableOptions/DashboardOptions.d.ts

@@ -80,13 +80,9 @@ export interface DashboardButtonContext extends BaseContext {
 /**
  * Context required by functions when using a Custom Toolbar Button
  */
-export interface CustomToolbarButtonContext extends BaseContext {
+export interface CustomToolbarButtonContext extends DashboardButtonContext {
     /**
      * Custom Toolbar which hosts the Button
      */
     customToolbar: CustomToolbar;
-    /**
-     * Current Dashboard State
-     */
-    dashboardState: DashboardState;
 }

package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts

@@ -1,7 +1,13 @@
 import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
-import { ActionColumnButtonContext, AdaptableButton } from '../types';
+import { ActionColumnContext, AdaptableButton } from '../types';
+/**
+ * Built in `undo` data change action
+ */
 export declare type AdaptableDataChangeHistoryAction = 'undo';
-export interface DataChangeHistoryContext extends ActionColumnButtonContext {
+/**
+ * The context for the DataChangeHistoryButton
+ */
+export interface DataChangeHistoryContext extends ActionColumnContext {
     /**
      * Helper function to undo the change.
      */
@@ -10,9 +16,16 @@ export interface DataChangeHistoryContext extends ActionColumnButtonContext {
      * If the change references a group node.
      */
     isGroupNode: boolean;
+    /**
+     * The initial data change
+     */
+    dataChangedInfo: CellDataChangedInfo;
 }
+/**
+ * A custom AdaptableButton which provides a build in `undo` action
+ */
 export interface DataChangeHistoryButton extends AdaptableButton<DataChangeHistoryContext> {
-    Action?: AdaptableDataChangeHistoryAction;
+    action?: AdaptableDataChangeHistoryAction;
 }
 /**
  * Options to manage the 'Data Change History Module', which provides an overview of all previous changes, giving the possibility to undo specific changes
@@ -34,6 +47,8 @@ export interface DataChangeHistoryOptions {
     showDataChange?: (cellDataChangedInfo: CellDataChangedInfo) => boolean;
     /**
      * Action button definition. Can be used to implement undo functionality.
+     *
+     * @defaultValue undefined
      */
-    actionColumnButton?: DataChangeHistoryButton | DataChangeHistoryButton[];
+    changeHistoryButton?: DataChangeHistoryButton | DataChangeHistoryButton[];
 }

package/src/AdaptableOptions/EditOptions.d.ts

@@ -1,17 +1,15 @@
-import { RowNode } from '@ag-grid-community/all-modules';
-import { AdaptableButton, AdaptableColumn, BaseContext, RowFormSubmittedInfo, RowFormType } from '../../types';
-import { FormContext } from '../PredefinedConfig/Common/FormContext';
+import { BaseContext } from '../../types';
 import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
 import { MathOperation } from '../PredefinedConfig/Common/Enums';
 import { GridCell } from '../PredefinedConfig/Selection/GridCell';
 /**
- * Options related to Editing in Adaptable.
- *
- * Allows users to provide Adaptable with Server Validation that works in conjunction with Client (aka Cell) Validation
+ * Options related to Editing in Adaptable - includes Server Validation, Smart Edit Operations and Row Forms
  */
 export interface EditOptions {
     /**
      * Function to validate on Server Adaptable data edits
+     *
+     * @defaultValue undefined
      */
     validateOnServer?: (cellDataChangedInfo: CellDataChangedInfo) => Promise<ValidationResult>;
     /**
@@ -23,16 +21,16 @@ export interface EditOptions {
     displayServerValidationMessages?: boolean;
     /**
      * Function which checks if given Grid Cell is editable
+     *
+     * @defaultValue undefined
      */
     isCellEditable?: (gridCell: GridCell) => boolean;
     /**
      * Custom Operations to use in Smart Edit
+     *
+     * @defaultValue undefined
      */
     smartEditCustomOperations?: SmartEditCustomOperation[];
-    /**
-     * Options for editing (create/update/delete) row entries in the grid.
-     */
-    rowFormOptions?: RowFormOptions;
 }
 /**
  * Used for Server Validation ie. after an edit has been made in Adaptable which should be checked on the Server
@@ -74,55 +72,3 @@ export interface SmartEditOperationContext extends BaseContext {
      */
     currentCell: GridCell;
 }
-/**
- * Options for editing (create/update/delete) row entries in the grid
- */
-export interface RowFormOptions {
-    /**
-     * Custom form title provider
-     *
-     * @defaultValue 'Create New Row'/'Edit Row'
-     */
-    formTitle?: string | ((context: FormParamContext) => string);
-    /**
-     * Custom form description provider
-     *
-     * @defaultValue undefined
-     */
-    formDescription?: string | ((context: FormParamContext) => string);
-    /**
-     * Custom form field label provider
-     *
-     * @defaultValue undefined
-     */
-    formFieldLabel?: (context: FormFieldLabelContext) => string;
-    /**
-     * Custom form buttons provider. If provided, the custom implementation is responsible for firing the 'RowFormSubmitted' and/or invoking the 'onFormSubmit' callback (if necessary).
-     */
-    formButtons?: AdaptableButton<RowFormContext>[];
-    /**
-     * Function which is invoked when a row form is submitted via a standard button (provided by AdapTable). This is not invoked when custom form buttons are provided!
-     *
-     * @param rowFormSubmittedInfo the form submitted info
-     * @defaultValue undefined
-     */
-    onFormSubmit?: (rowFormSubmittedInfo: RowFormSubmittedInfo) => void;
-}
-export declare type RowFormContext = CreateRowFormContext | EditRowFormContext;
-export interface CreateRowFormContext extends FormContext {
-    type: Extract<RowFormType, 'rowCreated'>;
-    clonedRowNode?: RowNode;
-}
-export interface EditRowFormContext extends FormContext {
-    type: Extract<RowFormType, 'rowEdited'>;
-    rowNode: RowNode;
-}
-export interface FormParamContext extends BaseContext {
-    type: Extract<RowFormType, 'rowEdited' | 'rowCreated'>;
-    rowNode?: RowNode;
-}
-export interface FormFieldLabelContext extends BaseContext {
-    type: Extract<RowFormType, 'rowEdited' | 'rowCreated'>;
-    column: AdaptableColumn;
-    rowNode?: RowNode;
-}

package/src/AdaptableOptions/FinancePluginOptions.d.ts

@@ -1,4 +1,4 @@
-import { ContextMenuContext, GridCell } from '../../types';
+import { AdaptableIcon, ContextMenuContext, GridCell } from '../../types';
 import { CustomFDC3Context } from '../PredefinedConfig/Common/FDC3Context';
 /**
  * Options required for when using the Finance plugin
@@ -84,9 +84,9 @@ export interface FDC3Column {
      */
     intentContextMenuLabel?: string | ((raiseFDC3IntentContext: RaiseFDC3IntentContext) => string);
     /**
-     * Returns the icon to display in the Raise Intent Context Menu Item
+     * Returns a custom icon to display in the Raise Intent Context Menu Item;
      */
-    getIconForIntent?: (intent: FDC3Intent | CustomFDC3Intent) => any;
+    getIconForIntent?: (intent: FDC3Intent | CustomFDC3Intent) => AdaptableIcon;
 }
 /**
  * A Column which will be defined as an FDC3 Instrument

package/src/AdaptableOptions/GeneralOptions.d.ts

@@ -91,5 +91,12 @@ export interface DataSet extends AdaptableObject {
      */
     form?: AdaptableForm<DataSetFormContext>;
 }
+/**
+ * Used when a DataSet displays a Form
+ */
 export interface DataSetFormContext extends FormContext {
+    /**
+     * The DataSet which triggered the Form
+     */
+    dataSet: DataSet;
 }

package/src/AdaptableOptions/LayoutOptions.d.ts

@@ -68,15 +68,20 @@ export interface LayoutOptions {
 export interface LayoutTagOptions {
     /**
      * Automatically generate an Object Tag for each Layout
+     *
+     * @defaultValue false
      */
     autoGenerateTagsForLayouts?: boolean | ((context: AutoGenerateTagsForLayoutsContext) => AdaptableObjectTag[]);
     /**
      * Checks if the provided Adaptable Object is available in the given Layout
+     *
+     * @defaultValue undefined
      */
     isObjectAvailableInLayout?: (context: LayoutAvailableContext) => boolean;
     /**
      * Automatically checks if Adaptable Objects Tags are available in current Layout
-     *  @defaultValue false
+     *
+     * @defaultValue false
      */
     autoCheckTagsForLayouts?: boolean;
 }

package/src/AdaptableOptions/SettingsPanelOptions.d.ts

@@ -29,6 +29,8 @@ export interface SettingsPanelOptions {
     alwaysShowInToolPanel?: boolean;
     /**
      * Ordered items to display at side of Settings Panel
+     *
+     * @defaultValue all available AdapTable modules
      */
     navigation?: {
         items?: (AdaptableSettingsPanel | string | '-')[];

package/src/AdaptableOptions/StateOptions.d.ts

@@ -5,22 +5,32 @@ import { AdaptableState } from '../PredefinedConfig/AdaptableState';
 export interface StateOptions {
     /**
      * Allows the customization of state persistence
+     *
+     * @defaultValue persists state to local storage
      */
     persistState?: AdaptablePersistStateFunction;
     /**
      * Allows the customization of Adaptable State loading
+     *
+     * @defaultValue loads state from local storage
      */
     loadState?: AdaptableLoadStateFunction;
     /**
      * Allows the customization of the Adaptable State that is going to be persisted
+     *
+     * @defaultValue undefined
      */
     saveState?: AdaptableSaveStateFunction;
     /**
      * Allows hooking into Adaptable State hydration
+     *
+     * @defaultValue undefined
      */
     applyState?: (state: any) => any;
     /**
      * Allows clearing of remote Adaptable State
+     *
+     * @defaultValue undefined
      */
     clearState?: AdaptableClearStateFunction;
     /**