Add helperText prop to Filter interface

Signed-off-by: Radoslaw Szwajkowski <[email protected]>
kubev2v · Oct 19, 2023 · 1cfb488 · 1cfb488
1 parent 037c8c2
commit 1cfb488
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/packages/common/src/components/Filter/types.ts b/packages/common/src/components/Filter/types.ts
@@ -41,4 +41,6 @@ export interface FilterTypeProps {
    * Language to be used for locale sensitive sorting/filtering. Defaults to 'en'.
    */
   resolvedLanguage: string;
+  /** Text that explains how to use the filter. */
+  helperText?: string | React.ReactNode;
 }
diff --git a/packages/common/src/components/FilterGroup/FilterFromDef.tsx b/packages/common/src/components/FilterGroup/FilterFromDef.tsx
@@ -44,6 +44,7 @@ export const FilterFromDef = ({
         supportedValues={def.values}
         supportedGroups={def.groups}
         resolvedLanguage={resolvedLanguage}
+        helperText={def.helperText}
       />
     )
   );

diff --git a/packages/common/src/utils/types.ts b/packages/common/src/utils/types.ts
@@ -1,3 +1,4 @@
+import React from 'react';
 export interface EnumGroup {
   groupId: string;
   label: string;
@@ -20,6 +21,7 @@ export interface FilterDef {
   // override default behavior if there are no filters provided by the user
   // by default missing/empty filters result in positive match (vacuous truth)
   defaultValues?: string[];
+  helperText?: string | React.ReactNode;
 }
 
 type OpenApiJsonPath = string | ((resourceData: unknown) => unknown);