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