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 const handleSelectAll = () => {};
  94
  95 const handleDeselectAll = () => {};
  96
  97 type DataTableState = {
  98     checkedList: Record<string, boolean>;
  99 };
 100
 101 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules> & DataTableState;
 102
 103 export const DataTable = withStyles(styles)(
 104     class Component<T> extends React.Component<DataTableProps<T>> {
 105         state: DataTableState = {
 106             checkedList: {},
 107         };
 108         checkBoxColumn: DataColumn<any, any> = {
 109             name: 'checkBoxColumn',
 110             selected: true,
 111             configurable: false,
 112             filters: createTree(),
 113             render: (uuid) => <input type='checkbox' name={uuid} color='primary' checked={this.state[uuid] ?? false} onChange={() => this.handleCheck(uuid)}></input>,
 114         };
 115
 116         initializeCheckedList = (items: any[]): void => {
 117             const checkedList = this.state;
 118             for (const uuid in checkedList) {
 119                 if (checkedList.hasOwnProperty(uuid)) {
 120                     delete checkedList[uuid];
 121                 }
 122             }
 123             items.forEach((uuid) => {
 124                 if (!checkedList.hasOwnProperty[uuid]) {
 125                     checkedList[uuid] = false;
 126                 }
 127             });
 128         };
 129
 130         componentDidUpdate(prevProps: Readonly<DataTableProps<T>>): void {
 131             if (prevProps.items !== this.props.items) {
 132                 this.initializeCheckedList(this.props.items);
 133             }
 134         }
 135
 136         handleCheck = async (uuid: string) => {
 137             const checkedList = this.state;
 138             const newCheckedList = { ...checkedList };
 139             newCheckedList[uuid] = !checkedList[uuid];
 140             await this.setState(newCheckedList);
 141         };
 142         render() {
 143             const { items, classes, working, columns } = this.props;
 144             if (columns[0].name !== this.checkBoxColumn.name) columns.unshift(this.checkBoxColumn);
 145             const firstBox: HTMLInputElement | null = document.querySelector('input[type="checkbox"]');
 146             return (
 147                 <div className={classes.root}>
 148                     <div className={classes.content}>
 149                         <button
 150                             onClick={() => {
 151                                 if (firstBox) this.handleCheck(firstBox?.name);
 152                             }}
 153                         >
 154                             TEST
 155                         </button>
 156                         <Table>
 157                             <TableHead>
 158                                 <TableRow>{this.mapVisibleColumns(this.renderHeadCell)}</TableRow>
 159                             </TableHead>
 160                             <TableBody className={classes.tableBody}>{!working && items.map(this.renderBodyRow)}</TableBody>
 161                         </Table>
 162                         {!!working && (
 163                             <div className={classes.loader}>
 164                                 <DataTableDefaultView icon={PendingIcon} messages={['Loading data, please wait.']} />
 165                             </div>
 166                         )}
 167                         {items.length === 0 && !working && this.renderNoItemsPlaceholder(this.props.columns)}
 168                     </div>
 169                 </div>
 170             );
 171         }
 172
 173         renderNoItemsPlaceholder = (columns: DataColumns<T, any>) => {
 174             const dirty = columns.some((column) => getTreeDirty('')(column.filters));
 175             return <DataTableDefaultView icon={this.props.defaultViewIcon} messages={this.props.defaultViewMessages} filtersApplied={dirty} />;
 176         };
 177
 178         renderHeadCell = (column: DataColumn<T, any>, index: number) => {
 179             const { name, key, renderHeader, filters, sort } = column;
 180             const { onSortToggle, onFiltersChange, classes } = this.props;
 181             return index === 0 ? (
 182                 <TableCell key={key || index} className={classes.checkBoxCell}>
 183                     <div onClick={handleSelectAll}>select all</div>
 184                     <div onClick={handleDeselectAll}>deselect all</div>
 185                 </TableCell>
 186             ) : (
 187                 <TableCell className={classes.tableCell} key={key || index}>
 188                     {renderHeader ? (
 189                         renderHeader()
 190                     ) : countNodes(filters) > 0 ? (
 191                         <DataTableFiltersPopover
 192                             name={`${name} filters`}
 193                             mutuallyExclusive={column.mutuallyExclusiveFilters}
 194                             onChange={(filters) => onFiltersChange && onFiltersChange(filters, column)}
 195                             filters={filters}
 196                         >
 197                             {name}
 198                         </DataTableFiltersPopover>
 199                     ) : sort ? (
 200                         <TableSortLabel
 201                             active={sort.direction !== SortDirection.NONE}
 202                             direction={sort.direction !== SortDirection.NONE ? sort.direction : undefined}
 203                             IconComponent={this.ArrowIcon}
 204                             hideSortIcon
 205                             onClick={() => onSortToggle && onSortToggle(column)}
 206                         >
 207                             {name}
 208                         </TableSortLabel>
 209                     ) : (
 210                         <span>{name}</span>
 211                     )}
 212                 </TableCell>
 213             );
 214         };
 215
 216         ArrowIcon = ({ className, ...props }: SvgIconProps) => (
 217             <IconButton component='span' className={this.props.classes.arrowButton} tabIndex={-1}>
 218                 <ArrowDownwardIcon {...props} className={classnames(className, this.props.classes.arrow)} />
 219             </IconButton>
 220         );
 221
 222         renderBodyRow = (item: any, index: number) => {
 223             const { onRowClick, onRowDoubleClick, extractKey, classes, currentItemUuid, currentRoute } = this.props;
 224             return (
 225                 <TableRow
 226                     hover
 227                     key={extractKey ? extractKey(item) : index}
 228                     onClick={(event) => onRowClick && onRowClick(event, item)}
 229                     onContextMenu={this.handleRowContextMenu(item)}
 230                     onDoubleClick={(event) => onRowDoubleClick && onRowDoubleClick(event, item)}
 231                     selected={item === currentItemUuid}
 232                 >
 233                     {this.mapVisibleColumns((column, index) => (
 234                         <TableCell
 235                             key={column.key || index}
 236                             className={currentRoute === '/workflows' ? classes.tableCellWorkflows : index === 0 ? classes.checkBoxCell : classes.tableCell}
 237                         >
 238                             {column.render(item)}
 239                         </TableCell>
 240                     ))}
 241                 </TableRow>
 242             );
 243         };
 244
 245         mapVisibleColumns = (fn: (column: DataColumn<T, any>, index: number) => React.ReactElement<any>) => {
 246             return this.props.columns.filter((column) => column.selected).map(fn);
 247         };
 248
 249         handleRowContextMenu = (item: T) => (event: React.MouseEvent<HTMLElement>) => this.props.onContextMenu(event, item);
 250     }
 251 );