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