@portaljs/components improvements (#933)

* [#912,@portaljs/components][s]: create LoadingSpinner component and add that to <Table /> when using the URL parameter

* [#912,@portaljs/components][m]: refactor LineChart and add more params

* [#912,@portaljs/components][m]: possibly fixes 'loading...' size on FlatUiTable on Firefox

* [@portaljs/components][xs]: add storybook-static to .gitignore

* Add changeset

.changeset/funny-dolls-bathe.md

@@ -0,0 +1,5 @@
+---
+'@portaljs/components': patch
+---
+
+More params added to <LineChart />, loading spinners added to <Table /> and <LineChart />, minor fixes

packages/components/.gitignore

@@ -9,6 +9,7 @@ lerna-debug.log*
 
 node_modules
 dist
+storybook-static
 dist-ssr
 *.local
 

packages/components/.storybook/preview.ts

@@ -1,4 +1,5 @@
 import 'tailwindcss/tailwind.css'
+import '../src/index.css'
 
 import type { Preview } from '@storybook/react';
 

packages/components/src/components/FlatUiTable.tsx

@@ -1,12 +1,13 @@
 import { QueryClient, QueryClientProvider, useQuery } from 'react-query';
 import Papa from 'papaparse';
 import { Grid } from '@githubocto/flat-ui';
+import LoadingSpinner from './LoadingSpinner';
 
 const queryClient = new QueryClient();
 
 export async function getCsv(url: string, corsProxy?: string) {
   if (corsProxy) {
-    url = corsProxy + url
+    url = corsProxy + url;
   }
   const response = await fetch(url, {
     headers: {
@@ -36,30 +37,6 @@ export async function parseCsv(file: string): Promise<any> {
   });
 }
 
-const Spinning = () => {
-  return (
-    <div role="status w-fit mx-auto">
-      <svg
-        aria-hidden="true"
-        className="w-8 h-8 mr-2 text-gray-200 animate-spin dark:text-gray-600 fill-emerald-600"
-        viewBox="0 0 100 101"
-        fill="none"
-        xmlns="http://www.w3.org/2000/svg"
-      >
-        <path
-          d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z"
-          fill="currentColor"
-        />
-        <path
-          d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z"
-          fill="currentFill"
-        />
-      </svg>
-      <span className="sr-only">Loading...</span>
-    </div>
-  );
-};
-
 export interface FlatUiTableProps {
   url?: string;
   data?: { [key: string]: number | string }[];
@@ -80,10 +57,15 @@ export const FlatUiTable: React.FC<FlatUiTableProps> = ({
   );
 };
 
-const TableInner: React.FC<FlatUiTableProps> = ({ url, data, rawCsv, corsProxy }) => {
+const TableInner: React.FC<FlatUiTableProps> = ({
+  url,
+  data,
+  rawCsv,
+  corsProxy,
+}) => {
   if (data) {
     return (
-      <div className="w-full" style={{height: '500px'}}>
+      <div className="w-full" style={{ height: '500px' }}>
         <Grid data={data} />
       </div>
     );
@@ -95,19 +77,22 @@ const TableInner: React.FC<FlatUiTableProps> = ({ url, data, rawCsv, corsProxy }
   );
   const { data: parsedData, isLoading: isParsing } = useQuery(
     ['dataPreview', csvString],
-    () => parseCsv(rawCsv ? rawCsv as string : csvString as string),
+    () => parseCsv(rawCsv ? (rawCsv as string) : (csvString as string)),
     { enabled: rawCsv ? true : !!csvString }
   );
   if (isParsing || isDownloadingCSV)
-    <div className="w-full">
-      <Spinning />
+    <div className="w-full flex justify-center items-center h-[500px]">
+      <LoadingSpinner />
     </div>;
   if (parsedData)
     return (
-      <div className="w-full" style={{height: '500px'}}>
+      <div className="w-full" style={{ height: '500px' }}>
         <Grid data={parsedData.data} />
       </div>
     );
-  return <Spinning />
+  return (
+    <div className="w-full flex justify-center items-center h-[500px]">
+      <LoadingSpinner />
+    </div>
+  );
 };
-

packages/components/src/components/LineChart.tsx

@@ -1,10 +1,19 @@
+import { useEffect, useState } from 'react';
+import LoadingSpinner from './LoadingSpinner';
 import { VegaLite } from './VegaLite';
+import loadData from '../lib/loadData';
+
+type AxisType = 'quantitative' | 'temporal';
+type TimeUnit = 'year' | undefined; // or ...
 
 export type LineChartProps = {
   data: Array<Array<string | number>> | string | { x: string; y: number }[];
   title?: string;
   xAxis?: string;
+  xAxisType?: AxisType;
+  xAxisTimeUnit: TimeUnit;
   yAxis?: string;
+  yAxisType?: AxisType;
   fullWidth?: boolean;
 };
 
@@ -13,15 +22,16 @@ export function LineChart({
   fullWidth = false,
   title = '',
   xAxis = 'x',
+  xAxisType = 'temporal',
+  xAxisTimeUnit = 'year', //  TODO: defaults to undefined would probably work better... keeping it as it's for compatibility purposes
   yAxis = 'y',
+  yAxisType = 'quantitative',
 }: LineChartProps) {
-  var tmp = data;
-  if (Array.isArray(data)) {
-    tmp = data.map((r) => {
-      return { x: r[0], y: r[1] };
-    });
-  }
-  const vegaData = { table: tmp };
+  const [isLoading, setIsLoading] = useState<boolean>(false);
+
+  //  By default, assumes data is an Array...
+  const [specData, setSpecData] = useState<any>({ name: 'table' });
+
   const spec = {
     $schema: 'https://vega.github.io/schema/vega-lite/v5.json',
     title,
@@ -33,9 +43,7 @@ export function LineChart({
       strokeWidth: 1,
       tooltip: true,
     },
-    data: {
-      name: 'table',
-    },
+    data: specData,
     selection: {
       grid: {
         type: 'interval',
@@ -45,19 +53,44 @@ export function LineChart({
     encoding: {
       x: {
         field: xAxis,
-        timeUnit: 'year',
-        type: 'temporal',
+        timeUnit: xAxisTimeUnit,
+        type: xAxisType,
       },
       y: {
         field: yAxis,
-        type: 'quantitative',
+        type: yAxisType,
       },
     },
-  };
-  if (typeof data === 'string') {
-    spec.data = { url: data } as any;
-    return <VegaLite fullWidth={fullWidth} spec={spec} />;
+  } as any;
+
+  useEffect(() => {
+    //  If data is string, assume it's a URL
+    if (typeof data === 'string') {
+      setIsLoading(true);
+
+      //  Manualy loading the data allows us to do other kinds
+      //  of stuff later e.g. load a file partially
+      loadData(data).then((res: any) => {
+        setSpecData({ values: res, format: { type: 'csv' } });
+        setIsLoading(false);
+      });
+    }
+  }, []);
+
+  var vegaData = {};
+  if (Array.isArray(data)) {
+    var dataObj;
+    dataObj = data.map((r) => {
+      return { x: r[0], y: r[1] };
+    });
+    vegaData = { table: dataObj };
   }
 
-  return <VegaLite fullWidth={fullWidth} data={vegaData} spec={spec} />;
+  return isLoading ? (
+    <div className="w-full flex items-center justify-center w-[600px] h-[300px]">
+      <LoadingSpinner />
+    </div>
+  ) : (
+    <VegaLite fullWidth={fullWidth} data={vegaData} spec={spec} />
+  );
 }

packages/components/src/components/LoadingSpinner.tsx

@@ -0,0 +1,23 @@
+export default function LoadingSpinner() {
+  return (
+    <div role="status w-fit mx-auto">
+      <svg
+        aria-hidden="true"
+        className="w-16 h-16 mr-2 text-gray-200 animate-spin dark:text-gray-600 fill-slate-600"
+        viewBox="0 0 100 101"
+        fill="none"
+        xmlns="http://www.w3.org/2000/svg"
+      >
+        <path
+          d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z"
+          fill="currentColor"
+        />
+        <path
+          d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z"
+          fill="currentFill"
+        />
+      </svg>
+      <span className="sr-only">Loading...</span>
+    </div>
+  );
+}

packages/components/src/components/Table.tsx

@@ -23,6 +23,7 @@ import React, { useEffect, useMemo, useState } from 'react';
 import parseCsv from '../lib/parseCsv';
 import DebouncedInput from './DebouncedInput';
 import loadData from '../lib/loadData';
+import LoadingSpinner from './LoadingSpinner';
 
 export type TableProps = {
   data?: Array<{ [key: string]: number | string }>;
@@ -39,6 +40,8 @@ export const Table = ({
   url = '',
   fullWidth = false,
 }: TableProps) => {
+  const [isLoading, setIsLoading] = useState<boolean>(false);
+
   if (csv) {
     const out = parseCsv(csv);
     ogData = out.rows;
@@ -77,15 +80,22 @@ export const Table = ({
 
   useEffect(() => {
     if (url) {
+      setIsLoading(true);
+      //  TODO: exception handling. What if the file doesn't exist? What if fetching was not possible?
       loadData(url).then((data) => {
         const { rows, fields } = parseCsv(data);
         setData(rows);
         setCols(fields);
+        setIsLoading(false);
       });
     }
   }, [url]);
 
-  return (
+  return isLoading ? (
+    <div className="w-full h-full min-h-[500px] flex items-center justify-center">
+      <LoadingSpinner />
+    </div>
+  ) : (
     <div className={`${fullWidth ? 'w-[90vw] ml-[calc(50%-45vw)]' : 'w-full'}`}>
       <DebouncedInput
         value={globalFilter ?? ''}

packages/components/src/index.css

@@ -1,3 +1,10 @@
 @tailwind base;
 @tailwind components;
-@tailwind utilities;
+@tailwind utilities;
+
+/* Temporary fix for a size issue with FlatUiTable loading indicator on Firefox */
+@layer base {
+  svg[tw^='animate-pulse w-12'] {
+    max-width: 100px;
+  }
+}

packages/components/stories/LineChart.stories.ts

@@ -19,10 +19,19 @@ const meta: Meta = {
       description:
         'Name of the X axis on the data. Required when the "data" parameter is an URL.',
     },
+    xAxisType: {
+      description: 'Type of the X axis',
+    },
+    xAxisTimeUnit: {
+      description: 'Time unit of the X axis (optional)',
+    },
     yAxis: {
       description:
         'Name of the Y axis on the data. Required when the "data" parameter is an URL.',
     },
+    yAxisType: {
+      description: 'Type of the Y axis',
+    },
     fullWidth: {
       description:
         'Whether the component should be rendered as full bleed or not',