From 47782f4bfa5b2cb79f582542b3dff195880dbdbb Mon Sep 17 00:00:00 2001
From: Matthew Clarke <mclarke@spotify.com>
Date: Thu, 17 Aug 2023 09:46:03 -0400
Subject: [PATCH] feat: Table initial loading (#19343)

* feat: add initial loading state for Table

Signed-off-by: Matthew Clarke <mclarke@spotify.com>

* Please answer yes or no.
feat: add loading state for Table component

Signed-off-by: Matthew Clarke <mclarke@spotify.com>

* chore: changeset

Signed-off-by: Matthew Clarke <mclarke@spotify.com>

* test: add test

Signed-off-by: Matthew Clarke <mclarke@spotify.com>

* docs: api reports

Signed-off-by: Matthew Clarke <mclarke@spotify.com>

---------

Signed-off-by: Matthew Clarke <mclarke@spotify.com>
---
 .changeset/strange-frogs-count.md             |  5 +++
 packages/core-components/api-report.md        |  2 +
 .../src/components/Table/Table.stories.tsx    | 37 +++++++++++++++++++
 .../src/components/Table/Table.test.tsx       |  5 +++
 .../src/components/Table/Table.tsx            | 27 +++++++++++++-
 5 files changed, 75 insertions(+), 1 deletion(-)
 create mode 100644 .changeset/strange-frogs-count.md

diff --git a/.changeset/strange-frogs-count.md b/.changeset/strange-frogs-count.md
new file mode 100644
index 0000000000..94fa6b9fb6
--- /dev/null
+++ b/.changeset/strange-frogs-count.md
@@ -0,0 +1,5 @@
+---
+'@backstage/core-components': patch
+---
+
+Add loading indicator to Table
diff --git a/packages/core-components/api-report.md b/packages/core-components/api-report.md
index df34abdd03..cc9246c752 100644
--- a/packages/core-components/api-report.md
+++ b/packages/core-components/api-report.md
@@ -1356,6 +1356,8 @@ export interface TableProps<T extends object = {}>
   // (undocumented)
   initialState?: TableState;
   // (undocumented)
+  isLoading?: boolean;
+  // (undocumented)
   onStateChange?: (state: TableState) => any;
   // (undocumented)
   subtitle?: string;
diff --git a/packages/core-components/src/components/Table/Table.stories.tsx b/packages/core-components/src/components/Table/Table.stories.tsx
index 807d58057d..b38941012c 100644
--- a/packages/core-components/src/components/Table/Table.stories.tsx
+++ b/packages/core-components/src/components/Table/Table.stories.tsx
@@ -89,6 +89,43 @@ export const DefaultTable = () => {
   );
 };
 
+export const LoadingTable = () => {
+  const classes = useStyles();
+  const columns: TableColumn[] = [
+    {
+      title: 'Column 1',
+      field: 'col1',
+      highlight: true,
+    },
+    {
+      title: 'Column 2',
+      field: 'col2',
+    },
+    {
+      title: 'Numeric value',
+      field: 'number',
+      type: 'numeric',
+    },
+    {
+      title: 'A Date',
+      field: 'date',
+      type: 'date',
+    },
+  ];
+
+  return (
+    <div className={classes.container}>
+      <Table
+        options={{ paging: false }}
+        data={[]}
+        columns={columns}
+        isLoading
+        title="Backstage Table"
+      />
+    </div>
+  );
+};
+
 export const EmptyTable = () => {
   const classes = useStyles();
   const columns: TableColumn[] = [
diff --git a/packages/core-components/src/components/Table/Table.test.tsx b/packages/core-components/src/components/Table/Table.test.tsx
index ffdca26d98..43c8cfe41d 100644
--- a/packages/core-components/src/components/Table/Table.test.tsx
+++ b/packages/core-components/src/components/Table/Table.test.tsx
@@ -48,6 +48,11 @@ describe('<Table />', () => {
     expect(rendered.getByText('second value, second row')).toBeInTheDocument();
   });
 
+  it('renders loading without exploding', async () => {
+    const rendered = await renderInTestApp(<Table {...minProps} isLoading />);
+    expect(rendered.getByTestId('loading-indicator')).toBeInTheDocument();
+  });
+
   describe('with style rows', () => {
     describe('with CSS Properties object', () => {
       const styledColumn2 = {
diff --git a/packages/core-components/src/components/Table/Table.tsx b/packages/core-components/src/components/Table/Table.tsx
index 5cea3dd6b6..9f2b04c214 100644
--- a/packages/core-components/src/components/Table/Table.tsx
+++ b/packages/core-components/src/components/Table/Table.tsx
@@ -53,6 +53,7 @@ import React, {
 
 import { SelectProps } from '../Select/Select';
 import { Filter, Filters, SelectedFilters, Without } from './Filters';
+import CircularProgress from '@material-ui/core/CircularProgress';
 
 // Material-table is not using the standard icons available in in material-ui. https://github.com/mbrn/material-table/issues/51
 const tableIcons: Icons = {
@@ -236,6 +237,7 @@ export interface TableProps<T extends object = {}>
   filters?: TableFilter[];
   initialState?: TableState;
   emptyContent?: ReactNode;
+  isLoading?: boolean;
   onStateChange?: (state: TableState) => any;
 }
 
@@ -309,6 +311,7 @@ export function Table<T extends object = {}>(props: TableProps<T>) {
     emptyContent,
     onStateChange,
     components,
+    isLoading: isLoading,
     ...restProps
   } = props;
   const tableClasses = useTableStyles();
@@ -470,6 +473,28 @@ export function Table<T extends object = {}>(props: TableProps<T>) {
   const columnCount = columns.length;
   const Body = useCallback(
     bodyProps => {
+      if (isLoading) {
+        return (
+          <tbody data-testid="loading-indicator">
+            <tr>
+              <td colSpan={columnCount}>
+                <Box
+                  sx={{
+                    display: 'flex',
+                    justifyContent: 'center',
+                    alignItems: 'center',
+                    width: '100%',
+                    minHeight: '15rem',
+                  }}
+                >
+                  <CircularProgress size="5rem" />
+                </Box>
+              </td>
+            </tr>
+          </tbody>
+        );
+      }
+
       if (emptyContent && hasNoRows) {
         return (
           <tbody>
@@ -482,7 +507,7 @@ export function Table<T extends object = {}>(props: TableProps<T>) {
 
       return <MTableBody {...bodyProps} />;
     },
-    [hasNoRows, emptyContent, columnCount],
+    [hasNoRows, emptyContent, columnCount, isLoading],
   );
 
   return (