@absreim/react-bootstrap-data-grid 0.1.3 → 0.1.4

package/ColHeaderCell.d.ts

@@ -0,0 +1,8 @@
+import { FC } from "react";
+import { ColSortModel } from "./types";
+interface ColHeaderCellProps {
+    label: string;
+    sortModel?: ColSortModel;
+}
+declare const ColHeaderCell: FC<ColHeaderCellProps>;
+export default ColHeaderCell;

package/ColHeaderCell.jsx

@@ -0,0 +1,75 @@
+"use client";
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+import { useState } from "react";
+import classNames from "classnames";
+var getUpArrow = function (addlClasses) { return (<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" className={classNames(__spreadArray(["bi", "bi-arrow-up"], (addlClasses || []), true))} viewBox="0 0 16 16">
+    <path fillRule="evenodd" d="M8 15a.5.5 0 0 0 .5-.5V2.707l3.146 3.147a.5.5 0 0 0 .708-.708l-4-4a.5.5 0 0 0-.708 0l-4 4a.5.5 0 1 0 .708.708L7.5 2.707V14.5a.5.5 0 0 0 .5.5"/>
+  </svg>); };
+var downArrow = (<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" className="bi bi-arrow-down" viewBox="0 0 16 16">
+    <path fillRule="evenodd" d="M8 1a.5.5 0 0 1 .5.5v11.793l3.146-3.147a.5.5 0 0 1 .708.708l-4 4a.5.5 0 0 1-.708 0l-4-4a.5.5 0 0 1 .708-.708L7.5 13.293V1.5A.5.5 0 0 1 8 1"/>
+  </svg>);
+// Temporary solution to prevent column widths from changing when hovering over
+// columns with a mouse.
+// More ideal permanent solution would be to fix column widths based on preset
+// values.
+var placeholder = (<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" className="bi bi-arrow-down" viewBox="0 0 16 16"></svg>);
+var ColHeaderCell = function (_a) {
+    var label = _a.label, sortModel = _a.sortModel;
+    var _b = useState(false), isHovering = _b[0], setIsHovering = _b[1];
+    var handleMouseOver = function () {
+        return setIsHovering(true);
+    };
+    var handleMouseOut = function () {
+        return setIsHovering(false);
+    };
+    var handleClick = function () {
+        if (!sortModel) {
+            return;
+        }
+        switch (sortModel.sortOrder) {
+            case null: {
+                sortModel.setSortOrder("asc");
+                return;
+            }
+            case "asc": {
+                sortModel.setSortOrder("desc");
+                return;
+            }
+            case "desc": {
+                sortModel.setSortOrder(null);
+            }
+        }
+    };
+    var getSortSymbol = function () {
+        if (!sortModel) {
+            return null;
+        }
+        switch (sortModel.sortOrder) {
+            case null: {
+                if (isHovering) {
+                    return getUpArrow(["text-body-secondary"]);
+                }
+                return placeholder;
+            }
+            case "asc": {
+                return getUpArrow();
+            }
+            case "desc": {
+                return downArrow;
+            }
+        }
+    };
+    return (<th onClick={sortModel && handleClick} onMouseOver={handleMouseOver} onMouseOut={handleMouseOut} aria-description="Column header that can be clicked to change the sorting mode" style={{ cursor: "pointer " }}>
+      {label}
+      {getSortSymbol()}
+    </th>);
+};
+export default ColHeaderCell;

package/Grid.d.ts

@@ -1,5 +1,5 @@
 import { FC } from "react";
-import { ColDef, RowDef, Size } from "./types";
+import { ColDef, RowDef, Size, TableSortModel } from "./types";
 export interface GridPaginationState {
     pageSizeOptions: number[];
     pageSizeIndex: number;
@@ -13,6 +13,7 @@ export interface GridProps {
     rows: RowDef[];
     cols: ColDef[];
     pagination?: GridPaginationState;
+    sortModel?: TableSortModel;
 }
 declare const Grid: FC<GridProps>;
 export default Grid;

package/Grid.jsx

@@ -2,18 +2,63 @@
 import { useMemo } from "react";
 import Pagination from "./Pagination";
 import classNames from "classnames";
+import ColHeaderCell from "./ColHeaderCell";
+var getTypeComparator = function (typeStr) {
+    if (typeStr === "date" || typeStr === "datetime") {
+        return function (a, b) { return a.valueOf() - b.valueOf(); };
+    }
+    if (typeStr === "number") {
+        return function (a, b) { return a - b; };
+    }
+    return function (a, b) {
+        if (a < b) {
+            return -1;
+        }
+        if (a > b) {
+            return 1;
+        }
+        return 0;
+    };
+};
+var getRowComparator = function (comparator, fieldName) {
+    return function (rowA, rowB) { return comparator(rowA[fieldName], rowB[fieldName]); };
+};
 var Grid = function (_a) {
-    var rows = _a.rows, cols = _a.cols, pagination = _a.pagination;
+    var rows = _a.rows, cols = _a.cols, pagination = _a.pagination, sortModel = _a.sortModel;
+    var sortedRows = useMemo(function () {
+        if (!sortModel || !sortModel.sortColDef) {
+            return rows;
+        }
+        var sortFieldName = sortModel.sortColDef.name;
+        var sortOrder = sortModel.sortColDef.order;
+        var sortColIndex = cols.findIndex(function (_a) {
+            var name = _a.name;
+            return name === sortFieldName;
+        });
+        if (sortColIndex < 0) {
+            throw new Error("The sortModel for the grid specifies that the data should be sorted based on a column named ".concat(sortFieldName, ", but it was not found among the column definitions."));
+        }
+        var typeStr = cols[sortColIndex].type;
+        var ascComparator = getTypeComparator(typeStr);
+        var rowComparator = getRowComparator(ascComparator, sortFieldName);
+        if (sortOrder === "desc") {
+            var descComparator = function (a, b) {
+                return ascComparator(a, b) * -1;
+            };
+            rowComparator = getRowComparator(descComparator, sortFieldName);
+        }
+        return rows.slice().sort(rowComparator);
+    }, [rows, cols, sortModel]);
     var currentPageRows = useMemo(function () {
         if (pagination === undefined) {
-            return rows;
+            return sortedRows;
         }
         var pageSizeOptions = pagination.pageSizeOptions, pageSizeIndex = pagination.pageSizeIndex, currentPage = pagination.currentPage;
         var pageSize = pageSizeOptions[pageSizeIndex];
         var lowerIndex = pageSize * (currentPage - 1);
         var upperIndex = lowerIndex + pageSize;
-        return rows.slice(lowerIndex, upperIndex);
-    }, [rows, pagination]);
+        return sortedRows.slice(lowerIndex, upperIndex);
+    }, [sortedRows, pagination]);
     var displayRows = useMemo(function () {
         var nameToIndex = new Map();
         cols.forEach(function (_a, index) {
@@ -28,13 +73,13 @@ var Grid = function (_a) {
             })
                 .forEach(function (name) {
                 if (!(name in row)) {
-                    throw new Error("Column definition specifies a property named \"".concat(name, "\",\n              but it was no found in the row data object at index ").concat(index));
+                    throw new Error("Column definition specifies a property named \"".concat(name, "\", but it was not found in the row data object at index ").concat(index, "."));
                 }
             });
             var displayRow = [];
             Object.keys(row).forEach(function (name) {
                 if (!nameToIndex.has(name)) {
-                    throw new Error("Row data contains a property named \"".concat(name, "\",\n          but it was not found among the column definitions"));
+                    throw new Error("Row data contains a property named \"".concat(name, "\", but it was not found among the column definitions."));
                 }
                 var index = nameToIndex.get(name);
                 var formatter = cols[index].formatter;
@@ -82,8 +127,19 @@ var Grid = function (_a) {
         <thead>
           <tr>
             {cols.map(function (_a) {
-            var name = _a.name, label = _a.label;
-            return (<th key={name}>{label}</th>);
+            var _b;
+            var name = _a.name, label = _a.label, sortable = _a.sortable;
+            var colSortModel = sortModel && sortable
+                ? {
+                    sortOrder: ((_b = sortModel.sortColDef) === null || _b === void 0 ? void 0 : _b.name) === name
+                        ? sortModel.sortColDef.order
+                        : null,
+                    setSortOrder: function (order) {
+                        sortModel.setSortColDef(order && { name: name, order: order });
+                    },
+                }
+                : undefined;
+            return (<ColHeaderCell key={name} label={label} sortModel={colSortModel}/>);
         })}
           </tr>
         </thead>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@absreim/react-bootstrap-data-grid",
   "description": "Data grid UI component for use with web apps using React and Bootstrap",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "license": "MIT",
   "author": "Brook Li",
   "homepage": "https://react-bootstrap-data-grid.vercel.app/",
@@ -25,7 +25,7 @@
   "types": "./index.d.ts",
   "repository": {
     "type": "git",
-    "url": "https://github.com/absreim/react-bootstrap-data-grid.git",
+    "url": "git+https://github.com/absreim/react-bootstrap-data-grid.git",
     "directory": "src/grid"
   }
-}
+}

package/types.d.ts

@@ -5,7 +5,21 @@ export interface ColDef {
     name: string;
     label: string;
     formatter?: (value: any) => string;
+    sortable?: boolean;
 }
 export type RowDef = Record<string, ColDataType>;
 export type JustifyContentSetting = "start" | "end" | "center" | "between" | "around" | "evenly";
 export type Size = "small" | "medium" | "large";
+export type SortOrder = "asc" | "desc";
+export interface SortColDef {
+    name: string;
+    order: SortOrder;
+}
+export interface ColSortModel {
+    sortOrder: SortOrder | null;
+    setSortOrder: (order: SortOrder | null) => void;
+}
+export interface TableSortModel {
+    sortColDef: SortColDef | null;
+    setSortColDef: (sortColDef: SortColDef | null) => void;
+}