@adaptabletools/adaptable 15.3.3-canary.1 → 15.3.4

package/package.json

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

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1686303797057;
+declare const _default: 1686481266992;
 export default _default;

package/publishTimestamp.js

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

package/src/AdaptableOptions/ActionOptions.d.ts

@@ -104,7 +104,7 @@ export interface ActionRowButtonOptions<TData = any> {
      * Optional configuration that merges with built-in action row button and overrides default configuration
      * @defaultValue undefined
      */
-    customConfiguration?: (context: ActionRowButtonConfigurationContext) => Partial<AdaptableButton<ActionColumnContext<TData>>>;
+    customConfiguration?: (context: ActionRowButtonConfigurationContext) => Partial<AdaptableButton<ActionColumnContext<TData>>> | undefined;
     /**
      * Action Row Buttons position: 'pinnedLeft' | 'pinnedRight
      * @defaultValue 'pinnedLeft'
@@ -126,9 +126,9 @@ export interface ActionRowButtonOptions<TData = any> {
      */
     actionRowFormOptions?: ActionRowFormOptions<TData>;
     /**
-   * Prevents direct editing in Grid cells even for editable columns
-   * @defaultValue false
-   */
+     * Prevents direct editing in Grid cells even for editable columns
+     * @defaultValue false
+     */
     disableInlineEditing?: boolean;
 }
 /**

package/src/AdaptableOptions/PredicateOptions.d.ts

@@ -1,4 +1,4 @@
-import { AdaptablePredicateDef, AdaptableScope, BaseContext, PredicateModuleScope, SystemAlertPredicateIds, SystemFilterPredicateIds, SystemFlashingCellPredicateIds, SystemFormatColumnPredicateIds } from '../types';
+import { AdaptablePredicateDef, AdaptableScope, BaseContext, PredicateModuleScope, SystemAlertPredicateIds, SystemBadgeStylePredicateIds, SystemFilterPredicateIds, SystemFlashingCellPredicateIds, SystemFormatColumnPredicateIds } from '../types';
 /**
  * Options for managing Adaptable Predicates using AdaptableQL
  */
@@ -7,6 +7,10 @@ export interface PredicateOptions {
      * Which System Filter Predicates are available
      */
     systemFilterPredicates?: SystemFilterPredicateIds | ((context: SystemPredicatesContext) => SystemFilterPredicateIds);
+    /**
+   * Which System Badge Style Predicates are available
+   */
+    systemBadgeStylePredicates?: SystemBadgeStylePredicateIds | ((context: SystemPredicatesContext) => SystemBadgeStylePredicateIds);
     /**
      * Which System Alert Predicates are available
      */

package/src/Api/Implementation/StyledColumnApiImpl.d.ts

@@ -32,5 +32,4 @@ export declare class StyledColumnApiImpl extends ApiBase implements StyledColumn
     suspendStyledColumn(styledColumn: StyledColumn): void;
     unSuspendStyledColumn(styledColumn: StyledColumn): void;
     openStyledColumnSettingsPanel(): void;
-    getBadgePredicateDefsForColumn(columnId: string): import("../../types").AdaptablePredicateDef[];
 }

package/src/Api/Implementation/StyledColumnApiImpl.js

@@ -111,17 +111,5 @@ class StyledColumnApiImpl extends ApiBase_1.ApiBase {
     openStyledColumnSettingsPanel() {
         this.showModulePopup(ModuleConstants.StyledColumnModuleId);
     }
-    getBadgePredicateDefsForColumn(columnId) {
-        const column = this.getAdaptableApi().columnApi.getColumnWithColumnId(columnId);
-        if (!column) {
-            return undefined;
-        }
-        const scope = {
-            ColumnIds: [column.columnId],
-        };
-        return this.getAdaptableApi()
-            .predicateApi.internalApi.getFilterPredicateDefs(scope)
-            .filter((predicate) => this.adaptable.api.scopeApi.isColumnInScope(column, predicate.columnScope));
-    }
 }
 exports.StyledColumnApiImpl = StyledColumnApiImpl;

package/src/Api/Internal/PredicateInternalApi.d.ts

@@ -20,6 +20,7 @@ export declare class PredicateInternalApi extends ApiBase {
      */
     getAlertPredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
     private getSystemAlertPredicateIds;
+    private getSystemBadgeStylePredicateIds;
     /**
      * Get all Format Column Predicate Definitions - System and Custom
      */
@@ -35,4 +36,8 @@ export declare class PredicateInternalApi extends ApiBase {
      * @param dataType DataType of Column
      */
     getEqualityPredicateForDataType(dataType: AdaptableColumnDataType): SystemFilterPredicateId;
+    /**
+     * Get all Badge Style Predicate Definitions - System and Custom
+     */
+    getBadgeStylePredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
 }

package/src/Api/Internal/PredicateInternalApi.js

@@ -30,7 +30,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
                     .getSystemPredicateDefs()
                     .filter((p) => p.moduleScope.includes('filter')),
                 moduleScope: 'filter',
-                columnScope: scope
+                columnScope: scope,
             };
             return systemFilterPredicates(systemPredicateContext);
         }
@@ -55,12 +55,27 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
                     .getSystemPredicateDefs()
                     .filter((p) => p.moduleScope.includes('alert')),
                 moduleScope: 'alert',
-                columnScope: scope
+                columnScope: scope,
             };
             return systemAlertPredicates(systemPredicateContext);
         }
         return systemAlertPredicates;
     }
+    getSystemBadgeStylePredicateIds(scope) {
+        const systemBadgeStylePredicates = this.getAdaptableQLOptions().predicateOptions.systemBadgeStylePredicates;
+        if (typeof systemBadgeStylePredicates === 'function') {
+            const systemPredicateContext = {
+                adaptableApi: this.adaptable.api,
+                systemPredicateDefs: this.getPredicateApi()
+                    .getSystemPredicateDefs()
+                    .filter((p) => p.moduleScope.includes('badgeStyle')),
+                moduleScope: 'badgeStyle',
+                columnScope: scope,
+            };
+            return systemBadgeStylePredicates(systemPredicateContext);
+        }
+        return systemBadgeStylePredicates;
+    }
     /**
      * Get all Format Column Predicate Definitions - System and Custom
      */
@@ -80,7 +95,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
                     .getSystemPredicateDefs()
                     .filter((p) => p.moduleScope.includes('formatColumn')),
                 moduleScope: 'formatColumn',
-                columnScope: scope
+                columnScope: scope,
             };
             return systemFormatColumnPredicates(systemPredicateContext);
         }
@@ -105,7 +120,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
                     .getSystemPredicateDefs()
                     .filter((p) => p.moduleScope.includes('flashingcell')),
                 moduleScope: 'flashingcell',
-                columnScope: scope
+                columnScope: scope,
             };
             return systemFlashingCellPredicates(systemPredicateContext);
         }
@@ -133,5 +148,15 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
         }
         return predicateId;
     }
+    /**
+     * Get all Badge Style Predicate Definitions - System and Custom
+     */
+    getBadgeStylePredicateDefs(scope) {
+        var _a;
+        return [
+            ...(_a = this.getSystemBadgeStylePredicateIds(scope)) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)),
+            ...this.getPredicateApi().getCustomPredicateDefs(),
+        ].filter((predicateDef) => predicateDef.moduleScope.includes('badgeStyle'));
+    }
 }
 exports.PredicateInternalApi = PredicateInternalApi;

package/src/Api/Internal/StyledColumnInternalApi.d.ts

@@ -58,4 +58,5 @@ export declare class StyledColumnInternalApi extends ApiBase {
      */
     hasStyledColumnRelativeCellRange(styledColumn: StyledColumn): boolean;
     getApplicableBadge(styledColumn: StyledColumn, params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>): BadgeStyleDefinition | null;
+    getBadgePredicateDefsForColumn(columnId: string): import("../../types").AdaptablePredicateDef[];
 }

package/src/Api/Internal/StyledColumnInternalApi.js

@@ -269,5 +269,17 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
         const [firstBadgeWithAll] = badgesWithAll;
         return firstBadgeWithAll !== null && firstBadgeWithAll !== void 0 ? firstBadgeWithAll : null;
     }
+    getBadgePredicateDefsForColumn(columnId) {
+        const column = this.getAdaptableApi().columnApi.getColumnWithColumnId(columnId);
+        if (!column) {
+            return undefined;
+        }
+        const scope = {
+            ColumnIds: [column.columnId],
+        };
+        return this.getAdaptableApi()
+            .predicateApi.internalApi.getBadgeStylePredicateDefs(scope)
+            .filter((predicate) => this.adaptable.api.scopeApi.isColumnInScope(column, predicate.columnScope));
+    }
 }
 exports.StyledColumnInternalApi = StyledColumnInternalApi;

package/src/Api/StyledColumnApi.d.ts

@@ -1,6 +1,5 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { StyledColumn, StyledColumnState } from '../PredefinedConfig/StyledColumnState';
-import { AdaptablePredicateDef } from '../types';
 /**
  * Provides run-time access to Styled Column Module and associated state
  */
@@ -118,11 +117,7 @@ export interface StyledColumnApi {
      */
     getAllSuspendedStyledColumn(): StyledColumn[];
     /**
-     * If this AdapTable instance can display Sparklines (e.g. is AG Grid SparklinesModule installed)
+     * Can this AdapTable instance display Sparklines (e.g. is AG Grid SparklinesModule installed)
      */
     canDisplaySparklines(): boolean;
-    /**
-     * Get all Predicates available for a given column
-     */
-    getBadgePredicateDefsForColumn(columnId: string): AdaptablePredicateDef[];
 }

package/src/PredefinedConfig/Common/AdaptableIcon.d.ts

@@ -51,4 +51,4 @@ export interface AdaptableBaseIcon {
 /**
  * All AdapTable internal icon names
  */
-export declare type AdaptableInternalIconName = 'add' | 'alert' | 'analysis' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'chart-and-grid' | 'calendar' | 'call' | 'cells' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'comment' | 'contains' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'menu' | 'minus' | 'multiplication' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold';
+export declare type AdaptableInternalIconName = 'add' | 'alert' | 'building' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'chart-and-grid' | 'calendar' | 'call' | 'cells' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'comment' | 'contains' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'menu' | 'minus' | 'multiplication' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold';

package/src/PredefinedConfig/Common/AdaptablePredicate.d.ts

@@ -109,7 +109,7 @@ export interface PredicateDefHandlerParams {
 export interface PredicateDefToStringParams {
     inputs: any[];
 }
-export declare type PredicateModuleScope = 'filter' | 'alert' | 'flashingcell' | 'formatColumn';
+export declare type PredicateModuleScope = 'filter' | 'alert' | 'flashingcell' | 'formatColumn' | 'badgeStyle';
 /**
  * Array of Predicate Defs which are shipped by AdapTable
  */
@@ -118,6 +118,7 @@ export declare const SystemFilterPredicateIds: string[];
 export declare const SystemAlertPredicateIds: string[];
 export declare const SystemFormatColumnPredicateIds: string[];
 export declare const SystemFlashingCellPredicateIds: string[];
+export declare const SystemBadgeStylePredicateIds: string[];
 /**
  * Column Filter Definition for a specific Column
  */

package/src/PredefinedConfig/Common/AdaptablePredicate.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SystemFlashingCellPredicateIds = exports.SystemFormatColumnPredicateIds = exports.SystemAlertPredicateIds = exports.SystemFilterPredicateIds = exports.SystemPredicateDefs = void 0;
+exports.SystemBadgeStylePredicateIds = exports.SystemFlashingCellPredicateIds = exports.SystemFormatColumnPredicateIds = exports.SystemAlertPredicateIds = exports.SystemFilterPredicateIds = exports.SystemPredicateDefs = void 0;
 const tslib_1 = require("tslib");
 const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
 const isToday_1 = tslib_1.__importDefault(require("date-fns/isToday"));
@@ -26,7 +26,7 @@ exports.SystemPredicateDefs = [
         label: 'Values',
         icon: { text: 'IN' },
         columnScope: { DataTypes: ['String', 'Number', 'Date'] },
-        moduleScope: ['filter', 'formatColumn', 'alert'],
+        moduleScope: ['filter', 'formatColumn', 'alert', 'badgeStyle'],
         handler: ({ inputs, column, value }) => {
             if (inputs.length === 0) {
                 return true;
@@ -52,7 +52,7 @@ exports.SystemPredicateDefs = [
         label: 'Exclude Values',
         icon: { text: '!IN' },
         columnScope: { DataTypes: ['String', 'Number', 'Date'] },
-        moduleScope: ['filter', 'formatColumn', 'alert'],
+        moduleScope: ['filter', 'formatColumn', 'alert', 'badgeStyle'],
         handler: ({ inputs, column, value }) => {
             // basically negation of IN
             if (inputs.length === 0) {
@@ -78,7 +78,7 @@ exports.SystemPredicateDefs = [
         label: 'Blanks',
         icon: { name: 'unfilled-circle' },
         columnScope: { All: true },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         handler: ({ value }) => Helper_1.default.IsInputNullOrEmpty(value),
     },
     {
@@ -86,7 +86,7 @@ exports.SystemPredicateDefs = [
         label: 'Non Blanks',
         icon: { name: 'filled-circle' },
         columnScope: { All: true },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         handler: ({ value }) => Helper_1.default.IsInputNotNullOrEmpty(value),
     },
     // Numeric System Filters
@@ -95,7 +95,7 @@ exports.SystemPredicateDefs = [
         label: 'Greater Than',
         icon: { name: 'greater-than' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'number' }],
         handler: ({ value, inputs }) => Number(value) > Number(inputs[0]),
         toString: ({ inputs }) => `> ${inputs[0]}`,
@@ -106,7 +106,7 @@ exports.SystemPredicateDefs = [
         label: 'Less Than',
         icon: { name: 'less-than' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'number' }],
         handler: ({ value, inputs }) => Number(value) < Number(inputs[0]),
         toString: ({ inputs }) => `< ${inputs[0]}`,
@@ -117,7 +117,7 @@ exports.SystemPredicateDefs = [
         label: 'Positive',
         icon: { text: '>0' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         handler: ({ value }) => Number(value) > 0,
     },
     {
@@ -125,7 +125,7 @@ exports.SystemPredicateDefs = [
         label: 'Negative',
         icon: { text: '<0' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         handler: ({ value }) => Number(value) < 0,
     },
     {
@@ -133,7 +133,7 @@ exports.SystemPredicateDefs = [
         label: 'Zero',
         icon: { text: '=0' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         handler: ({ value }) => {
             if (typeof value === 'string' && !StringExtensions_1.default.IsNumeric(value)) {
                 return false;
@@ -149,7 +149,7 @@ exports.SystemPredicateDefs = [
         label: 'Equals',
         icon: { name: 'equals' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'number' }],
         handler: ({ value, inputs }) => {
             const input = inputs[0];
@@ -167,7 +167,7 @@ exports.SystemPredicateDefs = [
         label: 'Not Equals',
         icon: { name: 'not-equal' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'number' }],
         handler: ({ value, inputs }) => {
             const input = inputs[0];
@@ -185,7 +185,7 @@ exports.SystemPredicateDefs = [
         label: 'Between',
         icon: { text: 'BE' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'number' }, { type: 'number' }],
         handler: ({ value, inputs }) => Number(value) >= Number(inputs[0]) && Number(value) <= Number(inputs[1]),
         toString: ({ inputs }) => `Between ${inputs[0]}:${inputs[1]}`,
@@ -196,7 +196,7 @@ exports.SystemPredicateDefs = [
         label: 'Not Between',
         icon: { text: '!BE' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'number' }, { type: 'number' }],
         handler: ({ value, inputs }) => Number(value) < Number(inputs[0]) || Number(value) > Number(inputs[1]),
         toString: ({ inputs }) => `Not Between ${inputs[0]}:${inputs[1]}`,
@@ -224,7 +224,7 @@ exports.SystemPredicateDefs = [
         label: 'Equals',
         icon: { name: 'equals' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -243,7 +243,7 @@ exports.SystemPredicateDefs = [
         label: 'Not Equals',
         icon: { name: 'not-equal' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -262,7 +262,7 @@ exports.SystemPredicateDefs = [
         label: 'Contains',
         icon: { name: 'contains' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -280,7 +280,7 @@ exports.SystemPredicateDefs = [
         label: 'Not Contains',
         icon: { name: 'not-contains' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -298,7 +298,7 @@ exports.SystemPredicateDefs = [
         label: 'Starts With',
         icon: { name: 'starts-with' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -316,7 +316,7 @@ exports.SystemPredicateDefs = [
         label: 'Ends With',
         icon: { name: 'ends-with' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -334,7 +334,7 @@ exports.SystemPredicateDefs = [
         label: 'Regex',
         icon: { name: 'regex' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs }) => new RegExp(inputs[0]).test(value),
         toString: ({ inputs }) => `Regex ${inputs[0]}`,
@@ -611,3 +611,4 @@ exports.SystemFilterPredicateIds = exports.SystemPredicateDefs.filter((p) => p.m
 exports.SystemAlertPredicateIds = exports.SystemPredicateDefs.filter((p) => p.moduleScope.includes('alert')).map((p) => p.id);
 exports.SystemFormatColumnPredicateIds = exports.SystemPredicateDefs.filter((p) => p.moduleScope.includes('formatColumn')).map((p) => p.id);
 exports.SystemFlashingCellPredicateIds = exports.SystemPredicateDefs.filter((p) => p.moduleScope.includes('flashingcell')).map((p) => p.id);
+exports.SystemBadgeStylePredicateIds = exports.SystemPredicateDefs.filter((p) => p.moduleScope.includes('badgeStyle')).map((p) => p.id);

package/src/PredefinedConfig/StyledColumnState.d.ts

@@ -55,7 +55,7 @@ export interface PercentBarStyle extends NumericStyledColumn {
      */
     CellText?: CellTextOptions;
     /**
-     * Position of text in cell relative to Percent Bar
+     * Position of text in Cell relative to Percent Bar, "Above", "Below" or "Merged"
      * @defaultValue Below
      */
     CellTextPosition?: 'Above' | 'Below' | 'Merged';
@@ -151,7 +151,7 @@ export declare type SparkLineStyle = {
 /**
  * Predicates available when creating a Badge Style Rule
  */
-export declare type SystemBadgeStylePredicateId = 'Values' | 'ExcludeValues' | 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'InRange' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'WorkDay' | 'Holiday' | 'True' | 'False' | 'BooleanToggle';
+export declare type SystemBadgeStylePredicateId = 'Values' | 'ExcludeValues' | 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex';
 /**
  * System Predicate Ids available for Badge Style
  */
@@ -167,7 +167,7 @@ export interface BadgeStylePredicate extends AdaptablePredicate {
  */
 export interface BadgeStyleDefinition {
     /**
-     * Optional Rule for when Badge is displayed
+     * Optional Rule for deciding whether Badge is displayed
      */
     Predicate?: BadgeStylePredicate;
     /**
@@ -179,7 +179,7 @@ export interface BadgeStyleDefinition {
      */
     HideText?: boolean;
     /**
-     * Icon to display in Bidge
+     * Icon to display in Badge
      */
     Icon?: AdaptableInternalIcon | AdaptableExternalIcon;
     /**
@@ -191,5 +191,8 @@ export interface BadgeStyleDefinition {
  * Collection of Badge Style Definitions to display in a Badge Styled Column
  */
 export interface BadgeStyle {
+    /**
+     * Collection of Badge Style Definitions
+     */
     Badges?: BadgeStyleDefinition[];
 }

package/src/Utilities/Defaults/DefaultAdaptableOptions.js

@@ -73,6 +73,7 @@ exports.DefaultAdaptableOptions = {
             systemAlertPredicates: AdaptablePredicate_1.SystemAlertPredicateIds,
             systemFormatColumnPredicates: AdaptablePredicate_1.SystemFormatColumnPredicateIds,
             systemFlashingCellPredicates: AdaptablePredicate_1.SystemFlashingCellPredicateIds,
+            systemBadgeStylePredicates: AdaptablePredicate_1.SystemBadgeStylePredicateIds,
         },
     },
     containerOptions: {

package/src/Utilities/Services/ModuleService.js

@@ -128,7 +128,7 @@ class ModuleService {
             case 'SystemStatus':
                 return learnUrl + 'handbook-notifying';
             case 'TeamSharing':
-                return url + 'handbook-collaborating';
+                return learnUrl + 'handbook-collaborating';
             case 'Theme':
                 return learnUrl + 'handbook-theming';
             case 'ToolPanel':

package/src/View/StyledColumn/Wizard/StyledColumnBadgeSection.js

@@ -23,7 +23,7 @@ const BadgeEditor = (props) => {
     var _a, _b;
     const { api } = (0, OnePageAdaptableWizard_1.useOnePageAdaptableWizardContext)();
     const { badge, columnId, onChange } = props;
-    const predicateDefs = api.styledColumnApi.getBadgePredicateDefsForColumn(columnId);
+    const predicateDefs = api.styledColumnApi.internalApi.getBadgePredicateDefsForColumn(columnId);
     let previewValue = 'Hello world';
     if (api.columnApi.getColumnDataTypeForColumnId(columnId) === 'Number') {
         previewValue = '12345';

package/src/View/TeamSharing/TeamSharingApplyButton.js

@@ -10,6 +10,6 @@ const TeamSharingApplyButton = (props) => {
     const handleImport = React.useCallback(() => {
         adaptable.api.teamSharingApi.importSharedEntry(props.data);
     }, []);
-    return (React.createElement(SimpleButton_1.default, { "data-name": "shared-entity-apply-button", onClick: handleImport, variant: "text", tooltip: "Apply", icon: "import-export" }));
+    return (React.createElement(SimpleButton_1.default, { "data-name": "shared-entity-apply-button", onClick: handleImport, variant: "text", tooltip: "Import", icon: "import-export" }));
 };
 exports.TeamSharingApplyButton = TeamSharingApplyButton;

package/src/agGrid/Adaptable.js

@@ -2384,6 +2384,9 @@ class Adaptable {
                 adaptableApi: this.api,
                 actionRowButtonType,
             });
+            if (!customButtonConfig) {
+                return defaultButtonConfig;
+            }
             return Object.assign(Object.assign({}, defaultButtonConfig), customButtonConfig);
         })
             .filter(Boolean);

package/src/components/icons/index.js

@@ -154,7 +154,7 @@ const allIcons = {
     'chart-and-grid': calculated_column_1.default,
     laptop: application_1.default,
     alert: alert_1.default,
-    analysis: analysis_1.default,
+    building: analysis_1.default,
     'edit-table': bulk_update_1.default,
     chart: chart_1.default,
     'column-add': column_add_1.default,

package/src/metamodel/adaptable.metamodel.d.ts

@@ -1160,6 +1160,12 @@ export declare const ADAPTABLE_METAMODEL: {
         name: string;
         kind: string;
         desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+        }[];
     };
     BadgeStyleDefinition: {
         name: string;