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