src/components/data-table/data-table.tsx

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import React from "react";
   6 import {
   7     Table,
   8     TableBody,
   9     TableRow,
  10     TableCell,
  11     TableHead,
  12     TableSortLabel,
  13     StyleRulesCallback,
  14     Theme,
  15     WithStyles,
  16     withStyles,
  17     IconButton,
  18     Tooltip,
  19 } from "@material-ui/core";
  20 import classnames from "classnames";
  21 import { DataColumn, SortDirection } from "./data-column";
  22 import { DataTableDefaultView } from "../data-table-default-view/data-table-default-view";
  23 import { DataTableFilters } from "../data-table-filters/data-table-filters-tree";
  24 import { DataTableMultiselectPopover } from "../data-table-multiselect-popover/data-table-multiselect-popover";
  25 import { DataTableFiltersPopover } from "../data-table-filters/data-table-filters-popover";
  26 import { countNodes, getTreeDirty } from "models/tree";
  27 import { IconType, PendingIcon } from "components/icon/icon";
  28 import { SvgIconProps } from "@material-ui/core/SvgIcon";
  29 import ArrowDownwardIcon from "@material-ui/icons/ArrowDownward";
  30 import { createTree } from "models/tree";
  31 import { DataTableMultiselectOption } from "../data-table-multiselect-popover/data-table-multiselect-popover";
  32
  33 export type DataColumns<I, R> = Array<DataColumn<I, R>>;
  34
  35 export enum DataTableFetchMode {
  36     PAGINATED,
  37     INFINITE,
  38 }
  39
  40 export interface DataTableDataProps<I> {
  41     items: I[];
  42     columns: DataColumns<I, any>;
  43     onRowClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
  44     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: I) => void;
  45     onRowDoubleClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
  46     onSortToggle: (column: DataColumn<I, any>) => void;
  47     onFiltersChange: (filters: DataTableFilters, column: DataColumn<I, any>) => void;
  48     extractKey?: (item: I) => React.Key;
  49     working?: boolean;
  50     defaultViewIcon?: IconType;
  51     defaultViewMessages?: string[];
  52     currentItemUuid?: string;
  53     currentRoute?: string;
  54     toggleMSToolbar: (isVisible: boolean) => void;
  55     setCheckedListOnStore: (checkedList: TCheckedList) => void;
  56     checkedList: TCheckedList;
  57 }
  58
  59 type CssRules =
  60     | "tableBody"
  61     | "root"
  62     | "content"
  63     | "noItemsInfo"
  64     | "checkBoxHead"
  65     | "checkBoxCell"
  66     | "checkBox"
  67     | "firstTableCell"
  68     | "tableCell"
  69     | "arrow"
  70     | "arrowButton"
  71     | "tableCellWorkflows"
  72     | "loader";
  73
  74 const styles: StyleRulesCallback<CssRules> = (theme: Theme) => ({
  75     root: {
  76         width: "100%",
  77     },
  78     content: {
  79         display: "inline-block",
  80         width: "100%",
  81     },
  82     tableBody: {
  83         background: theme.palette.background.paper,
  84     },
  85     loader: {
  86         left: "50%",
  87         marginLeft: "-84px",
  88         position: "absolute",
  89     },
  90     noItemsInfo: {
  91         textAlign: "center",
  92         padding: theme.spacing.unit,
  93     },
  94     checkBoxHead: {
  95         padding: "0",
  96         display: "flex",
  97     },
  98     checkBoxCell: {
  99         padding: "0",
 100         paddingLeft: "10px",
 101     },
 102     checkBox: {
 103         cursor: "pointer",
 104     },
 105     tableCell: {
 106         wordWrap: "break-word",
 107         paddingRight: "24px",
 108         color: "#737373",
 109     },
 110     firstTableCell: {
 111         paddingLeft: "5px",
 112     },
 113     tableCellWorkflows: {
 114         "&:nth-last-child(2)": {
 115             padding: "0px",
 116             maxWidth: "48px",
 117         },
 118         "&:last-child": {
 119             padding: "0px",
 120             paddingRight: "24px",
 121             width: "48px",
 122         },
 123     },
 124     arrow: {
 125         margin: 0,
 126     },
 127     arrowButton: {
 128         color: theme.palette.text.primary,
 129     },
 130 });
 131
 132 export type TCheckedList = Record<string, boolean>;
 133
 134 type DataTableState = {
 135     isSelected: boolean;
 136     checkedList: TCheckedList;
 137 };
 138
 139 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules>;
 140
 141 export const DataTable = withStyles(styles)(
 142     class Component<T> extends React.Component<DataTableProps<T>> {
 143         state: DataTableState = {
 144             isSelected: false,
 145             checkedList: this.props.checkedList,
 146         };
 147
 148         componentDidMount(): void {
 149             this.initializeCheckedList(this.props.items);
 150         }
 151
 152         componentDidUpdate(prevProps: Readonly<DataTableProps<T>>, prevState: DataTableState) {
 153             const { items, toggleMSToolbar, setCheckedListOnStore } = this.props;
 154             const { isSelected, checkedList } = this.state;
 155             if (prevProps.items !== items) {
 156                 if (isSelected === true) this.setState({ isSelected: false });
 157                 if (items.length) this.initializeCheckedList(items);
 158                 else this.setState({ checkedList: {} });
 159             }
 160             if (prevState.checkedList !== checkedList) {
 161                 toggleMSToolbar(this.isAnySelected() ? true : false);
 162                 setCheckedListOnStore(checkedList);
 163             }
 164         }
 165
 166         checkBoxColumn: DataColumn<any, any> = {
 167             name: "checkBoxColumn",
 168             selected: true,
 169             configurable: false,
 170             filters: createTree(),
 171             render: uuid => (
 172                 <input
 173                     type="checkbox"
 174                     name={uuid}
 175                     className={this.props.classes.checkBox}
 176                     checked={this.state.checkedList[uuid] ?? false}
 177                     onChange={() => this.handleSelectOne(uuid)}
 178                     onDoubleClick={ev => ev.stopPropagation()}></input>
 179             ),
 180         };
 181
 182         multiselectOptions: DataTableMultiselectOption[] = [
 183             { name: "All", fn: list => this.handleSelectAll(list) },
 184             { name: "None", fn: list => this.handleSelectNone(list) },
 185             { name: "Invert", fn: list => this.handleInvertSelect(list) },
 186         ];
 187
 188         initializeCheckedList = (uuids: any[]): void => {
 189             const newCheckedList = { ...this.state.checkedList };
 190
 191             uuids.forEach(uuid => {
 192                 if (!newCheckedList.hasOwnProperty(uuid)) {
 193                     newCheckedList[uuid] = false;
 194                 }
 195             });
 196             for (const key in newCheckedList) {
 197                 if (!uuids.includes(key)) {
 198                     delete newCheckedList[key];
 199                 }
 200             }
 201             this.setState({ checkedList: newCheckedList });
 202         };
 203
 204         updateCheckedList = (newList: TCheckedList): void => {
 205             this.setState({ checkedList: newList });
 206         };
 207
 208         isAllSelected = (list: TCheckedList): boolean => {
 209             for (const key in list) {
 210                 if (list[key] === false) return false;
 211             }
 212             return true;
 213         };
 214
 215         isAnySelected = (): boolean => {
 216             const { checkedList } = this.state;
 217             if (!Object.keys(checkedList).length) return false;
 218             for (const key in checkedList) {
 219                 if (checkedList[key] === true) return true;
 220             }
 221             return false;
 222         };
 223
 224         handleSelectOne = (uuid: string): void => {
 225             const { checkedList } = this.state;
 226             const newCheckedList = { ...checkedList };
 227             newCheckedList[uuid] = !checkedList[uuid];
 228             this.setState({ checkedList: newCheckedList, isSelected: this.isAllSelected(newCheckedList) });
 229         };
 230
 231         handleSelectorSelect = (): void => {
 232             const { checkedList } = this.state;
 233             const { isSelected } = this.state;
 234             isSelected ? this.handleSelectNone(checkedList) : this.handleSelectAll(checkedList);
 235         };
 236
 237         handleSelectAll = (list: TCheckedList): void => {
 238             if (Object.keys(list).length) {
 239                 const newCheckedList = { ...list };
 240                 for (const key in newCheckedList) {
 241                     newCheckedList[key] = true;
 242                 }
 243                 this.setState({ isSelected: true, checkedList: newCheckedList });
 244             }
 245         };
 246
 247         handleSelectNone = (list: TCheckedList): void => {
 248             const newCheckedList = { ...list };
 249             for (const key in newCheckedList) {
 250                 newCheckedList[key] = false;
 251             }
 252             this.setState({ isSelected: false, checkedList: newCheckedList });
 253         };
 254
 255         handleInvertSelect = (list: TCheckedList): void => {
 256             if (Object.keys(list).length) {
 257                 const newCheckedList = { ...list };
 258                 for (const key in newCheckedList) {
 259                     newCheckedList[key] = !list[key];
 260                 }
 261                 this.setState({ checkedList: newCheckedList, isSelected: this.isAllSelected(newCheckedList) });
 262             }
 263         };
 264
 265         render() {
 266             const { items, classes, working, columns } = this.props;
 267             if (columns[0].name === this.checkBoxColumn.name) columns.shift();
 268             columns.unshift(this.checkBoxColumn);
 269             return (
 270                 <div className={classes.root}>
 271                     <div className={classes.content}>
 272                         <Table>
 273                             <TableHead>
 274                                 <TableRow>{this.mapVisibleColumns(this.renderHeadCell)}</TableRow>
 275                             </TableHead>
 276                             <TableBody className={classes.tableBody}>{!working && items.map(this.renderBodyRow)}</TableBody>
 277                         </Table>
 278                         {!!working && (
 279                             <div className={classes.loader}>
 280                                 <DataTableDefaultView
 281                                     icon={PendingIcon}
 282                                     messages={["Loading data, please wait."]}
 283                                 />
 284                             </div>
 285                         )}
 286                         {items.length === 0 && !working && this.renderNoItemsPlaceholder(this.props.columns)}
 287                     </div>
 288                 </div>
 289             );
 290         }
 291
 292         renderNoItemsPlaceholder = (columns: DataColumns<T, any>) => {
 293             const dirty = columns.some(column => getTreeDirty("")(column.filters));
 294             return (
 295                 <DataTableDefaultView
 296                     icon={this.props.defaultViewIcon}
 297                     messages={this.props.defaultViewMessages}
 298                     filtersApplied={dirty}
 299                 />
 300             );
 301         };
 302
 303         renderHeadCell = (column: DataColumn<T, any>, index: number) => {
 304             const { name, key, renderHeader, filters, sort } = column;
 305             const { onSortToggle, onFiltersChange, classes } = this.props;
 306             const { isSelected, checkedList } = this.state;
 307             return column.name === "checkBoxColumn" ? (
 308                 <TableCell
 309                     key={key || index}
 310                     className={classes.checkBoxCell}>
 311                     <div className={classes.checkBoxHead}>
 312                         <Tooltip title={this.state.isSelected ? "Deselect All" : "Select All"}>
 313                             <input
 314                                 type="checkbox"
 315                                 className={classes.checkBox}
 316                                 checked={isSelected}
 317                                 disabled={!this.props.items.length}
 318                                 onChange={this.handleSelectorSelect}></input>
 319                         </Tooltip>
 320                         <DataTableMultiselectPopover
 321                             name={`Options`}
 322                             disabled={!this.props.items.length}
 323                             options={this.multiselectOptions}
 324                             checkedList={checkedList}></DataTableMultiselectPopover>
 325                     </div>
 326                 </TableCell>
 327             ) : (
 328                 <TableCell
 329                     className={index === 1 ? classes.firstTableCell : classes.tableCell}
 330                     key={key || index}>
 331                     {renderHeader ? (
 332                         renderHeader()
 333                     ) : countNodes(filters) > 0 ? (
 334                         <DataTableFiltersPopover
 335                             name={`${name} filters`}
 336                             mutuallyExclusive={column.mutuallyExclusiveFilters}
 337                             onChange={filters => onFiltersChange && onFiltersChange(filters, column)}
 338                             filters={filters}>
 339                             {name}
 340                         </DataTableFiltersPopover>
 341                     ) : sort ? (
 342                         <TableSortLabel
 343                             active={sort.direction !== SortDirection.NONE}
 344                             direction={sort.direction !== SortDirection.NONE ? sort.direction : undefined}
 345                             IconComponent={this.ArrowIcon}
 346                             hideSortIcon
 347                             onClick={() => onSortToggle && onSortToggle(column)}>
 348                             {name}
 349                         </TableSortLabel>
 350                     ) : (
 351                         <span>{name}</span>
 352                     )}
 353                 </TableCell>
 354             );
 355         };
 356
 357         ArrowIcon = ({ className, ...props }: SvgIconProps) => (
 358             <IconButton
 359                 component="span"
 360                 className={this.props.classes.arrowButton}
 361                 tabIndex={-1}>
 362                 <ArrowDownwardIcon
 363                     {...props}
 364                     className={classnames(className, this.props.classes.arrow)}
 365                 />
 366             </IconButton>
 367         );
 368
 369         renderBodyRow = (item: any, index: number) => {
 370             const { onRowClick, onRowDoubleClick, extractKey, classes, currentItemUuid, currentRoute } = this.props;
 371             return (
 372                 <TableRow
 373                     hover
 374                     key={extractKey ? extractKey(item) : index}
 375                     onClick={event => onRowClick && onRowClick(event, item)}
 376                     onContextMenu={this.handleRowContextMenu(item)}
 377                     onDoubleClick={event => onRowDoubleClick && onRowDoubleClick(event, item)}
 378                     selected={item === currentItemUuid}>
 379                     {this.mapVisibleColumns((column, index) => (
 380                         <TableCell
 381                             key={column.key || index}
 382                             className={
 383                                 currentRoute === "/workflows"
 384                                     ? classes.tableCellWorkflows
 385                                     : index === 0
 386                                     ? classes.checkBoxCell
 387                                     : `${classes.tableCell} ${index === 1 ? classes.firstTableCell : ""}`
 388                             }>
 389                             {column.render(item)}
 390                         </TableCell>
 391                     ))}
 392                 </TableRow>
 393             );
 394         };
 395
 396         mapVisibleColumns = (fn: (column: DataColumn<T, any>, index: number) => React.ReactElement<any>) => {
 397             return this.props.columns.filter(column => column.selected).map(fn);
 398         };
 399
 400         handleRowContextMenu = (item: T) => (event: React.MouseEvent<HTMLElement>) => this.props.onContextMenu(event, item);
 401     }
 402 );