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