Merge pull request #779 from rszwajko/typeAheadFilter

Add type-ahead search to GroupedEnumFilter
kubev2v · Nov 28, 2023 · 00b6a69 · 00b6a69
2 parents 6bc0dcd + d280b5e
commit 00b6a69
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 11 deletions.
diff --git a/packages/common/src/components/Filter/GroupedEnumFilter.tsx b/packages/common/src/components/Filter/GroupedEnumFilter.tsx
@@ -11,7 +11,7 @@ import {
 
 import { EnumValue } from '../../utils';
 
-import { FilterTypeProps } from './types';
+import { FilterTypeProps, InlineFilter } from './types';
 
 /**
  * This Filter type enables selecting one or many enum values that are separated by groups.
@@ -40,7 +40,8 @@ export const GroupedEnumFilter = ({
   supportedGroups = [],
   placeholderLabel,
   showFilter = true,
-}: FilterTypeProps) => {
+  hasInlineFilter = false,
+}: FilterTypeProps & InlineFilter) => {
   const [isExpanded, setExpanded] = useState(false);
 
   // simplify lookup
@@ -76,6 +77,36 @@ export const GroupedEnumFilter = ({
       compareTo: (option) => option.id === id && option.groupId === groupId,
     } as SelectOptionObject);
 
+  const options = supportedGroups.map(({ label, groupId }) => (
+    <SelectGroup key={groupId} label={label}>
+      {supportedEnumValues
+        .filter((item) => item.groupId === groupId)
+        .map(({ id, label }) => (
+          <SelectOption key={id} value={toSelectOption({ id, label, groupId })} />
+        ))}
+    </SelectGroup>
+  ));
+
+  const onFilter = (_, textInput) => {
+    if (textInput === '') {
+      return options;
+    }
+
+    const filteredGroups = options
+      .map((group) => {
+        const filteredGroup = React.cloneElement(group, {
+          children: group.props.children.filter((item) => {
+            // options are not plain strings but the our toString() method
+            // converts them in a meaningful way
+            return item.props.value.toString().toLowerCase().includes(textInput.toLowerCase());
+          }),
+        });
+        if (filteredGroup.props.children.length > 0) return filteredGroup;
+      })
+      .filter((newGroup) => newGroup);
+    return filteredGroups;
+  };
+
   return (
     <>
       {/**
@@ -123,16 +154,10 @@ export const GroupedEnumFilter = ({
           placeholderText={placeholderLabel}
           isOpen={isExpanded}
           onToggle={setExpanded}
+          hasInlineFilter={hasInlineFilter}
+          onFilter={onFilter}
         >
-          {supportedGroups.map(({ label, groupId }) => (
-            <SelectGroup key={groupId} label={label}>
-              {supportedEnumValues
-                .filter((item) => item.groupId === groupId)
-                .map(({ id, label }) => (
-                  <SelectOption key={id} value={toSelectOption({ id, label, groupId })} />
-                ))}
-            </SelectGroup>
-          ))}
+          {options}
         </Select>,
       )}
     </>

diff --git a/packages/common/src/components/Filter/SearchableGroupedEnumFilter.tsx b/packages/common/src/components/Filter/SearchableGroupedEnumFilter.tsx
@@ -0,0 +1,11 @@
+import React from 'react';
+
+import { GroupedEnumFilter } from './GroupedEnumFilter';
+import { FilterTypeProps } from './types';
+
+/**
+ * GroupedEnumFilter with inline search enabled.
+ */
+export const SearchableGroupedEnumFilter = (props: FilterTypeProps) => (
+  <GroupedEnumFilter {...props} hasInlineFilter={true} />
+);
diff --git a/packages/common/src/components/Filter/index.ts b/packages/common/src/components/Filter/index.ts
@@ -4,6 +4,7 @@ export * from './DateRangeFilter';
 export * from './EnumFilter';
 export * from './FreetextFilter';
 export * from './GroupedEnumFilter';
+export * from './SearchableGroupedEnumFilter';
 export * from './SwitchFilter';
 export * from './types';
 // @endindex
diff --git a/packages/common/src/components/Filter/types.ts b/packages/common/src/components/Filter/types.ts
@@ -44,3 +44,7 @@ export interface FilterTypeProps {
   /** Text that explains how to use the filter. */
   helperText?: string | React.ReactNode;
 }
+
+export interface InlineFilter {
+  hasInlineFilter?: boolean;
+}
diff --git a/packages/common/src/components/FilterGroup/matchers.ts b/packages/common/src/components/FilterGroup/matchers.ts
@@ -7,6 +7,7 @@ import {
   EnumFilter,
   FreetextFilter,
   GroupedEnumFilter,
+  SearchableGroupedEnumFilter,
   SwitchFilter,
 } from '../Filter';
 
@@ -103,6 +104,11 @@ const groupedEnumMatcher = {
   matchValue: enumMatcher.matchValue,
 };
 
+const searchableGroupedEnumMatcher = {
+  filterType: 'searchableGroupedEnum',
+  matchValue: enumMatcher.matchValue,
+};
+
 const dateMatcher = {
   filterType: 'date',
   matchValue: (value: string) => (filter: string) => areSameDayInUTCZero(value, filter),
@@ -122,6 +128,7 @@ export const defaultValueMatchers: ValueMatcher[] = [
   freetextMatcher,
   enumMatcher,
   groupedEnumMatcher,
+  searchableGroupedEnumMatcher,
   sliderMatcher,
   dateMatcher,
   dateRangeMatcher,
@@ -134,6 +141,7 @@ export const defaultSupportedFilters: Record<string, FilterRenderer> = {
   freetext: FreetextFilter,
   groupedEnum: GroupedEnumFilter,
   slider: SwitchFilter,
+  searchableGroupedEnum: SearchableGroupedEnumFilter,
 };
 
 /**