@adaptabletools/adaptable 10.0.2 → 10.0.4-canary.2

package/src/View/Components/FilterForm/QuickFilterForm.d.ts

@@ -1,50 +1,10 @@
-import * as React from 'react';
-import * as FilterRedux from '../../../Redux/ActionsReducers/FilterRedux';
+/// <reference types="react" />
 import { ColumnFilterContext } from '../../../Utilities/Interface/ColumnFilterContext';
-import { ModuleViewPopupProps } from '../SharedProps/ModuleViewPopupProps';
-import { AdaptableColumn } from '../../../PredefinedConfig/Common/AdaptableColumn';
-import { AdaptableApi } from '../../../Api/AdaptableApi';
 import { ColumnFilter } from '../../../PredefinedConfig/FilterState';
-import { AdaptablePredicateDef } from '../../../PredefinedConfig/Common/AdaptablePredicate';
-import { FilterOptions } from '../../../AdaptableOptions/FilterOptions';
-interface QuickFilterFormProps extends ModuleViewPopupProps<QuickFilterFormComponent> {
-    api: AdaptableApi;
-    currentColumn: AdaptableColumn;
-    columnFilters: ColumnFilter[];
-    quickFilterTrigger?: FilterOptions['quickFilterTrigger'];
-    onAddColumnFilter: (columnFilter: ColumnFilter) => FilterRedux.ColumnFilterAddAction;
-    onEditColumnFilter: (columnFilter: ColumnFilter) => FilterRedux.ColumnFilterEditAction;
-}
 export interface QuickFilterFormState {
     filter: ColumnFilter;
     distinctColumnValues: any[];
+    isDistinctColumnValuesLoading: boolean;
+    suppressClientSideFilter: boolean;
 }
-declare class QuickFilterFormComponent extends React.Component<QuickFilterFormProps, QuickFilterFormState> {
-    private valuesDropdown?;
-    constructor(props: QuickFilterFormProps);
-    getDistinctValues: (props?: Readonly<QuickFilterFormProps> & Readonly<{
-        children?: React.ReactNode;
-    }>) => any[];
-    updateDistinctValues(props?: Readonly<QuickFilterFormProps> & Readonly<{
-        children?: React.ReactNode;
-    }>): void;
-    UNSAFE_componentWillReceiveProps(nextProps: QuickFilterFormProps): void;
-    getFilterFromProps(props: QuickFilterFormProps): ColumnFilter;
-    render(): any;
-    renderLabel(filter: ColumnFilter, activePredicateDef: AdaptablePredicateDef): JSX.Element;
-    renderPredicateIcon(predicateDef: AdaptablePredicateDef): JSX.Element;
-    renderPredicateInput(predicateDef: AdaptablePredicateDef, filter: ColumnFilter): JSX.Element | JSX.Element[];
-    renderNoValuesDropdown(filter: ColumnFilter): JSX.Element;
-    renderValuesDropdown(filter: ColumnFilter): JSX.Element;
-    onColumnValuesChange(columnValues: any[]): void;
-    selectColumnPredicate(predicateId: string): void;
-    debouncedAddFilter: import("lodash").DebouncedFunc<() => FilterRedux.ColumnFilterAddAction>;
-    debouncedEditFilter: import("lodash").DebouncedFunc<() => FilterRedux.ColumnFilterEditAction>;
-    private updateFilter;
-    changeColumnPredicateInput(value: string, index: number): void;
-    getPredicateIdForShortcutValue(value: string): string;
-    clearFilter(): void;
-}
-export declare const QuickFilterForm: import("react-redux").ConnectedComponent<typeof QuickFilterFormComponent, any>;
 export declare const QuickFilterFormReact: (FilterContext: ColumnFilterContext) => JSX.Element;
-export {};

package/src/View/Components/FilterForm/QuickFilterForm.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuickFilterFormReact = exports.QuickFilterForm = void 0;
+exports.QuickFilterFormReact = void 0;
 const tslib_1 = require("tslib");
 const React = tslib_1.__importStar(require("react"));
 const debounce_1 = tslib_1.__importDefault(require("lodash-es/debounce"));
@@ -16,60 +16,87 @@ const ArrayExtensions_1 = tslib_1.__importDefault(require("../../../Utilities/Ex
 const AdaptableInput_1 = tslib_1.__importDefault(require("../AdaptableInput"));
 const renderWithAdaptableContext_1 = require("../../renderWithAdaptableContext");
 const CheckBox_1 = require("../../../components/CheckBox");
+const isEqual_1 = tslib_1.__importDefault(require("lodash-es/isEqual"));
+const runIfNotResolvedIn_1 = require("../../../Utilities/runIfNotResolvedIn");
+const getDefaultColumnFilterPredicate_1 = require("./getDefaultColumnFilterPredicate");
 class QuickFilterFormComponent extends React.Component {
     constructor(props) {
         super(props);
-        this.getDistinctValues = (props = this.props) => {
-            return props.api.columnApi.getDistinctDisplayValuesForColumn(props.currentColumn.ColumnId);
+        this._isMounted = false;
+        this.handleFilterChange = (filter) => {
+            if (this.state.suppressClientSideFilter) {
+                this.loadPermittedValues(filter);
+            }
+        };
+        this.loadPermittedValues = async (filter = '') => {
+            const { values, suppressClientSideFilter } = await runIfNotResolvedIn_1.runIfNotResolvedIn(this.props.api.columnApi.getDistinctFilterDisplayValuesForColumn(this.props.currentColumn.columnId, filter), () => this._isMounted && this.setState({ isDistinctColumnValuesLoading: true }));
+            if (!this._isMounted) {
+                return;
+            }
+            this.setState({
+                distinctColumnValues: values,
+                suppressClientSideFilter,
+                isDistinctColumnValuesLoading: false,
+            });
         };
         this.debouncedAddFilter = debounce_1.default(() => this.props.onAddColumnFilter(this.state.filter), 250);
         this.debouncedEditFilter = debounce_1.default(() => this.props.onEditColumnFilter(this.state.filter), 250);
-        const filter = this.getFilterFromProps(props);
-        const distinctColumnValues = filter.Predicate.PredicateId === 'Values' ? this.getDistinctValues() : [];
+        const filter = this.getFilterFromProps();
+        this._isMounted = true;
         this.state = {
             filter,
-            distinctColumnValues,
+            suppressClientSideFilter: false,
+            isDistinctColumnValuesLoading: false,
+            distinctColumnValues: [],
         };
     }
-    updateDistinctValues(props = this.props) {
-        this.setState({ distinctColumnValues: this.getDistinctValues(props) });
+    componentDidMount() {
+        var _a, _b;
+        if (((_b = (_a = this.state) === null || _a === void 0 ? void 0 : _a.filter) === null || _b === void 0 ? void 0 : _b.Predicate.PredicateId) === 'Values') {
+            this.loadPermittedValues();
+        }
+    }
+    componentWillUnmount() {
+        this._isMounted = false;
     }
     UNSAFE_componentWillReceiveProps(nextProps) {
         const filter = this.getFilterFromProps(nextProps);
-        this.setState({
-            filter,
-        });
+        if (isEqual_1.default(filter, this.state.filter)) {
+            return;
+        }
+        this.setState({ filter });
         if ((filter === null || filter === void 0 ? void 0 : filter.Predicate) && filter.Predicate.PredicateId === 'Values') {
-            this.updateDistinctValues(nextProps);
+            this.setState({ isDistinctColumnValuesLoading: true });
+            this.loadPermittedValues();
         }
     }
-    getFilterFromProps(props) {
-        const filter = props.columnFilters.find((cf) => cf.ColumnId == props.currentColumn.ColumnId);
+    getFilterFromProps(props = this.props) {
+        const filter = props.columnFilters.find((cf) => cf.ColumnId == props.currentColumn.columnId);
         const filterOptions = props.api.internalApi.getAdaptableOptions().filterOptions;
         if (filter) {
             return filter;
         }
-        if (!filter && props.currentColumn.DataType === 'Number') {
-            return ObjectFactory_1.ObjectFactory.CreateColumnFilter(this.props.currentColumn.ColumnId, filterOptions.defaultNumericColumnFilter, ['']);
+        if (!filter && props.currentColumn.dataType === 'Number') {
+            return ObjectFactory_1.ObjectFactory.CreateColumnFilter(props.currentColumn.columnId, getDefaultColumnFilterPredicate_1.getDefaultColumnFilterPredicate(props.currentColumn, filterOptions.defaultNumericColumnFilter), ['']);
         }
-        if (!filter && props.currentColumn.DataType === 'String') {
-            return ObjectFactory_1.ObjectFactory.CreateColumnFilter(this.props.currentColumn.ColumnId, filterOptions.defaultStringColumnFilter, ['']);
+        if (!filter && props.currentColumn.dataType === 'String') {
+            return ObjectFactory_1.ObjectFactory.CreateColumnFilter(props.currentColumn.columnId, getDefaultColumnFilterPredicate_1.getDefaultColumnFilterPredicate(props.currentColumn, filterOptions.defaultStringColumnFilter), ['']);
         }
-        if (!filter && props.currentColumn.DataType === 'Date') {
-            return ObjectFactory_1.ObjectFactory.CreateColumnFilter(this.props.currentColumn.ColumnId, filterOptions.defaultDateColumnFilter, ['']);
+        if (!filter && props.currentColumn.dataType === 'Date') {
+            return ObjectFactory_1.ObjectFactory.CreateColumnFilter(props.currentColumn.columnId, getDefaultColumnFilterPredicate_1.getDefaultColumnFilterPredicate(props.currentColumn, filterOptions.defaultDateColumnFilter), ['']);
         }
-        if (!filter && props.currentColumn.DataType === 'Boolean') {
-            return ObjectFactory_1.ObjectFactory.CreateColumnFilter(this.props.currentColumn.ColumnId, 'BooleanToggle', [
+        if (!filter && props.currentColumn.dataType === 'Boolean') {
+            return ObjectFactory_1.ObjectFactory.CreateColumnFilter(this.props.currentColumn.columnId, 'BooleanToggle', [
                 'all',
             ]);
         }
-        return ObjectFactory_1.ObjectFactory.CreateColumnFilter(this.props.currentColumn.ColumnId, null, null);
+        return ObjectFactory_1.ObjectFactory.CreateColumnFilter(this.props.currentColumn.columnId, null, null);
     }
     render() {
         const { filter } = this.state;
         const predicateDefs = this.props.api.filterApi.getFilterPredicateDefsForColumn(this.props.currentColumn);
         const activePredicateDef = this.props.api.predicateApi.getPredicateDefById(filter === null || filter === void 0 ? void 0 : filter.Predicate.PredicateId);
-        if (!this.props.currentColumn || !this.props.currentColumn.Filterable) {
+        if (!this.props.currentColumn || !this.props.currentColumn.filterable) {
             return null;
         }
         let showEvent = 'mouseenter';
@@ -79,14 +106,12 @@ class QuickFilterFormComponent extends React.Component {
             hideEvent = 'blur';
         }
         let showQuickFilterDropdown = true;
-        let hideQuickFilterDropdownFunction = this.props.api.internalApi.getAdaptableOptions()
-            .filterOptions.hideQuickFilterDropdown;
+        let hideQuickFilterDropdownFunction = this.props.api.internalApi.getAdaptableOptions().filterOptions.hideQuickFilterDropdown;
         if (hideQuickFilterDropdownFunction) {
             showQuickFilterDropdown = !hideQuickFilterDropdownFunction(this.props.currentColumn);
         }
         let showQuickFilterInput = true;
-        let hideQuickFilterInputFunction = this.props.api.internalApi.getAdaptableOptions()
-            .filterOptions.hideQuickFilterInput;
+        let hideQuickFilterInputFunction = this.props.api.internalApi.getAdaptableOptions().filterOptions.hideQuickFilterInput;
         if (hideQuickFilterInputFunction) {
             showQuickFilterInput = !hideQuickFilterInputFunction(this.props.currentColumn);
         }
@@ -179,11 +204,25 @@ class QuickFilterFormComponent extends React.Component {
             } }, 'No Column Values'));
     }
     renderValuesDropdown(filter) {
-        return (React.createElement(OverlayTrigger_1.default, { alignHorizontal: "left", showEvent: "mouseenter", hideEvent: "mouseleave", hideDelay: 300, ref: (api) => {
+        let showEvent = 'mouseenter';
+        if (this.props.quickFilterValuesTrigger === 'click') {
+            showEvent = 'click';
+        }
+        return (React.createElement(OverlayTrigger_1.default, { alignHorizontal: "left", showEvent: showEvent, 
+            // cannot hide on blur, because the form input receives the input when this is opened
+            hideEvent: "mouseleave", hideDelay: 300, ref: (api) => {
                 this.valuesDropdown = api;
             }, render: () => {
                 var _a;
-                return (React.createElement(rebass_1.Flex, { "data-name": "quick-filter-form", flexDirection: "column", style: {
+                return (React.createElement(rebass_1.Flex, { onMouseEnter: () => {
+                        var _a;
+                        if (showEvent === 'click') {
+                            // For showEvent=mouseneter this is not needed.
+                            // When mouseenter is triggered on the overlay, onShowFn is called, the overlay is no longer hidden.
+                            // But in this case because the trigger is click, another show is not triggered.
+                            (_a = this.valuesDropdown) === null || _a === void 0 ? void 0 : _a.show();
+                        }
+                    }, "data-name": "quick-filter-form", flexDirection: "column", style: {
                         fontSize: 'var(--ab-font-size-2)',
                         border: '1px solid var(--ab-color-primarydark)',
                         background: 'var(--ab-color-defaultbackground)',
@@ -193,7 +232,7 @@ class QuickFilterFormComponent extends React.Component {
                         React.createElement(SimpleButton_1.default, { onClick: () => this.clearFilter() }, "Clear Filter"),
                         ((_a = this.props.api.internalApi.getAdaptableOptions().filterOptions) === null || _a === void 0 ? void 0 : _a.autoApplyFilter) ==
                             false && (React.createElement(SimpleButton_1.default, { ml: 2, onClick: () => this.updateFilter(this.state.filter) }, "Apply Filter"))),
-                    React.createElement(ListBoxFilterForm_1.ListBoxFilterForm, { currentColumn: this.props.currentColumn, columns: [], columnDistinctValues: this.state.distinctColumnValues, dataType: this.props.currentColumn.DataType, uiSelectedColumnValues: this.state.filter.Predicate.Inputs, useVendorStyle: true, onColumnValueSelectedChange: (list) => this.onColumnValuesChange(list) })));
+                    React.createElement(ListBoxFilterForm_1.ListBoxFilterForm, { suppressClientSideFilter: this.state.suppressClientSideFilter, isLoading: this.state.isDistinctColumnValuesLoading, onFilterChange: this.handleFilterChange, currentColumn: this.props.currentColumn, columns: [], columnDistinctValues: this.state.distinctColumnValues, dataType: this.props.currentColumn.dataType, uiSelectedColumnValues: this.state.filter.Predicate.Inputs, useAgGridStyle: true, onColumnValueSelectedChange: (list) => this.onColumnValuesChange(list) })));
             } },
             React.createElement(SimpleButton_1.default, { style: {
                     flex: 1,
@@ -226,7 +265,7 @@ class QuickFilterFormComponent extends React.Component {
         };
         this.updateFilter(filter);
         if (predicateId === 'Values') {
-            this.updateDistinctValues();
+            this.loadPermittedValues();
             requestAnimationFrame(() => {
                 if (this.valuesDropdown) {
                     this.valuesDropdown.show();
@@ -276,8 +315,8 @@ function mapDispatchToProps(dispatch) {
         onEditColumnFilter: (columnFilter) => dispatch(FilterRedux.ColumnFilterEdit(columnFilter)),
     };
 }
-exports.QuickFilterForm = react_redux_1.connect(mapStateToProps, mapDispatchToProps)(QuickFilterFormComponent);
+const QuickFilterForm = react_redux_1.connect(mapStateToProps, mapDispatchToProps)(QuickFilterFormComponent);
 exports.QuickFilterFormReact = (FilterContext) => {
-    var _a;
-    return renderWithAdaptableContext_1.renderWithAdaptableContext(React.createElement(exports.QuickFilterForm, { api: FilterContext.Adaptable.api, quickFilterTrigger: (_a = FilterContext.Adaptable.adaptableOptions.filterOptions) === null || _a === void 0 ? void 0 : _a.quickFilterTrigger, currentColumn: FilterContext.Column, teamSharingActivated: false, embedColumnMenu: FilterContext.Adaptable.embedColumnMenu }), FilterContext.Adaptable);
+    var _a, _b;
+    return renderWithAdaptableContext_1.renderWithAdaptableContext(React.createElement(QuickFilterForm, { api: FilterContext.Adaptable.api, quickFilterTrigger: (_a = FilterContext.Adaptable.adaptableOptions.filterOptions) === null || _a === void 0 ? void 0 : _a.quickFilterTrigger, quickFilterValuesTrigger: (_b = FilterContext.Adaptable.adaptableOptions.filterOptions) === null || _b === void 0 ? void 0 : _b.quickFilterValuesTrigger, currentColumn: FilterContext.Column, teamSharingActivated: false, embedColumnMenu: FilterContext.Adaptable.embedColumnMenu }), FilterContext.Adaptable);
 };

package/src/View/Components/FilterForm/getDefaultColumnFilterPredicate.d.ts

@@ -0,0 +1,3 @@
+import { AdaptableColumn } from '../../../PredefinedConfig/Common/AdaptableColumn';
+import { SystemFilterPredicateId } from '../../../PredefinedConfig/FilterState';
+export declare const getDefaultColumnFilterPredicate: (column: AdaptableColumn, defaultColumnFilter: "After" | "Before" | "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" | "On" | "NotOn" | "NextWorkDay" | "LastWorkDay" | "True" | "False" | "Values" | "InRange" | "BooleanToggle" | ((column: AdaptableColumn) => SystemFilterPredicateId)) => SystemFilterPredicateId;

package/src/View/Components/FilterForm/getDefaultColumnFilterPredicate.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultColumnFilterPredicate = void 0;
+exports.getDefaultColumnFilterPredicate = (column, defaultColumnFilter) => {
+    return typeof defaultColumnFilter === 'function'
+        ? defaultColumnFilter(column)
+        : defaultColumnFilter;
+};

package/src/View/Components/NewScopeComponent.js

@@ -54,7 +54,7 @@ exports.renderScopeSummary = (scope, labels) => {
             React.createElement(OnePageAdaptableWizard_1.SummaryText, { mb: 0 }, scopeApi.scopeIsAll(scope) ? labels.scopeWholeRow : null)),
         React.createElement(rebass_1.Box, { style: { overflow: 'hidden' } }, 'ColumnIds' in scope ? (React.createElement(React.Fragment, null,
             React.createElement(OnePageAdaptableWizard_1.SummaryText, { mb: columnsInScope.length ? 2 : 0 }, labels.scopeColumns),
-            columnsInScope.length ? (React.createElement(ValueSelector_1.ValueOptionsTags, { options: columnsInScope, value: columnsInScope.map((c) => c.ColumnId), toLabel: (c) => c.FriendlyName, allowWrap: true, readOnly: true, renderLabel: (c) => React.createElement(OnePageAdaptableWizard_1.SummaryText, { mb: 0 }, c), toIdentifier: (c) => c.ColumnId })) : null)) : null),
+            columnsInScope.length ? (React.createElement(ValueSelector_1.ValueOptionsTags, { options: columnsInScope, value: columnsInScope.map((c) => c.columnId), toLabel: (c) => c.friendlyName, allowWrap: true, readOnly: true, renderLabel: (c) => React.createElement(OnePageAdaptableWizard_1.SummaryText, { mb: 0 }, c), toIdentifier: (c) => c.columnId })) : null)) : null),
         React.createElement(rebass_1.Box, null, 'DataTypes' in scope ? (React.createElement(React.Fragment, null,
             React.createElement(rebass_1.Text, { fontSize: 2, mb: 2 }, labels.scopeDataTypes),
             React.createElement(ValueSelector_1.ValueOptionsTags, { readOnly: true, options: scope.DataTypes, value: scope.DataTypes, toLabel: (c) => c, allowWrap: true, renderLabel: (c) => React.createElement(rebass_1.Text, { fontSize: 2 }, `DataType: ${c}`), toIdentifier: (c) => c }))) : null)));

package/src/View/Components/Panels/FilterFormPanel.d.ts

@@ -10,7 +10,7 @@ export interface FilterFormPanelProps extends PanelProps {
     onFilterApplied: () => void;
     IsAlwaysFilter: boolean;
     showCloseButton: boolean;
-    useVendorStyle: boolean;
+    useAgGridStyle: boolean;
     applyFilterButtonDisabled: boolean;
     autoApplyFilter: boolean;
 }