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 { Table, TableBody, TableRow, TableCell, TableHead, TableSortLabel, StyleRulesCallback, Theme, WithStyles, withStyles, IconButton } from '@material-ui/core';
   7 import classnames from 'classnames';
   8 import { DataColumn, SortDirection } from './data-column';
   9 import { DataTableDefaultView } from '../data-table-default-view/data-table-default-view';
  10 import { DataTableFilters } from '../data-table-filters/data-table-filters-tree';
  11 import { DataTableFiltersPopover } from '../data-table-filters/data-table-filters-popover';
  12 import { countNodes, getTreeDirty } from 'models/tree';
  13 import { IconType, PendingIcon } from 'components/icon/icon';
  14 import { SvgIconProps } from '@material-ui/core/SvgIcon';
  15 import ArrowDownwardIcon from '@material-ui/icons/ArrowDownward';
  16 import { Checkbox } from '@material-ui/core';
  17 import { createTree } from 'models/tree';
  18
  19 export type DataColumns<I, R> = Array<DataColumn<I, R>>;
  20
  21 export enum DataTableFetchMode {
  22     PAGINATED,
  23     INFINITE,
  24 }
  25
  26 export interface DataTableDataProps<I> {
  27     items: I[];
  28     columns: DataColumns<I, any>;
  29     onRowClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
  30     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: I) => void;
  31     onRowDoubleClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
  32     onSortToggle: (column: DataColumn<I, any>) => void;
  33     onFiltersChange: (filters: DataTableFilters, column: DataColumn<I, any>) => void;
  34     extractKey?: (item: I) => React.Key;
  35     working?: boolean;
  36     defaultViewIcon?: IconType;
  37     defaultViewMessages?: string[];
  38     currentItemUuid?: string;
  39     currentRoute?: string;
  40 }
  41
  42 type CssRules = 'tableBody' | 'root' | 'content' | 'noItemsInfo' | 'checkBoxCell' | 'tableCell' | 'arrow' | 'arrowButton' | 'tableCellWorkflows' | 'loader';
  43
  44 const styles: StyleRulesCallback<CssRules> = (theme: Theme) => ({
  45     root: {
  46         width: '100%',
  47     },
  48     content: {
  49         display: 'inline-block',
  50         width: '100%',
  51     },
  52     tableBody: {
  53         background: theme.palette.background.paper,
  54     },
  55     loader: {
  56         left: '50%',
  57         marginLeft: '-84px',
  58         position: 'absolute',
  59     },
  60     noItemsInfo: {
  61         textAlign: 'center',
  62         padding: theme.spacing.unit,
  63     },
  64     checkBoxCell: {
  65         padding: '0',
  66         cursor: 'pointer',
  67     },
  68     tableCell: {
  69         wordWrap: 'break-word',
  70         paddingRight: '24px',
  71         color: '#737373',
  72     },
  73     tableCellWorkflows: {
  74         '&:nth-last-child(2)': {
  75             padding: '0px',
  76             maxWidth: '48px',
  77         },
  78         '&:last-child': {
  79             padding: '0px',
  80             paddingRight: '24px',
  81             width: '48px',
  82         },
  83     },
  84     arrow: {
  85         margin: 0,
  86     },
  87     arrowButton: {
  88         color: theme.palette.text.primary,
  89     },
  90 });
  91
  92 type DataTableState = Record<string, boolean>;
  93
  94 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules>;
  95
  96 export const DataTable = withStyles(styles)(
  97     class Component<T> extends React.Component<DataTableProps<T>> {
  98         state: DataTableState = {};
  99
 100         componentDidUpdate(prevProps: Readonly<DataTableProps<T>>) {
 101             if (prevProps.items !== this.props.items) {
 102                 this.initializeCheckedList(this.props.items);
 103             }
 104         }
 105
 106         checkBoxColumn: DataColumn<any, any> = {
 107             name: 'checkBoxColumn',
 108             selected: true,
 109             configurable: false,
 110             filters: createTree(),
 111             render: (uuid) => (
 112                 <input
 113                     type='checkbox'
 114                     name={uuid}
 115                     color='primary'
 116                     checked={this.state[uuid] ?? false}
 117                     onChange={() => this.handleCheck(uuid)}
 118                     onDoubleClick={(ev) => ev.stopPropagation()}
 119                 ></input>
 120             ),
 121         };
 122
 123         initializeCheckedList = (uuids: any[]): void => {
 124             const checkedList = this.state;
 125             uuids.forEach((uuid) => {
 126                 if (!checkedList.hasOwnProperty[uuid]) {
 127                     checkedList[uuid] = false;
 128                 }
 129             });
 130         };
 131
 132         handleCheck = (uuid: string): void => {
 133             const newCheckedList = { ...this.state };
 134             newCheckedList[uuid] = !this.state[uuid];
 135             this.setState(newCheckedList);
 136             console.log(newCheckedList);
 137         };
 138
 139         handleSelectAll = (): void => {
 140             const newCheckedList = { ...this.state };
 141             for (const key in newCheckedList) {
 142                 newCheckedList[key] = true;
 143             }
 144             this.setState(newCheckedList);
 145         };
 146
 147         handleDeselectAll = (): void => {
 148             const newCheckedList = { ...this.state };
 149             for (const key in newCheckedList) {
 150                 newCheckedList[key] = false;
 151             }
 152             this.setState(newCheckedList);
 153         };
 154
 155         handleInvertSelect = (): void => {
 156             const newCheckedList = { ...this.state };
 157             for (const key in newCheckedList) {
 158                 newCheckedList[key] = !this.state[key];
 159             }
 160             this.setState(newCheckedList);
 161         };
 162
 163         render() {
 164             const { items, classes, working, columns } = this.props;
 165             if (columns[0].name === this.checkBoxColumn.name) columns.shift();
 166             columns.unshift(this.checkBoxColumn);
 167
 168             return (
 169                 <div className={classes.root}>
 170                     <div className={classes.content}>
 171                         <Table>
 172                             <TableHead>
 173                                 <TableRow>{this.mapVisibleColumns(this.renderHeadCell)}</TableRow>
 174                             </TableHead>
 175                             <TableBody className={classes.tableBody}>{!working && items.map(this.renderBodyRow)}</TableBody>
 176                         </Table>
 177                         {!!working && (
 178                             <div className={classes.loader}>
 179                                 <DataTableDefaultView icon={PendingIcon} messages={['Loading data, please wait.']} />
 180                             </div>
 181                         )}
 182                         {items.length === 0 && !working && this.renderNoItemsPlaceholder(this.props.columns)}
 183                     </div>
 184                 </div>
 185             );
 186         }
 187
 188         renderNoItemsPlaceholder = (columns: DataColumns<T, any>) => {
 189             const dirty = columns.some((column) => getTreeDirty('')(column.filters));
 190             return <DataTableDefaultView icon={this.props.defaultViewIcon} messages={this.props.defaultViewMessages} filtersApplied={dirty} />;
 191         };
 192
 193         renderHeadCell = (column: DataColumn<T, any>, index: number) => {
 194             const { name, key, renderHeader, filters, sort } = column;
 195             const { onSortToggle, onFiltersChange, classes } = this.props;
 196             return index === 0 ? (
 197                 <TableCell key={key || index} className={classes.checkBoxCell}>
 198                     <div onClick={this.handleSelectAll}>select all</div>
 199                     <div onClick={this.handleDeselectAll}>deselect all</div>
 200                     <div onClick={this.handleInvertSelect}>invert selection</div>
 201                 </TableCell>
 202             ) : (
 203                 <TableCell className={classes.tableCell} key={key || index}>
 204                     {renderHeader ? (
 205                         renderHeader()
 206                     ) : countNodes(filters) > 0 ? (
 207                         <DataTableFiltersPopover
 208                             name={`${name} filters`}
 209                             mutuallyExclusive={column.mutuallyExclusiveFilters}
 210                             onChange={(filters) => onFiltersChange && onFiltersChange(filters, column)}
 211                             filters={filters}
 212                         >
 213                             {name}
 214                         </DataTableFiltersPopover>
 215                     ) : sort ? (
 216                         <TableSortLabel
 217                             active={sort.direction !== SortDirection.NONE}
 218                             direction={sort.direction !== SortDirection.NONE ? sort.direction : undefined}
 219                             IconComponent={this.ArrowIcon}
 220                             hideSortIcon
 221                             onClick={() => onSortToggle && onSortToggle(column)}
 222                         >
 223                             {name}
 224                         </TableSortLabel>
 225                     ) : (
 226                         <span>{name}</span>
 227                     )}
 228                 </TableCell>
 229             );
 230         };
 231
 232         ArrowIcon = ({ className, ...props }: SvgIconProps) => (
 233             <IconButton component='span' className={this.props.classes.arrowButton} tabIndex={-1}>
 234                 <ArrowDownwardIcon {...props} className={classnames(className, this.props.classes.arrow)} />
 235             </IconButton>
 236         );
 237
 238         renderBodyRow = (item: any, index: number) => {
 239             const { onRowClick, onRowDoubleClick, extractKey, classes, currentItemUuid, currentRoute } = this.props;
 240             return (
 241                 <TableRow
 242                     hover
 243                     key={extractKey ? extractKey(item) : index}
 244                     onClick={(event) => onRowClick && onRowClick(event, item)}
 245                     onContextMenu={this.handleRowContextMenu(item)}
 246                     onDoubleClick={(event) => onRowDoubleClick && onRowDoubleClick(event, item)}
 247                     selected={item === currentItemUuid}
 248                 >
 249                     {this.mapVisibleColumns((column, index) => (
 250                         <TableCell
 251                             key={column.key || index}
 252                             className={currentRoute === '/workflows' ? classes.tableCellWorkflows : index === 0 ? classes.checkBoxCell : classes.tableCell}
 253                         >
 254                             {column.render(item)}
 255                         </TableCell>
 256                     ))}
 257                 </TableRow>
 258             );
 259         };
 260
 261         mapVisibleColumns = (fn: (column: DataColumn<T, any>, index: number) => React.ReactElement<any>) => {
 262             return this.props.columns.filter((column) => column.selected).map(fn);
 263         };
 264
 265         handleRowContextMenu = (item: T) => (event: React.MouseEvent<HTMLElement>) => this.props.onContextMenu(event, item);
 266     }
 267 );