@adaptabletools/adaptable 23.0.0-canary.6 → 23.0.0-canary.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "23.0.0-canary.6",
+  "version": "23.0.0-canary.8",
   "description": "Powerful AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/src/AdaptableOptions/DataSetOptions.d.ts

@@ -1,5 +1,6 @@
 import { AdaptableForm, AdaptableObject } from '../../types';
 import { FormContext } from '../AdaptableState/Common/FormContext';
+import { DataSetSelectedInfo } from '../Api/Events/DataSetSelected';
 /**
  * Options to provide Data Sets
  */
@@ -9,12 +10,12 @@ export interface DataSetOptions<TData = any> {
      *
      * @defaultValue []
      */
-    dataSets?: DataSet[];
+    dataSets?: DataSet<TData>[];
 }
 /**
  * Defines a Data Set object that can provide data to AdapTable
  */
-export interface DataSet extends AdaptableObject {
+export interface DataSet<TData = any> extends AdaptableObject {
     /**
      * Name of Data Set
      */
@@ -31,6 +32,29 @@ export interface DataSet extends AdaptableObject {
      * Additional info for Data Set
      */
     info?: Record<string, string | number | boolean | Date>;
+    /**
+     * Invoked when this Data Set is selected and it does not define a `form`.
+     *
+     * Use for custom loading logic (e.g. server requests). The `DataSetSelected`
+     * event is still fired for backward compatibility.
+     *
+     * @defaultValue undefined
+     */
+    onSelect?: (info: DataSetSelectedInfo) => void | Promise<void>;
+    /**
+     * Optional shortcut that loads row data into the Grid when this Data Set is
+     * selected (only when no `form` is defined). Runs before `onSelect`.
+     *
+     * @defaultValue undefined
+     */
+    loadData?: (info: DataSetSelectedInfo) => TData[] | Promise<TData[]>;
+    /**
+     * Invoked when the user submits the Data Set form (Enter key or form button).
+     * When no form `buttons` are defined, an OK button is added automatically.
+     *
+     * @defaultValue undefined
+     */
+    onFormSubmit?: (context: DataSetFormContext) => void | Promise<void>;
 }
 /**
  * Used when a DataSet displays a Form

package/src/AdaptableOptions/DefaultAdaptableOptions.js

@@ -268,7 +268,6 @@ const DefaultAdaptableOptions = {
         popupType: 'modal',
         title: ModuleConstants.SettingsPanelFriendlyName,
         icon: 'ConfigurationIcon',
-        navigation: {},
         alwaysShowInDashboard: false,
         alwaysShowInToolPanel: false,
         showModuleIcons: true,

package/src/AdaptableOptions/SettingsPanelOptions.d.ts

@@ -1,5 +1,6 @@
 import { AdaptableFrameworkComponent, AdaptableIcon } from '../../types';
 import { AdaptableSettingsPanel } from '../AdaptableState/Common/Types';
+import { BaseContext } from '../AdaptableState/Common/BaseContext';
 import { CustomRenderContext } from '../agGrid/AdaptableFrameworkComponent';
 /**
  * Options for managing the AdapTable Settings Panel
@@ -34,13 +35,15 @@ export interface SettingsPanelOptions {
      */
     alwaysShowInToolPanel?: boolean;
     /**
-     * Ordered items to display at side of Settings Panel
+     * Configure grouped navigation for the Settings Panel.
      *
-     * @defaultValue all available AdapTable modules
+     * Receives the default grouped navigation and AdapTable context; return an amended copy.
+     * Groups with no visible modules (e.g. due to entitlements) are omitted automatically.
+     * Group headings are omitted when every module in the group is hidden.
+     *
+     * @defaultValue all available AdapTable modules in the default grouped order
      */
-    navigation?: {
-        items?: (AdaptableSettingsPanel | string | '-')[];
-    };
+    navigation?: SettingsPanelNavigationConfigurer;
     /**
      * Initial position of Settings Panel window
      *
@@ -70,18 +73,47 @@ export interface SettingsPanelOptions {
      */
     customSettingsPanels?: CustomSettingsPanel[];
     /**
-   * Which Tabs can be used to display Grid Info: 'Grid Options', 'Grid Summary' or 'Grid State'
-   *
-   * @defaultValue ['Grid Options', 'Grid Summary', 'Grid State']
-   */
+     * Which Tabs can be used to display Grid Info: 'Grid Options', 'Grid Summary' or 'Grid State'
+     *
+     * @defaultValue ['Grid Options', 'Grid Summary', 'Grid State']
+     */
     gridInfoTabs?: GridInfoTabs;
 }
+/**
+ * A labelled group of Settings Panel navigation entries.
+ */
+export interface SettingsPanelNavigationGroup {
+    /**
+     * Section heading shown above the group. Use an empty string to show items without a heading.
+     */
+    label: string;
+    /**
+     * Module names or custom panel names in display order.
+     */
+    items: (AdaptableSettingsPanel | string)[];
+}
+/**
+ * Grouped Settings Panel navigation structure.
+ */
+export interface SettingsPanelNavigation {
+    groups: SettingsPanelNavigationGroup[];
+}
+/**
+ * Context passed to `SettingsPanelOptions.navigation`.
+ */
+export interface SettingsPanelNavigationContext extends BaseContext {
+}
+/**
+ * Function used to customise Settings Panel navigation.
+ */
+export type SettingsPanelNavigationConfigurer = (context: SettingsPanelNavigationContext, defaultNavigation: SettingsPanelNavigation) => SettingsPanelNavigation;
 /**
  * Definition of a Custom Panel to add to the Adaptable Settings Panel
  */
 export interface CustomSettingsPanel {
     /**
-     * Appears in Settings Panel Navigation and must be included in settingsPanelOptions.navigation for it to be displayed (by default added to the end)
+     * Appears in Settings Panel Navigation. Include in `navigation` to choose placement
+     * (by default added to a `Custom Panels` group at the end).
      */
     name: string;
     /**

package/src/AdaptableState/Common/AdaptableFormat.d.ts

@@ -50,6 +50,13 @@ export interface NumberFormatterOptions extends BaseFormatterOptions {
      * Multiplier to use on cell value
      */
     Multiplier?: number;
+    /**
+     * When the numeric value is zero (after multiplier and rounding):
+     * - omitted / undefined, or `'0'` — use normal formatting (e.g. `0`, `0.00`)
+     * - `''` — show a blank cell (user cleared the default `0` in the wizard)
+     * - any other string — show that text (e.g. `-`, `—`)
+     */
+    ZeroDisplay?: string;
     /**
      * Shows negative numbers in parentheses
      */

package/src/AdaptableState/Common/AdaptableMessageType.d.ts

@@ -15,6 +15,6 @@ export type AdaptableMessageType =
  */
  | 'Warning'
 /**
- * Error Message - displays '-ab-color-error' variable (defaults to red)
+ * Error Message - displays '-ab-color-destructive' variable (defaults to red)
  */
  | 'Error';

package/src/AdaptableState/Common/Enums.d.ts

@@ -31,7 +31,7 @@ export declare enum FontSize {
     XLarge = "XLarge"
 }
 export declare enum StatusColour {
-    Error = "var(--ab-color-error)",
+    Error = "var(--ab-color-destructive)",
     Warn = "var(--ab-color-warn)",
     Success = "var(--ab-color-success)",
     Info = "var(--ab-color-info)"

package/src/AdaptableState/Common/Enums.js

@@ -42,7 +42,7 @@ export var FontSize;
 })(FontSize || (FontSize = {}));
 export var StatusColour;
 (function (StatusColour) {
-    StatusColour["Error"] = "var(--ab-color-error)";
+    StatusColour["Error"] = "var(--ab-color-destructive)";
     StatusColour["Warn"] = "var(--ab-color-warn)";
     StatusColour["Success"] = "var(--ab-color-success)";
     StatusColour["Info"] = "var(--ab-color-info)";