feat(AnalyticalTable): add noDataReason prop to NoDataComponent

Author: Lukas742

packages/main/src/components/AnalyticalTable/defaults/NoDataComponent/index.tsx

@@ -1,9 +1,7 @@
-interface NoDataComponentProps {
-  noDataText: string;
-  className: string;
-}
+import type { AnalyticalTablePropTypes } from '../../types/index.js';
 
-export const DefaultNoDataComponent = ({ noDataText, className }: NoDataComponentProps) => {
+export const DefaultNoDataComponent: AnalyticalTablePropTypes['NoDataComponent'] = (props) => {
+  const { noDataText, className } = props;
   return (
     <div className={className} data-component-name="AnalyticalTableNoData" role="gridcell">
       {noDataText}

packages/main/src/components/AnalyticalTable/index.tsx

@@ -24,6 +24,7 @@ import {
   useSortBy,
   useTable,
 } from 'react-table';
+import { AnalyticalTableNoDataReason } from '../../enums/AnalyticalTableNoDataReason.js';
 import { AnalyticalTablePopinDisplay } from '../../enums/AnalyticalTablePopinDisplay.js';
 import { AnalyticalTableScaleWidthMode } from '../../enums/AnalyticalTableScaleWidthMode.js';
 import { AnalyticalTableSelectionBehavior } from '../../enums/AnalyticalTableSelectionBehavior.js';
@@ -85,9 +86,9 @@ import type {
   AnalyticalTableDomRef,
   AnalyticalTablePropTypes,
   AnalyticalTableState,
+  CellInstance,
   DivWithCustomScrollProp,
   TableInstance,
-  CellInstance,
 } from './types/index.js';
 import {
   getCombinedElementsHeight,
@@ -325,8 +326,8 @@ const AnalyticalTable = forwardRef<AnalyticalTableDomRef, AnalyticalTablePropTyp
 
   const noDataTextI18n = i18nBundle.getText(LIST_NO_DATA);
   const noDataTextFiltered = i18nBundle.getText(NO_DATA_FILTERED);
-  const noDataTextLocal =
-    noDataText ?? (tableState.filters?.length > 0 || tableState.globalFilter ? noDataTextFiltered : noDataTextI18n);
+  const noDataFiltered = tableState.filters?.length > 0 || tableState.globalFilter;
+  const noDataTextLocal = noDataText ?? (noDataFiltered ? noDataTextFiltered : noDataTextI18n);
 
   const [componentRef, analyticalTableRef] = useSyncRef<AnalyticalTableDomRef>(ref);
   const [cbRef, scrollToRef] = useScrollToRef(componentRef, dispatch);
@@ -844,7 +845,13 @@ const AnalyticalTable = forwardRef<AnalyticalTableDomRef, AnalyticalTablePropTyp
                     pleaseWaitText={i18nBundle.getText(PLEASE_WAIT)}
                   />
                 ) : (
-                  <NoDataComponent noDataText={noDataTextLocal} className={classNames.noData} />
+                  <NoDataComponent
+                    noDataText={noDataTextLocal}
+                    className={classNames.noData}
+                    noDataReason={
+                      noDataFiltered ? AnalyticalTableNoDataReason.Filtered : AnalyticalTableNoDataReason.Empty
+                    }
+                  />
                 )}
               </div>
             )}

packages/main/src/components/AnalyticalTable/types/index.ts

@@ -10,6 +10,7 @@ import type {
   RefObject,
   SetStateAction,
 } from 'react';
+import type { AnalyticalTableNoDataReason } from '../../../enums/AnalyticalTableNoDataReason.js';
 import type { AnalyticalTablePopinDisplay } from '../../../enums/AnalyticalTablePopinDisplay.js';
 import type { AnalyticalTableScaleWidthMode } from '../../../enums/AnalyticalTableScaleWidthMode.js';
 import type { AnalyticalTableScrollMode } from '../../../enums/AnalyticalTableScrollMode.js';
@@ -1040,7 +1041,11 @@ export interface AnalyticalTablePropTypes extends Omit<CommonProps, 'title'> {
    *
    * @default DefaultNoDataComponent
    */
-  NoDataComponent?: ComponentType<any>;
+  NoDataComponent?: ComponentType<{
+    noDataText: string;
+    className: string;
+    noDataReason: AnalyticalTableNoDataReason | keyof typeof AnalyticalTableNoDataReason;
+  }>;
 
   /**
    * Exposes the internal table instance.

packages/main/src/enums/AnalyticalTableNoDataReason.ts

@@ -0,0 +1,13 @@
+/**
+ * Different reasons why the `NoDataComponent` is displayed.
+ */
+export enum AnalyticalTableNoDataReason {
+  /*
+   * No data was passed to the table.
+   */
+  Empty = 'Empty',
+  /*
+   * No results match the applied filters.
+   */
+  Filtered = 'Filtered',
+}