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 export type TCheckedList = Record<string, boolean>;
 128
 129 type DataTableState = {
 130     isSelected: boolean;
 131     checkedList: TCheckedList;
 132 };
 133
 134 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules>;
 135
 136 export const DataTable = withStyles(styles)(
 137     class Component<T> extends React.Component<DataTableProps<T>> {
 138         state: DataTableState = {
 139             isSelected: false,
 140             checkedList: {},
 141         };
 142
 143         componentDidMount(): void {
 144             this.initializeCheckedList(this.props.items);
 145         }
 146
 147         componentDidUpdate(prevProps: Readonly<DataTableProps<T>>, prevState: DataTableState) {
 148             const { items, toggleMSToolbar } = this.props;
 149             const { isSelected, checkedList } = this.state;
 150             if (!arraysAreCongruent(prevProps.items, items)) {
 151                 if (isSelected === true) this.setState({ isSelected: false });
 152                 if (items.length) this.initializeCheckedList(items);
 153                 toggleMSToolbar(false);
 154             }
 155             if (prevState.checkedList !== checkedList) {
 156                 toggleMSToolbar(this.isAnySelected() ? true : false);
 157             }
 158         }
 159
 160         checkBoxColumn: DataColumn<any, any> = {
 161             name: 'checkBoxColumn',
 162             selected: true,
 163             configurable: false,
 164             filters: createTree(),
 165             render: (uuid) => (
 166                 <input
 167                     type='checkbox'
 168                     name={uuid}
 169                     className={this.props.classes.checkBox}
 170                     checked={this.state.checkedList[uuid] ?? false}
 171                     onChange={() => this.handleCheck(uuid)}
 172                     onDoubleClick={(ev) => ev.stopPropagation()}
 173                 ></input>
 174             ),
 175         };
 176
 177         multiselectOptions: DataTableMultiselectOption[] = [
 178             { name: 'All', fn: (list) => this.handleSelectAll(list) },
 179             { name: 'None', fn: (list) => this.handleSelectNone(list) },
 180             { name: 'Invert', fn: (list) => this.handleInvertSelect(list) },
 181         ];
 182
 183         initializeCheckedList = (uuids: any[]): void => {
 184             const newCheckedList = { ...this.state.checkedList };
 185
 186             uuids.forEach((uuid) => {
 187                 if (!newCheckedList.hasOwnProperty(uuid)) {
 188                     newCheckedList[uuid] = false;
 189                 }
 190             });
 191             for (const key in newCheckedList) {
 192                 if (!uuids.includes(key)) {
 193                     delete newCheckedList[key];
 194                 }
 195             }
 196             this.setState({ checkedList: newCheckedList });
 197         };
 198
 199         isAllSelected = (list: TCheckedList): boolean => {
 200             for (const key in list) {
 201                 if (list[key] === false) return false;
 202             }
 203             return true;
 204         };
 205
 206         isAnySelected = (): boolean => {
 207             const { checkedList } = this.state;
 208             if (!Object.keys(checkedList).length) return false;
 209             for (const key in checkedList) {
 210                 if (checkedList[key] === true) return true;
 211             }
 212             return false;
 213         };
 214
 215         handleCheck = (uuid: string): void => {
 216             const { checkedList } = this.state;
 217             const newCheckedList = { ...checkedList };
 218             newCheckedList[uuid] = !checkedList[uuid];
 219             this.setState({ checkedList: newCheckedList, isSelected: this.isAllSelected(newCheckedList) });
 220         };
 221
 222         handleSelectorSelect = (): void => {
 223             const { checkedList } = this.state;
 224             const { isSelected } = this.state;
 225             isSelected ? this.handleSelectNone(checkedList) : this.handleSelectAll(checkedList);
 226         };
 227
 228         handleSelectAll = (list: TCheckedList): void => {
 229             if (Object.keys(list).length) {
 230                 const newCheckedList = { ...list };
 231                 for (const key in newCheckedList) {
 232                     newCheckedList[key] = true;
 233                 }
 234                 this.setState({ isSelected: true, checkedList: newCheckedList });
 235             }
 236         };
 237
 238         handleSelectNone = (list: TCheckedList): void => {
 239             const newCheckedList = { ...list };
 240             for (const key in newCheckedList) {
 241                 newCheckedList[key] = false;
 242             }
 243             this.setState({ isSelected: false, checkedList: newCheckedList });
 244         };
 245
 246         handleInvertSelect = (list: TCheckedList): void => {
 247             if (Object.keys(list).length) {
 248                 const newCheckedList = { ...list };
 249                 for (const key in newCheckedList) {
 250                     newCheckedList[key] = !list[key];
 251                 }
 252                 this.setState({ checkedList: newCheckedList, isSelected: this.isAllSelected(newCheckedList) });
 253             }
 254         };
 255
 256         render() {
 257             const { items, classes, working, columns } = this.props;
 258             if (columns[0].name === this.checkBoxColumn.name) columns.shift();
 259             columns.unshift(this.checkBoxColumn);
 260             return (
 261                 <div className={classes.root}>
 262                     <div className={classes.content}>
 263                         <Table>
 264                             <TableHead>
 265                                 <TableRow>{this.mapVisibleColumns(this.renderHeadCell)}</TableRow>
 266                             </TableHead>
 267                             <TableBody className={classes.tableBody}>{!working && items.map(this.renderBodyRow)}</TableBody>
 268                         </Table>
 269                         {!!working && (
 270                             <div className={classes.loader}>
 271                                 <DataTableDefaultView icon={PendingIcon} messages={['Loading data, please wait.']} />
 272                             </div>
 273                         )}
 274                         {items.length === 0 && !working && this.renderNoItemsPlaceholder(this.props.columns)}
 275                     </div>
 276                 </div>
 277             );
 278         }
 279
 280         renderNoItemsPlaceholder = (columns: DataColumns<T, any>) => {
 281             const dirty = columns.some((column) => getTreeDirty('')(column.filters));
 282             return <DataTableDefaultView icon={this.props.defaultViewIcon} messages={this.props.defaultViewMessages} filtersApplied={dirty} />;
 283         };
 284
 285         renderHeadCell = (column: DataColumn<T, any>, index: number) => {
 286             const { name, key, renderHeader, filters, sort } = column;
 287             const { onSortToggle, onFiltersChange, classes } = this.props;
 288             return column.name === 'checkBoxColumn' ? (
 289                 <TableCell key={key || index} className={classes.checkBoxCell}>
 290                     <div className={classes.checkBoxHead}>
 291                         <Tooltip title={this.state.isSelected ? 'Deselect All' : 'Select All'}>
 292                             <input type='checkbox' className={classes.checkBox} checked={this.state.isSelected} onChange={this.handleSelectorSelect}></input>
 293                         </Tooltip>
 294                         <DataTableMultiselectPopover
 295                             name={`Options`}
 296                             options={this.multiselectOptions}
 297                             checkedList={this.state.checkedList}
 298                         ></DataTableMultiselectPopover>
 299                     </div>
 300                 </TableCell>
 301             ) : (
 302                 <TableCell className={classes.tableCell} key={key || index}>
 303                     {renderHeader ? (
 304                         renderHeader()
 305                     ) : countNodes(filters) > 0 ? (
 306                         <DataTableFiltersPopover
 307                             name={`${name} filters`}
 308                             mutuallyExclusive={column.mutuallyExclusiveFilters}
 309                             onChange={(filters) => onFiltersChange && onFiltersChange(filters, column)}
 310                             filters={filters}
 311                         >
 312                             {name}
 313                         </DataTableFiltersPopover>
 314                     ) : sort ? (
 315                         <TableSortLabel
 316                             active={sort.direction !== SortDirection.NONE}
 317                             direction={sort.direction !== SortDirection.NONE ? sort.direction : undefined}
 318                             IconComponent={this.ArrowIcon}
 319                             hideSortIcon
 320                             onClick={() => onSortToggle && onSortToggle(column)}
 321                         >
 322                             {name}
 323                         </TableSortLabel>
 324                     ) : (
 325                         <span>{name}</span>
 326                     )}
 327                 </TableCell>
 328             );
 329         };
 330
 331         ArrowIcon = ({ className, ...props }: SvgIconProps) => (
 332             <IconButton component='span' className={this.props.classes.arrowButton} tabIndex={-1}>
 333                 <ArrowDownwardIcon {...props} className={classnames(className, this.props.classes.arrow)} />
 334             </IconButton>
 335         );
 336
 337         renderBodyRow = (item: any, index: number) => {
 338             const { onRowClick, onRowDoubleClick, extractKey, classes, currentItemUuid, currentRoute } = this.props;
 339             return (
 340                 <TableRow
 341                     hover
 342                     key={extractKey ? extractKey(item) : index}
 343                     onClick={(event) => onRowClick && onRowClick(event, item)}
 344                     onContextMenu={this.handleRowContextMenu(item)}
 345                     onDoubleClick={(event) => onRowDoubleClick && onRowDoubleClick(event, item)}
 346                     selected={item === currentItemUuid}
 347                 >
 348                     {this.mapVisibleColumns((column, index) => (
 349                         <TableCell
 350                             key={column.key || index}
 351                             className={currentRoute === '/workflows' ? classes.tableCellWorkflows : index === 0 ? classes.checkBoxCell : classes.tableCell}
 352                         >
 353                             {column.render(item)}
 354                         </TableCell>
 355                     ))}
 356                 </TableRow>
 357             );
 358         };
 359
 360         mapVisibleColumns = (fn: (column: DataColumn<T, any>, index: number) => React.ReactElement<any>) => {
 361             return this.props.columns.filter((column) => column.selected).map(fn);
 362         };
 363
 364         handleRowContextMenu = (item: T) => (event: React.MouseEvent<HTMLElement>) => this.props.onContextMenu(event, item);
 365     }
 366 );