feat: add onChangeFilterInputEvent to combobox for filter input handling

Author: yordan-st

packages/pluggableWidgets/combobox-web/src/Combobox.xml

@@ -329,6 +329,14 @@
                 <caption>On leave action</caption>
                 <description />
             </property>
+
+            <property key="onChangeFilterInputEvent" type="action" required="false">
+                <caption>On change filter input</caption>
+                <description />
+                <actionVariables>
+                    <actionVariable key="filterInput" caption="Filter Input" type="String" />
+                </actionVariables>
+            </property>
         </propertyGroup>
         <propertyGroup caption="Accessibility">
             <propertyGroup caption="Accessibility">

packages/pluggableWidgets/combobox-web/src/components/MultiSelection/MultiSelection.tsx

@@ -33,7 +33,7 @@ export function MultiSelection({
         items,
         setSelectedItems,
         toggleSelectedItem
-    } = useDownshiftMultiSelectProps(selector, options, a11yConfig.a11yStatusMessage);
+    } = useDownshiftMultiSelectProps(selector, { ...options }, a11yConfig.a11yStatusMessage);
     const inputRef = useRef<HTMLInputElement>(null);
     const isSelectedItemsBoxStyle = selector.selectedItemsStyle === "boxes";
     const isOptionsSelected = selector.isOptionsSelected();

packages/pluggableWidgets/combobox-web/src/components/SingleSelection/SingleSelection.tsx

@@ -27,7 +27,7 @@ export function SingleSelection({
         reset,
         isOpen,
         highlightedIndex
-    } = useDownshiftSingleSelectProps(selector, options, a11yConfig.a11yStatusMessage);
+    } = useDownshiftSingleSelectProps(selector, { ...options }, a11yConfig.a11yStatusMessage);
     const inputRef = useRef<HTMLInputElement>(null);
     const lazyLoading = selector.lazyLoading ?? false;
     const { onScroll } = useLazyLoading({

packages/pluggableWidgets/combobox-web/src/helpers/types.ts

@@ -79,6 +79,7 @@ interface SelectorBase<T, V> {
 
     onEnterEvent?: () => void;
     onLeaveEvent?: () => void;
+    onFilterInputChange?: (filterValue: string) => void;
 }
 
 export interface SingleSelector extends SelectorBase<"single", string> {}
@@ -101,6 +102,7 @@ export interface SelectionBaseProps<Selector> {
     tabIndex: number;
     ariaRequired: DynamicValue<boolean>;
     ariaLabel?: string;
+    onFilterInputChange?: (filterValue: string) => void;
     a11yConfig: {
         ariaLabels: {
             clearSelection: string;

packages/pluggableWidgets/combobox-web/src/hooks/useDownshiftMultiSelectProps.ts

@@ -148,8 +148,18 @@ function useComboboxProps(
             selectedItem: null,
             inputId: options?.inputId,
             labelId: options?.labelId,
-            onInputValueChange({ inputValue }) {
+            onInputValueChange({ inputValue, type }) {
                 selector.options.setSearchTerm(inputValue!);
+
+                if (
+                    selector.onFilterInputChange &&
+                    type &&
+                    (type === "__input_change__" || type.includes("input_change")) &&
+                    inputValue &&
+                    inputValue.trim().length > 0
+                ) {
+                    selector.onFilterInputChange(inputValue!);
+                }
             },
             getA11yStatusMessage(options) {
                 let message =

packages/pluggableWidgets/combobox-web/src/hooks/useDownshiftSingleSelectProps.ts

@@ -29,8 +29,18 @@ export function useDownshiftSingleSelectProps(
             onSelectedItemChange({ selectedItem }: UseComboboxStateChange<string>) {
                 selector.setValue(selectedItem ?? null);
             },
-            onInputValueChange({ inputValue }) {
+            onInputValueChange({ inputValue, type }) {
                 selector.options.setSearchTerm(inputValue!);
+
+                if (
+                    selector.onFilterInputChange &&
+                    type &&
+                    (type === "__input_change__" || type.includes("input_change")) &&
+                    inputValue &&
+                    inputValue.trim().length > 0
+                ) {
+                    selector.onFilterInputChange(inputValue!);
+                }
             },
             getA11yStatusMessage(options) {
                 const selectedItem = selector.caption.get(selector.currentId);

packages/pluggableWidgets/combobox-web/src/hooks/useGetSelector.ts

@@ -1,15 +1,55 @@
-import { useRef, useState } from "react";
+import { useRef, useState, useCallback } from "react";
 import { ComboboxContainerProps } from "../../typings/ComboboxProps";
 import { getSelector } from "../helpers/getSelector";
 import { Selector } from "../helpers/types";
 
 export function useGetSelector(props: ComboboxContainerProps): Selector {
     const selectorRef = useRef<Selector | undefined>(undefined);
     const [, setInput] = useState({});
+    const debounceTimeoutRef = useRef<NodeJS.Timeout>();
+    const lastExecutedValueRef = useRef<string>("");
+
+    const onFilterInputChange = useCallback(
+        (filterValue: string) => {
+            if (!props.onChangeFilterInputEvent) {
+                return;
+            }
+
+            if (lastExecutedValueRef.current === filterValue) {
+                return;
+            }
+
+            if (debounceTimeoutRef.current) {
+                clearTimeout(debounceTimeoutRef.current);
+            }
+
+            debounceTimeoutRef.current = setTimeout(() => {
+                lastExecutedValueRef.current = filterValue;
+                if (props.onChangeFilterInputEvent?.canExecute && !props.onChangeFilterInputEvent?.isExecuting) {
+                    props.onChangeFilterInputEvent.execute({
+                        filterInput: filterValue
+                    });
+                }
+            }, 300);
+        },
+        [props.onChangeFilterInputEvent]
+    );
+
     if (!selectorRef.current) {
         selectorRef.current = getSelector(props);
         selectorRef.current.options.onAfterSearchTermChange(() => setInput({}));
+
+        if (props.onChangeFilterInputEvent) {
+            selectorRef.current.onFilterInputChange = onFilterInputChange;
+        }
     }
     selectorRef.current.updateProps(props);
+
+    if (props.onChangeFilterInputEvent) {
+        selectorRef.current.onFilterInputChange = onFilterInputChange;
+    } else {
+        selectorRef.current.onFilterInputChange = undefined;
+    }
+
     return selectorRef.current;
 }

packages/pluggableWidgets/combobox-web/typings/ComboboxProps.d.ts

@@ -4,7 +4,7 @@
  * @author Mendix Widgets Framework Team
  */
 import { ComponentType, ReactNode } from "react";
-import { ActionValue, DynamicValue, EditableValue, ListValue, ListAttributeValue, ListExpressionValue, ListWidgetValue, ReferenceValue, ReferenceSetValue, SelectionSingleValue, SelectionMultiValue } from "mendix";
+import { ActionValue, DynamicValue, EditableValue, ListValue, Option, ListAttributeValue, ListExpressionValue, ListWidgetValue, ReferenceValue, ReferenceSetValue, SelectionSingleValue, SelectionMultiValue } from "mendix";
 import { Big } from "big.js";
 
 export type SourceEnum = "context" | "database" | "static";
@@ -89,6 +89,7 @@ export interface ComboboxContainerProps {
     onChangeEvent?: ActionValue;
     onEnterEvent?: ActionValue;
     onLeaveEvent?: ActionValue;
+    onChangeFilterInputEvent?: ActionValue<{ filterInput: Option<string> }>;
     ariaRequired: DynamicValue<boolean>;
     ariaLabel?: DynamicValue<string>;
     clearButtonAriaLabel?: DynamicValue<string>;
@@ -145,6 +146,7 @@ export interface ComboboxPreviewProps {
     onChangeDatabaseEvent: {} | null;
     onEnterEvent: {} | null;
     onLeaveEvent: {} | null;
+    onChangeFilterInputEvent: {} | null;
     ariaRequired: string;
     ariaLabel: string;
     clearButtonAriaLabel: string;