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