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