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