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         // border: '1px dotted green',
  66         padding: '0',
  67         cursor: 'pointer',
  68     },
  69     tableCell: {
  70         wordWrap: 'break-word',
  71         paddingRight: '24px',
  72         color: '#737373',
  73     },
  74     tableCellWorkflows: {
  75         '&:nth-last-child(2)': {
  76             padding: '0px',
  77             maxWidth: '48px',
  78         },
  79         '&:last-child': {
  80             padding: '0px',
  81             paddingRight: '24px',
  82             width: '48px',
  83         },
  84     },
  85     arrow: {
  86         margin: 0,
  87     },
  88     arrowButton: {
  89         color: theme.palette.text.primary,
  90     },
  91 });
  92
  93 type DataTableState = {
  94     // checkedList: Record<string, boolean>;
  95 };
  96
  97 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules> & DataTableState;
  98
  99 export const DataTable = withStyles(styles)(
 100     class Component<T> extends React.Component<DataTableProps<T>> {
 101         state: DataTableState = {
 102             // checkedList: {},
 103         };
 104
 105         componentDidUpdate(prevProps: Readonly<DataTableProps<T>>) {
 106             if (prevProps.items !== this.props.items) {
 107                 console.log('BEFORE INIT', this.state);
 108                 this.initializeCheckedList(this.props.items);
 109                 console.log('AFTER INIT', this.state);
 110             }
 111         }
 112
 113         checkBoxColumn: DataColumn<any, any> = {
 114             name: 'checkBoxColumn',
 115             selected: true,
 116             configurable: false,
 117             filters: createTree(),
 118             render: (uuid) => <input type='checkbox' name={uuid} color='primary' checked={this.state[uuid] ?? false} onChange={() => this.handleCheck(uuid)}></input>,
 119         };
 120
 121         initializeCheckedList = async (uuids: any[]) => {
 122             let checkedList = this.state;
 123             uuids.forEach((uuid) => {
 124                 if (!checkedList.hasOwnProperty[uuid]) {
 125                     checkedList[uuid] = false;
 126                 }
 127             });
 128         };
 129
 130         handleCheck = (uuid: string) => {
 131             const checkedList = this.state;
 132             const newCheckedList = { ...checkedList };
 133             newCheckedList[uuid] = !checkedList[uuid];
 134             this.setState(newCheckedList);
 135         };
 136
 137         handleSelectAll = () => {
 138             const newCheckedList = { ...this.state };
 139             for (const key in newCheckedList) {
 140                 newCheckedList[key] = true;
 141             }
 142             this.setState(newCheckedList);
 143         };
 144
 145         handleDeselectAll = () => {
 146             const newCheckedList = { ...this.state };
 147             for (const key in newCheckedList) {
 148                 newCheckedList[key] = false;
 149             }
 150             this.setState(newCheckedList);
 151         };
 152
 153         handleInvertSelect = () => {
 154             const newCheckedList = { ...this.state };
 155             for (const key in newCheckedList) {
 156                 newCheckedList[key] = !this.state[key];
 157             }
 158             this.setState(newCheckedList);
 159         };
 160
 161         render() {
 162             const { items, classes, working, columns } = this.props;
 163             if (columns[0].name === this.checkBoxColumn.name) columns.shift();
 164             columns.unshift(this.checkBoxColumn);
 165             console.log('ONCHECK', this.state);
 166
 167             return (
 168                 <div className={classes.root}>
 169                     <div className={classes.content}>
 170                         <Table>
 171                             <TableHead>
 172                                 <TableRow>{this.mapVisibleColumns(this.renderHeadCell)}</TableRow>
 173                             </TableHead>
 174                             <TableBody className={classes.tableBody}>{!working && items.map(this.renderBodyRow)}</TableBody>
 175                         </Table>
 176                         {!!working && (
 177                             <div className={classes.loader}>
 178                                 <DataTableDefaultView icon={PendingIcon} messages={['Loading data, please wait.']} />
 179                             </div>
 180                         )}
 181                         {items.length === 0 && !working && this.renderNoItemsPlaceholder(this.props.columns)}
 182                     </div>
 183                 </div>
 184             );
 185         }
 186
 187         renderNoItemsPlaceholder = (columns: DataColumns<T, any>) => {
 188             const dirty = columns.some((column) => getTreeDirty('')(column.filters));
 189             return <DataTableDefaultView icon={this.props.defaultViewIcon} messages={this.props.defaultViewMessages} filtersApplied={dirty} />;
 190         };
 191
 192         renderHeadCell = (column: DataColumn<T, any>, index: number) => {
 193             const { name, key, renderHeader, filters, sort } = column;
 194             const { onSortToggle, onFiltersChange, classes } = this.props;
 195             return index === 0 ? (
 196                 <TableCell key={key || index} className={classes.checkBoxCell}>
 197                     <div onClick={this.handleSelectAll}>select all</div>
 198                     <div onClick={this.handleDeselectAll}>deselect all</div>
 199                     <div onClick={this.handleInvertSelect}>invert selection</div>
 200                 </TableCell>
 201             ) : (
 202                 <TableCell className={classes.tableCell} key={key || index}>
 203                     {renderHeader ? (
 204                         renderHeader()
 205                     ) : countNodes(filters) > 0 ? (
 206                         <DataTableFiltersPopover
 207                             name={`${name} filters`}
 208                             mutuallyExclusive={column.mutuallyExclusiveFilters}
 209                             onChange={(filters) => onFiltersChange && onFiltersChange(filters, column)}
 210                             filters={filters}
 211                         >
 212                             {name}
 213                         </DataTableFiltersPopover>
 214                     ) : sort ? (
 215                         <TableSortLabel
 216                             active={sort.direction !== SortDirection.NONE}
 217                             direction={sort.direction !== SortDirection.NONE ? sort.direction : undefined}
 218                             IconComponent={this.ArrowIcon}
 219                             hideSortIcon
 220                             onClick={() => onSortToggle && onSortToggle(column)}
 221                         >
 222                             {name}
 223                         </TableSortLabel>
 224                     ) : (
 225                         <span>{name}</span>
 226                     )}
 227                 </TableCell>
 228             );
 229         };
 230
 231         ArrowIcon = ({ className, ...props }: SvgIconProps) => (
 232             <IconButton component='span' className={this.props.classes.arrowButton} tabIndex={-1}>
 233                 <ArrowDownwardIcon {...props} className={classnames(className, this.props.classes.arrow)} />
 234             </IconButton>
 235         );
 236
 237         renderBodyRow = (item: any, index: number) => {
 238             const { onRowClick, onRowDoubleClick, extractKey, classes, currentItemUuid, currentRoute } = this.props;
 239             return (
 240                 <TableRow
 241                     hover
 242                     key={extractKey ? extractKey(item) : index}
 243                     onClick={(event) => onRowClick && onRowClick(event, item)}
 244                     onContextMenu={this.handleRowContextMenu(item)}
 245                     onDoubleClick={(event) => onRowDoubleClick && onRowDoubleClick(event, item)}
 246                     selected={item === currentItemUuid}
 247                 >
 248                     {this.mapVisibleColumns((column, index) => (
 249                         <TableCell
 250                             key={column.key || index}
 251                             className={currentRoute === '/workflows' ? classes.tableCellWorkflows : index === 0 ? classes.checkBoxCell : classes.tableCell}
 252                         >
 253                             {column.render(item)}
 254                         </TableCell>
 255                     ))}
 256                 </TableRow>
 257             );
 258         };
 259
 260         mapVisibleColumns = (fn: (column: DataColumn<T, any>, index: number) => React.ReactElement<any>) => {
 261             return this.props.columns.filter((column) => column.selected).map(fn);
 262         };
 263
 264         handleRowContextMenu = (item: T) => (event: React.MouseEvent<HTMLElement>) => this.props.onContextMenu(event, item);
 265     }
 266 );