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