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 };
 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         };
 145
 146         componentDidMount(): void {
 147             this.initializeCheckedList([]);
 148         }
 149
 150         componentDidUpdate(prevProps: Readonly<DataTableProps<T>>, prevState: DataTableState) {
 151             const { items, setCheckedListOnStore } = this.props;
 152             const { isSelected } = this.state;
 153             if (prevProps.items !== items) {
 154                 if (isSelected === true) this.setState({ isSelected: false });
 155                 if (items.length) this.initializeCheckedList(items);
 156                 else setCheckedListOnStore({});
 157             }
 158             if (prevProps.currentRoute !== this.props.currentRoute) {
 159                 this.initializeCheckedList([])
 160             }
 161         }
 162
 163         componentWillUnmount(): void {
 164             this.initializeCheckedList([])
 165         }
 166
 167         checkBoxColumn: DataColumn<any, any> = {
 168             name: "checkBoxColumn",
 169             selected: true,
 170             configurable: false,
 171             filters: createTree(),
 172             render: uuid => {
 173                 const { classes, checkedList } = this.props;
 174                 return (
 175                     <input
 176                         data-cy={`multiselect-checkbox-${uuid}`}
 177                         type="checkbox"
 178                         name={uuid}
 179                         className={classes.checkBox}
 180                         checked={checkedList && checkedList[uuid] ? checkedList[uuid] : false}
 181                         onChange={() => this.handleSelectOne(uuid)}
 182                         onDoubleClick={ev => ev.stopPropagation()}></input>
 183                 );
 184             },
 185         };
 186
 187         multiselectOptions: DataTableMultiselectOption[] = [
 188             { name: "All", fn: list => this.handleSelectAll(list) },
 189             { name: "None", fn: list => this.handleSelectNone(list) },
 190             { name: "Invert", fn: list => this.handleInvertSelect(list) },
 191         ];
 192
 193         initializeCheckedList = (uuids: any[]): void => {
 194             const newCheckedList = { ...this.props.checkedList };
 195
 196             uuids.forEach(uuid => {
 197                 if (!newCheckedList.hasOwnProperty(uuid)) {
 198                     newCheckedList[uuid] = false;
 199                 }
 200             });
 201             for (const key in newCheckedList) {
 202                 if (!uuids.includes(key)) {
 203                     delete newCheckedList[key];
 204                 }
 205             }
 206             this.props.setCheckedListOnStore(newCheckedList);
 207         };
 208
 209         isAllSelected = (list: TCheckedList): boolean => {
 210             for (const key in list) {
 211                 if (list[key] === false) return false;
 212             }
 213             return true;
 214         };
 215
 216         isAnySelected = (): boolean => {
 217             const { checkedList } = this.props;
 218             if (!Object.keys(checkedList).length) return false;
 219             for (const key in checkedList) {
 220                 if (checkedList[key] === true) return true;
 221             }
 222             return false;
 223         };
 224
 225         handleSelectOne = (uuid: string): void => {
 226             const { checkedList } = this.props;
 227             const newCheckedList = { ...checkedList };
 228             newCheckedList[uuid] = !checkedList[uuid];
 229             this.setState({ isSelected: this.isAllSelected(newCheckedList) });
 230             this.props.setCheckedListOnStore(newCheckedList);
 231         };
 232
 233         handleSelectorSelect = (): void => {
 234             const { checkedList } = this.props;
 235             const { isSelected } = this.state;
 236             isSelected ? this.handleSelectNone(checkedList) : this.handleSelectAll(checkedList);
 237         };
 238
 239         handleSelectAll = (list: TCheckedList): void => {
 240             if (Object.keys(list).length) {
 241                 const newCheckedList = { ...list };
 242                 for (const key in newCheckedList) {
 243                     newCheckedList[key] = true;
 244                 }
 245                 this.setState({ isSelected: true });
 246                 this.props.setCheckedListOnStore(newCheckedList);
 247             }
 248         };
 249
 250         handleSelectNone = (list: TCheckedList): void => {
 251             const newCheckedList = { ...list };
 252             for (const key in newCheckedList) {
 253                 newCheckedList[key] = false;
 254             }
 255             this.setState({ isSelected: false });
 256             this.props.setCheckedListOnStore(newCheckedList);
 257         };
 258
 259         handleInvertSelect = (list: TCheckedList): void => {
 260             if (Object.keys(list).length) {
 261                 const newCheckedList = { ...list };
 262                 for (const key in newCheckedList) {
 263                     newCheckedList[key] = !list[key];
 264                 }
 265                 this.setState({ isSelected: this.isAllSelected(newCheckedList) });
 266                 this.props.setCheckedListOnStore(newCheckedList);
 267             }
 268         };
 269
 270         render() {
 271             const { items, classes, working, columns } = this.props;
 272             if (columns[0].name === this.checkBoxColumn.name) columns.shift();
 273             columns.unshift(this.checkBoxColumn);
 274             return (
 275                 <div className={classes.root}>
 276                     <div className={classes.content}>
 277                         <Table>
 278                             <TableHead>
 279                                 <TableRow>{this.mapVisibleColumns(this.renderHeadCell)}</TableRow>
 280                             </TableHead>
 281                             <TableBody className={classes.tableBody}>{!working && items.map(this.renderBodyRow)}</TableBody>
 282                         </Table>
 283                         {!!working && (
 284                             <div className={classes.loader}>
 285                                 <DataTableDefaultView
 286                                     icon={PendingIcon}
 287                                     messages={["Loading data, please wait."]}
 288                                 />
 289                             </div>
 290                         )}
 291                         {items.length === 0 && !working && this.renderNoItemsPlaceholder(this.props.columns)}
 292                     </div>
 293                 </div>
 294             );
 295         }
 296
 297         renderNoItemsPlaceholder = (columns: DataColumns<T, any>) => {
 298             const dirty = columns.some(column => getTreeDirty("")(column.filters));
 299             return (
 300                 <DataTableDefaultView
 301                     icon={this.props.defaultViewIcon}
 302                     messages={this.props.defaultViewMessages}
 303                     filtersApplied={dirty}
 304                 />
 305             );
 306         };
 307
 308         renderHeadCell = (column: DataColumn<T, any>, index: number) => {
 309             const { name, key, renderHeader, filters, sort } = column;
 310             const { onSortToggle, onFiltersChange, classes, checkedList } = this.props;
 311             const { isSelected } = this.state;
 312             return column.name === "checkBoxColumn" ? (
 313                 <TableCell
 314                     key={key || index}
 315                     className={classes.checkBoxCell}>
 316                     <div className={classes.checkBoxHead}>
 317                         <Tooltip title={this.state.isSelected ? "Deselect All" : "Select All"}>
 318                             <input
 319                                 type="checkbox"
 320                                 className={classes.checkBox}
 321                                 checked={isSelected}
 322                                 disabled={!this.props.items.length}
 323                                 onChange={this.handleSelectorSelect}></input>
 324                         </Tooltip>
 325                         <DataTableMultiselectPopover
 326                             name={`Options`}
 327                             disabled={!this.props.items.length}
 328                             options={this.multiselectOptions}
 329                             checkedList={checkedList}></DataTableMultiselectPopover>
 330                     </div>
 331                 </TableCell>
 332             ) : (
 333                 <TableCell
 334                     className={index === 1 ? classes.firstTableCell : classes.tableCell}
 335                     key={key || index}>
 336                     {renderHeader ? (
 337                         renderHeader()
 338                     ) : countNodes(filters) > 0 ? (
 339                         <DataTableFiltersPopover
 340                             name={`${name} filters`}
 341                             mutuallyExclusive={column.mutuallyExclusiveFilters}
 342                             onChange={filters => onFiltersChange && onFiltersChange(filters, column)}
 343                             filters={filters}>
 344                             {name}
 345                         </DataTableFiltersPopover>
 346                     ) : sort ? (
 347                         <TableSortLabel
 348                             active={sort.direction !== SortDirection.NONE}
 349                             direction={sort.direction !== SortDirection.NONE ? sort.direction : undefined}
 350                             IconComponent={this.ArrowIcon}
 351                             hideSortIcon
 352                             onClick={() => onSortToggle && onSortToggle(column)}>
 353                             {name}
 354                         </TableSortLabel>
 355                     ) : (
 356                         <span>{name}</span>
 357                     )}
 358                 </TableCell>
 359             );
 360         };
 361
 362         ArrowIcon = ({ className, ...props }: SvgIconProps) => (
 363             <IconButton
 364                 component="span"
 365                 className={this.props.classes.arrowButton}
 366                 tabIndex={-1}>
 367                 <ArrowDownwardIcon
 368                     {...props}
 369                     className={classnames(className, this.props.classes.arrow)}
 370                 />
 371             </IconButton>
 372         );
 373
 374         renderBodyRow = (item: any, index: number) => {
 375             const { onRowClick, onRowDoubleClick, extractKey, classes, currentItemUuid, currentRoute } = this.props;
 376             return (
 377                 <TableRow
 378                     data-cy={'data-table-row'}
 379                     hover
 380                     key={extractKey ? extractKey(item) : index}
 381                     onClick={event => onRowClick && onRowClick(event, item)}
 382                     onContextMenu={this.handleRowContextMenu(item)}
 383                     onDoubleClick={event => onRowDoubleClick && onRowDoubleClick(event, item)}
 384                     selected={item === currentItemUuid}>
 385                     {this.mapVisibleColumns((column, index) => (
 386                         <TableCell
 387                             key={column.key || index}
 388                             className={
 389                                 currentRoute === "/workflows"
 390                                     ? classes.tableCellWorkflows
 391                                     : index === 0
 392                                     ? classes.checkBoxCell
 393                                     : `${classes.tableCell} ${index === 1 ? classes.firstTableCell : ""}`
 394                             }>
 395                             {column.render(item)}
 396                         </TableCell>
 397                     ))}
 398                 </TableRow>
 399             );
 400         };
 401
 402         mapVisibleColumns = (fn: (column: DataColumn<T, any>, index: number) => React.ReactElement<any>) => {
 403             return this.props.columns.filter(column => column.selected).map(fn);
 404         };
 405
 406         handleRowContextMenu = (item: T) => (event: React.MouseEvent<HTMLElement>) => this.props.onContextMenu(event, item);
 407     }
 408 );