@hpcc-js/dgrid2 2.5.3 → 2.5.5

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hpcc-js/dgrid2",
-    "version": "2.5.3",
+    "version": "2.5.5",
     "description": "hpcc-js - DGrid2",
     "main": "dist/index.js",
     "module": "dist/index.es6",
@@ -39,8 +39,8 @@
         "update": "npx --yes npm-check-updates -u -t minor"
     },
     "dependencies": {
-        "@hpcc-js/common": "^2.73.3",
-        "@hpcc-js/preact-shim": "^2.19.1",
+        "@hpcc-js/common": "^2.73.5",
+        "@hpcc-js/preact-shim": "^2.19.2",
         "@hpcc-js/util": "^2.53.3"
     },
     "devDependencies": {
@@ -59,5 +59,5 @@
         "url": "https://github.com/hpcc-systems/Visualization/issues"
     },
     "homepage": "https://github.com/hpcc-systems/Visualization",
-    "gitHead": "0907b8d15d369c89483954a1d96e2247ba020cb6"
+    "gitHead": "e9d09185b7cd29dce187ab524d6f03ad0e6abd0e"
 }

package/src/__package__.ts

@@ -1,3 +1,3 @@
-export const PKG_NAME = "@hpcc-js/dgrid2";
-export const PKG_VERSION = "2.5.2";
-export const BUILD_VERSION = "2.108.6";
+export const PKG_NAME = "@hpcc-js/dgrid2";
+export const PKG_VERSION = "2.5.5";
+export const BUILD_VERSION = "2.108.10";

package/src/hooks.ts

@@ -1,12 +1,12 @@
-import { Widget } from "@hpcc-js/common";
-import * as React from "react";
-
-export function useData(widget: Widget): [string[], Array<string | number>[]] {
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    const columns: string[] = React.useMemo(() => widget.columns(), [widget, widget.dataChecksum()]);
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    const data: Array<string | number>[] = React.useMemo(() => widget.data(), [widget, widget.dataChecksum()]);
-
-    return [columns, data];
-}
-
+import { Widget } from "@hpcc-js/common";
+import * as React from "react";
+
+export function useData(widget: Widget): [string[], Array<string | number>[]] {
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    const columns: string[] = React.useMemo(() => widget.columns(), [widget, widget.dataChecksum()]);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    const data: Array<string | number>[] = React.useMemo(() => widget.data(), [widget, widget.dataChecksum()]);
+
+    return [columns, data];
+}
+

package/src/index.ts

@@ -1,2 +1,2 @@
-export * from "./__package__";
-export * from "./table";
+export * from "./__package__";
+export * from "./table";

package/src/reactTable.tsx

@@ -1,159 +1,159 @@
-import * as React from "react";
-import DataGrid, { Column, SelectColumn, SortColumn } from "react-data-grid";
-import { format, timeFormat, timeParse } from "@hpcc-js/common";
-import { useData } from "./hooks";
-import type { Table } from "./table";
-
-export type QuerySortItem = { attribute: string, descending: boolean };
-function copyAndSort<T>(items: T[], attribute: string, descending?: boolean): T[] {
-    const key = attribute as keyof T;
-    return [...items].sort((a: T, b: T) => {
-        if (a[key] < b[key]) {
-            return descending ? 1 : -1;
-        } else if (a[key] > b[key]) {
-            return descending ? -1 : 1;
-        }
-        return 0;
-    });
-}
-
-interface EmptyRowsRendererProps {
-    message: string
-}
-
-const EmptyRowsRenderer: React.FunctionComponent<EmptyRowsRendererProps> = ({
-    message
-}) => {
-
-    return <div style={{ textAlign: "center", gridColumn: "1/-1" }} >
-        {message}
-    </div>;
-};
-
-interface ColumnEx<TRow, TSummaryRow = unknown> extends Column<TRow, TSummaryRow> {
-    renderCell?: (props: any) => React.JSX.Element;
-    __hpcc_pattern?: ReturnType<typeof timeParse>;
-    __hpcc_format?: ReturnType<typeof format> | ReturnType<typeof timeFormat>;
-}
-
-export interface ReactTableProps {
-    table: Table;
-    sort?: QuerySortItem,
-}
-
-export const ReactTable: React.FunctionComponent<ReactTableProps> = ({
-    table,
-    sort
-}) => {
-    const [columns, data] = useData(table);
-    const multiSelect = table.multiSelect();
-    const columnTypes = table.columnTypes();
-    const columnPatterns = table.columnPatterns();
-    const columnFormats = table.columnFormats();
-
-    const [listColumns, setListColumns] = React.useState<ColumnEx<any[]>[]>([]);
-    const [sortColumn, setSortColumn] = React.useState<SortColumn>();
-    const [rows, setRows] = React.useState<any[]>([]);
-    const [selectedRows, setSelectedRows] = React.useState<ReadonlySet<number>>(new Set());
-
-    //  Columns  ---
-    React.useEffect(() => {
-        setListColumns([
-            ...multiSelect ? [SelectColumn] : [],
-            ...columns.map((column): ColumnEx<any[]> => {
-                const type = columnTypes[column] ?? "string";
-                let formatter;
-                let __hpcc_pattern;
-                let __hpcc_format;
-                switch (type) {
-                    case "time":
-                        __hpcc_pattern = columnPatterns[column] !== undefined ? timeParse(columnPatterns[column]) : undefined;
-                        __hpcc_format = columnFormats[column] !== undefined ? timeFormat(columnFormats[column]) : undefined;
-                        break;
-                    case "number":
-                        formatter = (props) => {
-                            return <div style={{ textAlign: "right" }}>{props.row[props.column.key]}</div>;
-                        };
-                    // eslint-disable-next-line no-fallthrough
-                    default:
-                        __hpcc_format = columnFormats[column] !== undefined ? format(columnFormats[column]) : undefined;
-                }
-                return {
-                    key: column,
-                    name: column,
-                    resizable: true,
-                    sortable: true,
-                    minWidth: 80,
-                    renderCell: formatter,
-                    __hpcc_pattern,
-                    __hpcc_format
-                };
-            })
-        ]);
-    }, [columnFormats, columnPatterns, columnTypes, columns, multiSelect]);
-
-    const onSortColumnsChange = React.useCallback((sortColumns: SortColumn[]) => {
-        const futureSortColumn = sortColumns.slice(-1)[0];
-        const sorted = futureSortColumn !== undefined;
-        const isSortedDescending: boolean = futureSortColumn?.direction === "DESC";
-        setSortColumn(futureSortColumn);
-        setRows(copyAndSort(rows, sorted ? futureSortColumn.columnKey : "key", sorted ? isSortedDescending : false));
-    }, [rows]);
-
-    const rowKeyGetter = React.useCallback((row: any) => {
-        return row.key;
-    }, []);
-
-    const onSelectedRowsChange = React.useCallback((selectedRows: Set<any>) => {
-        setSelectedRows(selectedRows);
-    }, []);
-
-    const onCellClick = React.useCallback((row, column) => {
-        table.onRowClickCallback(row, column.key);
-    }, [table]);
-
-    //  Rows  ---
-    React.useEffect(() => {
-        let items = data.map((row, index) => {
-            const retVal = {
-                key: index
-            };
-            listColumns.forEach((column, index) => {
-                let val = row[index] as string;
-                if (column.__hpcc_pattern && column.__hpcc_format) {
-                    val = column.__hpcc_format(column.__hpcc_pattern(val));
-                } else if (column.__hpcc_pattern) {
-                    val = column.__hpcc_pattern(val).toString();
-                } else if (column.__hpcc_format) {
-                    val = column.__hpcc_format(val as any);
-                }
-                retVal[column.key] = val;
-            });
-            return retVal;
-        });
-        if (sort?.attribute) {
-            items = copyAndSort(items, sort.attribute, sort.descending);
-        }
-        setRows(items);
-    }, [listColumns, data, sort]);
-
-    return <DataGrid
-        columns={listColumns}
-        headerRowHeight={24}
-        rows={rows}
-        rowKeyGetter={rowKeyGetter}
-        rowHeight={20}
-        emptyRowsRenderer={() => <EmptyRowsRenderer message={table.noDataMessage()} />}
-        className={table.darkMode() ? "rdg-dark" : "rdg-light"}
-        sortColumns={sortColumn ? [sortColumn] : []}
-        onSortColumnsChange={onSortColumnsChange}
-        selectedRows={selectedRows}
-        onSelectedRowsChange={multiSelect ? onSelectedRowsChange : undefined}
-        onRowClick={multiSelect ? undefined : (rowIdx, row, column) => onCellClick(row, column)}
-        aria-describedby={""}
-        aria-label={""}
-        aria-labelledby={""}
-        style={{ height: "100%" }}
-    />;
-};
-
+import * as React from "react";
+import DataGrid, { Column, SelectColumn, SortColumn } from "react-data-grid";
+import { format, timeFormat, timeParse } from "@hpcc-js/common";
+import { useData } from "./hooks";
+import type { Table } from "./table";
+
+export type QuerySortItem = { attribute: string, descending: boolean };
+function copyAndSort<T>(items: T[], attribute: string, descending?: boolean): T[] {
+    const key = attribute as keyof T;
+    return [...items].sort((a: T, b: T) => {
+        if (a[key] < b[key]) {
+            return descending ? 1 : -1;
+        } else if (a[key] > b[key]) {
+            return descending ? -1 : 1;
+        }
+        return 0;
+    });
+}
+
+interface EmptyRowsRendererProps {
+    message: string
+}
+
+const EmptyRowsRenderer: React.FunctionComponent<EmptyRowsRendererProps> = ({
+    message
+}) => {
+
+    return <div style={{ textAlign: "center", gridColumn: "1/-1" }} >
+        {message}
+    </div>;
+};
+
+interface ColumnEx<TRow, TSummaryRow = unknown> extends Column<TRow, TSummaryRow> {
+    renderCell?: (props: any) => React.JSX.Element;
+    __hpcc_pattern?: ReturnType<typeof timeParse>;
+    __hpcc_format?: ReturnType<typeof format> | ReturnType<typeof timeFormat>;
+}
+
+export interface ReactTableProps {
+    table: Table;
+    sort?: QuerySortItem,
+}
+
+export const ReactTable: React.FunctionComponent<ReactTableProps> = ({
+    table,
+    sort
+}) => {
+    const [columns, data] = useData(table);
+    const multiSelect = table.multiSelect();
+    const columnTypes = table.columnTypes();
+    const columnPatterns = table.columnPatterns();
+    const columnFormats = table.columnFormats();
+
+    const [listColumns, setListColumns] = React.useState<ColumnEx<any[]>[]>([]);
+    const [sortColumn, setSortColumn] = React.useState<SortColumn>();
+    const [rows, setRows] = React.useState<any[]>([]);
+    const [selectedRows, setSelectedRows] = React.useState<ReadonlySet<number>>(new Set());
+
+    //  Columns  ---
+    React.useEffect(() => {
+        setListColumns([
+            ...multiSelect ? [SelectColumn] : [],
+            ...columns.map((column): ColumnEx<any[]> => {
+                const type = columnTypes[column] ?? "string";
+                let formatter;
+                let __hpcc_pattern;
+                let __hpcc_format;
+                switch (type) {
+                    case "time":
+                        __hpcc_pattern = columnPatterns[column] !== undefined ? timeParse(columnPatterns[column]) : undefined;
+                        __hpcc_format = columnFormats[column] !== undefined ? timeFormat(columnFormats[column]) : undefined;
+                        break;
+                    case "number":
+                        formatter = (props) => {
+                            return <div style={{ textAlign: "right" }}>{props.row[props.column.key]}</div>;
+                        };
+                    // eslint-disable-next-line no-fallthrough
+                    default:
+                        __hpcc_format = columnFormats[column] !== undefined ? format(columnFormats[column]) : undefined;
+                }
+                return {
+                    key: column,
+                    name: column,
+                    resizable: true,
+                    sortable: true,
+                    minWidth: 80,
+                    renderCell: formatter,
+                    __hpcc_pattern,
+                    __hpcc_format
+                };
+            })
+        ]);
+    }, [columnFormats, columnPatterns, columnTypes, columns, multiSelect]);
+
+    const onSortColumnsChange = React.useCallback((sortColumns: SortColumn[]) => {
+        const futureSortColumn = sortColumns.slice(-1)[0];
+        const sorted = futureSortColumn !== undefined;
+        const isSortedDescending: boolean = futureSortColumn?.direction === "DESC";
+        setSortColumn(futureSortColumn);
+        setRows(copyAndSort(rows, sorted ? futureSortColumn.columnKey : "key", sorted ? isSortedDescending : false));
+    }, [rows]);
+
+    const rowKeyGetter = React.useCallback((row: any) => {
+        return row.key;
+    }, []);
+
+    const onSelectedRowsChange = React.useCallback((selectedRows: Set<any>) => {
+        setSelectedRows(selectedRows);
+    }, []);
+
+    const onCellClick = React.useCallback((row, column) => {
+        table.onRowClickCallback(row, column.key);
+    }, [table]);
+
+    //  Rows  ---
+    React.useEffect(() => {
+        let items = data.map((row, index) => {
+            const retVal = {
+                key: index
+            };
+            listColumns.forEach((column, index) => {
+                let val = row[index] as string;
+                if (column.__hpcc_pattern && column.__hpcc_format) {
+                    val = column.__hpcc_format(column.__hpcc_pattern(val));
+                } else if (column.__hpcc_pattern) {
+                    val = column.__hpcc_pattern(val).toString();
+                } else if (column.__hpcc_format) {
+                    val = column.__hpcc_format(val as any);
+                }
+                retVal[column.key] = val;
+            });
+            return retVal;
+        });
+        if (sort?.attribute) {
+            items = copyAndSort(items, sort.attribute, sort.descending);
+        }
+        setRows(items);
+    }, [listColumns, data, sort]);
+
+    return <DataGrid
+        columns={listColumns}
+        headerRowHeight={24}
+        rows={rows}
+        rowKeyGetter={rowKeyGetter}
+        rowHeight={20}
+        emptyRowsRenderer={() => <EmptyRowsRenderer message={table.noDataMessage()} />}
+        className={table.darkMode() ? "rdg-dark" : "rdg-light"}
+        sortColumns={sortColumn ? [sortColumn] : []}
+        onSortColumnsChange={onSortColumnsChange}
+        selectedRows={selectedRows}
+        onSelectedRowsChange={multiSelect ? onSelectedRowsChange : undefined}
+        onRowClick={multiSelect ? undefined : (rowIdx, row, column) => onCellClick(row, column)}
+        aria-describedby={""}
+        aria-label={""}
+        aria-labelledby={""}
+        style={{ height: "100%" }}
+    />;
+};
+

package/src/table.css

@@ -1,10 +1,10 @@
-.dgrid2_Table .rdg {
-    font-family: monospace, 'Courier New', Courier;
-}
-
-.dgrid2_Table .rdg-checkbox-label .rdg-checkbox {
-    block-size: 16px;
-    inline-size: 16px;
-    border-width: 2px;
-    box-shadow: inset 0 0 0 3px var(--rdg-background-color);
+.dgrid2_Table .rdg {
+    font-family: monospace, 'Courier New', Courier;
+}
+
+.dgrid2_Table .rdg-checkbox-label .rdg-checkbox {
+    block-size: 16px;
+    inline-size: 16px;
+    border-width: 2px;
+    box-shadow: inset 0 0 0 3px var(--rdg-background-color);
 }

package/src/table.md

@@ -1,57 +1,57 @@
-# Table
-
-**Class**: `Table`
-
-<ClientOnly>
-  <hpcc-vitepress preview_border="0px" style="width:100%;height:600px">
-    <div id="placeholder" style="height:400px">
-    </div>
-    <script type="module">
-        import { Table } from "@hpcc-js/dgrid2";
-        
-        new Table()
-            .target("placeholder")
-            .columns(["Category", "Series-1", "Series-2", "Series-3", "Series-4"])
-            .data([
-                ["A", -25, -23, -25, -22],
-                ["B", -20, -21, -25, -21],
-                ["C", -18, -20, -25, -19],
-                ["D", -17, -17, -25, -18],
-                ["E", -16, -15, -19, -18],
-                ["F", -15, -14, -16, -16],
-                ["G", -12, -10, -14, -15],
-                ["H", -12, -8, -13, -15],
-                ["I", -11, -6, -12, -12],
-                ["J", -11, -6, -8, -12],
-                ["K", -9, 0, -5, -10],
-                ["L", -5, 1, -5, -9],
-                ["M", -5, 2, -4, -8],
-                ["N", -1, 4, -2, -7],
-                ["O", 3, 7, 0, -5],
-                ["P", 3, 8, 0, -3],
-                ["Q", 4, 8, 7, 0],
-                ["R", 6, 9, 11, 1],
-                ["S", 9, 11, 11, 5],
-                ["T", 10, 20, 12, 6],
-                ["U", 12, 20, 16, 8],
-                ["V", 12, 21, 18, 14],
-                ["W", 14, 21, 18, 18],
-                ["X", 15, 23, 21, 18],
-                ["Y", 21, 23, 23, 21],
-                ["Z", 23, 24, 24, 24]
-            ])
-            .render()
-            ;
-    </script>
-  </hpcc-vitepress>
-</ClientOnly>
-
-::: tip
-See [Getting Started](../README) for details on how to include @hpcc-js/dgrid2 in your application
-:::
-
-## `Table`
-
-## Events
-
-## Credits
+# Table
+
+**Class**: `Table`
+
+<ClientOnly>
+  <hpcc-vitepress preview_border="0px" style="width:100%;height:600px">
+    <div id="placeholder" style="height:400px">
+    </div>
+    <script type="module">
+        import { Table } from "@hpcc-js/dgrid2";
+        
+        new Table()
+            .target("placeholder")
+            .columns(["Category", "Series-1", "Series-2", "Series-3", "Series-4"])
+            .data([
+                ["A", -25, -23, -25, -22],
+                ["B", -20, -21, -25, -21],
+                ["C", -18, -20, -25, -19],
+                ["D", -17, -17, -25, -18],
+                ["E", -16, -15, -19, -18],
+                ["F", -15, -14, -16, -16],
+                ["G", -12, -10, -14, -15],
+                ["H", -12, -8, -13, -15],
+                ["I", -11, -6, -12, -12],
+                ["J", -11, -6, -8, -12],
+                ["K", -9, 0, -5, -10],
+                ["L", -5, 1, -5, -9],
+                ["M", -5, 2, -4, -8],
+                ["N", -1, 4, -2, -7],
+                ["O", 3, 7, 0, -5],
+                ["P", 3, 8, 0, -3],
+                ["Q", 4, 8, 7, 0],
+                ["R", 6, 9, 11, 1],
+                ["S", 9, 11, 11, 5],
+                ["T", 10, 20, 12, 6],
+                ["U", 12, 20, 16, 8],
+                ["V", 12, 21, 18, 14],
+                ["W", 14, 21, 18, 18],
+                ["X", 15, 23, 21, 18],
+                ["Y", 21, 23, 23, 21],
+                ["Z", 23, 24, 24, 24]
+            ])
+            .render()
+            ;
+    </script>
+  </hpcc-vitepress>
+</ClientOnly>
+
+::: tip
+See [Getting Started](../README) for details on how to include @hpcc-js/dgrid2 in your application
+:::
+
+## `Table`
+
+## Events
+
+## Credits