@adaptabletools/adaptable 21.0.0-canary.5 → 21.0.0-canary.6

package/package.json

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

package/src/AdaptableOptions/DefaultAdaptableOptions.js

@@ -149,7 +149,7 @@ const DefaultAdaptableOptions = {
         showDatePicker: true,
         columnFilterOptions: {
             indicateFilteredColumns: true,
-            autoApplyColumnFilter: true,
+            manuallyApplyColumnFilter: false,
             defaultNumericColumnFilter: 'Equals',
             defaultTextColumnFilter: 'Contains',
             defaultDateColumnFilter: 'On',

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -79,13 +79,13 @@ export interface ColumnFilterOptions<TData = any> {
      */
     indicateFilteredColumns?: boolean;
     /**
-     * Apply Column Filters immediately; if false an Apply Filter button is displayed and Quick Filter is disabled
+     * Manually apply Column Filters; an Apply Filter button is displayed and Quick Filter is disabled
      *
-     * @defaultValue true
+     * @defaultValue false
      * @gridInfoItem
      * @noCodeItem
      */
-    autoApplyColumnFilter?: boolean | ((context: AdaptableColumnContext) => boolean);
+    manuallyApplyColumnFilter?: boolean | ((context: AdaptableColumnContext) => boolean);
     /**
      * Default filter type for numeric Columns
      *
@@ -260,7 +260,7 @@ export interface CustomInFilterValuesContext<TData = any> extends AdaptableColum
      */
     currentSearchValue: string;
     /**
-     * Previous filter result; avoids expensive recomputations (e.g for async op or server-side filtering)
+     * Last filter result; avoids expensive recomputations (eg if async or server-side filtering)
      */
     previousFilterResult?: InFilterValueResult;
 }

package/src/AdaptableState/LayoutState.d.ts

@@ -258,7 +258,7 @@ export type ColumnDirectionMap = {
     [columnId: string]: 'left' | 'right';
 };
 /**
- * State & behaviour for sizing a column (must set `width` or `flex` property, but not both); all other props optional
+ * State & behaviour for column sizing (must set `width` or `flex` but not both); all other props optional
  */
 export type ColumnSizingDefinition = ({
     Width?: number;

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

@@ -54,7 +54,7 @@ export declare class ColumnFilterInternalApi extends ApiBase {
         columnId: string;
         currentSearchValue: string;
     }): Promise<InFilterValueResult>;
-    shouldAutoApplyColumnFilter(columnId: string): boolean;
+    shouldManuallyApplyColumnFilter(columnId: string): boolean;
     getAdaptableFilterHandler(columnId: string): AdaptableFilterHandler | undefined;
     getAllAdaptableFilterHandlers(): AdaptableFilterHandler[];
 }

package/src/Api/Internal/ColumnFilterInternalApi.js

@@ -263,21 +263,21 @@ export class ColumnFilterInternalApi extends ApiBase {
         }
         return columnFilterHandler.getFromCacheOrFetchFilterDisplayValues(newOptions);
     }
-    shouldAutoApplyColumnFilter(columnId) {
-        const autoApplyColumnFilterOpt = this.getOptionsApi().getFilterOptions().columnFilterOptions?.autoApplyColumnFilter;
-        if (typeof autoApplyColumnFilterOpt === 'boolean') {
-            return autoApplyColumnFilterOpt;
+    shouldManuallyApplyColumnFilter(columnId) {
+        const manuallyApplyColumnFilterOpt = this.getOptionsApi().getFilterOptions().columnFilterOptions?.manuallyApplyColumnFilter;
+        if (typeof manuallyApplyColumnFilterOpt === 'boolean') {
+            return manuallyApplyColumnFilterOpt;
         }
-        if (typeof autoApplyColumnFilterOpt === 'function') {
+        if (typeof manuallyApplyColumnFilterOpt === 'function') {
             const column = this.getColumnApi().getColumnWithColumnId(columnId);
             const context = {
                 column,
                 ...this.getAdaptableApi().internalApi.buildBaseContext(),
             };
-            return autoApplyColumnFilterOpt(context);
+            return manuallyApplyColumnFilterOpt(context);
         }
         // fallback, should never happen
-        return true;
+        return false;
     }
     getAdaptableFilterHandler(columnId) {
         return this.getAgGridApi().getColumnFilterHandler(columnId);

package/src/View/Components/ColumnFilter/ColumnFilter.js

@@ -62,16 +62,16 @@ const AndOrInput = (props) => {
 };
 export const ColumnFilterComponent = (props) => {
     const adaptable = useAdaptable();
-    const autoApplyColumnFilter = adaptable.api.filterApi.columnFilterApi.internalApi.shouldAutoApplyColumnFilter(props.columnId);
+    const manuallyApplyColumnFilter = adaptable.api.filterApi.columnFilterApi.internalApi.shouldManuallyApplyColumnFilter(props.columnId);
     const [predicateNotYetApplied, setPredicateNotYetApplied] = React.useState(props.predicate);
     const applyFilter = () => {
         props.onPredicateChange(currentPredicateRef.current);
         setPredicateNotYetApplied(undefined);
     };
     const onPredicateChange = (predicate) => {
-        // even if autoApplyColumnFilter is false, when we explicitly clear the filter
+        // even if manuallyApplyColumnFilter is false, when we explicitly clear the filter
         // we want to apply the filter immediately
-        if (autoApplyColumnFilter || !predicate) {
+        if (!manuallyApplyColumnFilter || !predicate) {
             props.onPredicateChange(predicate);
         }
         else {
@@ -95,7 +95,7 @@ export const ColumnFilterComponent = (props) => {
         };
         onPredicateChange(newPredicate);
     };
-    const currentPredicate = autoApplyColumnFilter
+    const currentPredicate = !manuallyApplyColumnFilter
         ? props.predicate
         : predicateNotYetApplied ?? props.predicate;
     const currentPredicateRef = React.useRef(currentPredicate);
@@ -141,7 +141,7 @@ export const ColumnFilterComponent = (props) => {
                         } }));
                 }),
                 isLastPredicateValid && filterPredicateDropdown),
-            !autoApplyColumnFilter ? (React.createElement(React.Fragment, null,
+            manuallyApplyColumnFilter ? (React.createElement(React.Fragment, null,
                 React.createElement(Box, { flex: 1, "data-name": "spacer" }),
                 React.createElement(Flex, { pt: 2, className: "ab-ColumnFilter-actions", justifyContent: "space-between" },
                     React.createElement(Box, { className: "ab-ColumnFilter-action-apply" },

package/src/View/Components/ColumnFilter/FloatingFilter.js

@@ -14,7 +14,7 @@ export const FloatingFilter = (props) => {
      * The wrapper is in charge of constructing the correct column filter.
      */
     const isMultiple = props.predicate?.args?.length > 1;
-    const isManualApply = !adaptable.api.filterApi.columnFilterApi.internalApi.shouldAutoApplyColumnFilter(props.columnId);
+    const isManualApply = adaptable.api.filterApi.columnFilterApi.internalApi.shouldManuallyApplyColumnFilter(props.columnId);
     const isInlineEditable = !isMultiple && !isManualApply;
     // only used when there is only one filter selected
     let singleFilterPredicateDef = null;

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     NEXT_PUBLIC_INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862" || '',
-    PUBLISH_TIMESTAMP: 1757190997535 || Date.now(),
-    VERSION: "21.0.0-canary.5" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1757310399525 || Date.now(),
+    VERSION: "21.0.0-canary.6" || '--current-version--',
 };

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

@@ -1953,32 +1953,32 @@ export declare const ADAPTABLE_METAMODEL: {
             desc: string;
             isOpt: boolean;
             gridInfo: string;
-            noCode: string;
             defVal: string;
+            noCode?: undefined;
         } | {
             name: string;
             kind: string;
             desc: string;
             isOpt: boolean;
-            gridInfo: string;
             defVal: string;
+            gridInfo?: undefined;
             noCode?: undefined;
         } | {
             name: string;
             kind: string;
             desc: string;
             isOpt: boolean;
+            gridInfo: string;
+            noCode: string;
             defVal: string;
-            gridInfo?: undefined;
-            noCode?: undefined;
         } | {
             name: string;
             kind: string;
             desc: string;
             isOpt: boolean;
             gridInfo?: undefined;
-            noCode?: undefined;
             defVal?: undefined;
+            noCode?: undefined;
         } | {
             name: string;
             kind: string;