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