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
  17 export type DataColumns<I, R> = Array<DataColumn<I, R>>;
  18
  19 export enum DataTableFetchMode {
  20     PAGINATED,
  21     INFINITE,
  22 }
  23
  24 export interface DataTableDataProps<I> {
  25     items: I[];
  26     columns: DataColumns<I, any>;
  27     onRowClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
  28     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: I) => void;
  29     onRowDoubleClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
  30     onSortToggle: (column: DataColumn<I, any>) => void;
  31     onFiltersChange: (filters: DataTableFilters, column: DataColumn<I, any>) => void;
  32     extractKey?: (item: I) => React.Key;
  33     working?: boolean;
  34     defaultViewIcon?: IconType;
  35     defaultViewMessages?: string[];
  36     currentItemUuid?: string;
  37     currentRoute?: string;
  38 }
  39
  40 type CssRules = 'tableBody' | 'root' | 'content' | 'noItemsInfo' | 'tableCellSelect' | 'tableCell' | 'arrow' | 'arrowButton' | 'tableCellWorkflows' | 'loader';
  41
  42 const styles: StyleRulesCallback<CssRules> = (theme: Theme) => ({
  43     root: {
  44         width: '100%',
  45     },
  46     content: {
  47         display: 'inline-block',
  48         width: '100%',
  49     },
  50     tableBody: {
  51         background: theme.palette.background.paper,
  52     },
  53     loader: {
  54         left: '50%',
  55         marginLeft: '-84px',
  56         position: 'absolute',
  57     },
  58     noItemsInfo: {
  59         textAlign: 'center',
  60         padding: theme.spacing.unit,
  61     },
  62     tableCellSelect: {
  63         padding: '0',
  64     },
  65     tableCell: {
  66         wordWrap: 'break-word',
  67         paddingRight: '24px',
  68         color: '#737373',
  69     },
  70     tableCellWorkflows: {
  71         '&:nth-last-child(2)': {
  72             padding: '0px',
  73             maxWidth: '48px',
  74         },
  75         '&:last-child': {
  76             padding: '0px',
  77             paddingRight: '24px',
  78             width: '48px',
  79         },
  80     },
  81     arrow: {
  82         margin: 0,
  83     },
  84     arrowButton: {
  85         color: theme.palette.text.primary,
  86     },
  87 });
  88
  89 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules>;
  90
  91 export const DataTable = withStyles(styles)(
  92     class Component<T> extends React.Component<DataTableProps<T>> {
  93         render() {
  94             const { items, classes, working } = this.props;
  95             return (
  96                 <div className={classes.root}>
  97                     <div className={classes.content}>
  98                         <Table>
  99                             <TableHead>
 100                                 <TableRow>{this.mapVisibleColumns(this.renderHeadCell)}</TableRow>
 101                             </TableHead>
 102                             <TableBody className={classes.tableBody}>{!working && items.map(this.renderBodyRow)}</TableBody>
 103                         </Table>
 104                         {!!working && (
 105                             <div className={classes.loader}>
 106                                 <DataTableDefaultView icon={PendingIcon} messages={['Loading data, please wait.']} />
 107                             </div>
 108                         )}
 109                         {items.length === 0 && !working && this.renderNoItemsPlaceholder(this.props.columns)}
 110                     </div>
 111                 </div>
 112             );
 113         }
 114
 115         renderNoItemsPlaceholder = (columns: DataColumns<T, any>) => {
 116             const dirty = columns.some((column) => getTreeDirty('')(column.filters));
 117             return <DataTableDefaultView icon={this.props.defaultViewIcon} messages={this.props.defaultViewMessages} filtersApplied={dirty} />;
 118         };
 119
 120         renderHeadCell = (column: DataColumn<T, any>, index: number) => {
 121             const { name, key, renderHeader, filters, sort } = column;
 122             const { onSortToggle, onFiltersChange, classes } = this.props;
 123             return (
 124                 <TableCell className={classes.tableCell} key={key || index}>
 125                     {renderHeader ? (
 126                         renderHeader()
 127                     ) : countNodes(filters) > 0 ? (
 128                         <DataTableFiltersPopover
 129                             name={`${name} filters`}
 130                             mutuallyExclusive={column.mutuallyExclusiveFilters}
 131                             onChange={(filters) => onFiltersChange && onFiltersChange(filters, column)}
 132                             filters={filters}
 133                         >
 134                             {name}
 135                         </DataTableFiltersPopover>
 136                     ) : sort ? (
 137                         <TableSortLabel
 138                             active={sort.direction !== SortDirection.NONE}
 139                             direction={sort.direction !== SortDirection.NONE ? sort.direction : undefined}
 140                             IconComponent={this.ArrowIcon}
 141                             hideSortIcon
 142                             onClick={() => onSortToggle && onSortToggle(column)}
 143                         >
 144                             {name}
 145                         </TableSortLabel>
 146                     ) : (
 147                         <span>{name}</span>
 148                     )}
 149                 </TableCell>
 150             );
 151         };
 152
 153         ArrowIcon = ({ className, ...props }: SvgIconProps) => (
 154             <IconButton component='span' className={this.props.classes.arrowButton} tabIndex={-1}>
 155                 <ArrowDownwardIcon {...props} className={classnames(className, this.props.classes.arrow)} />
 156             </IconButton>
 157         );
 158
 159         renderBodyRow = (item: any, index: number) => {
 160             const { onRowClick, onRowDoubleClick, extractKey, classes, currentItemUuid, currentRoute } = this.props;
 161             return (
 162                 <TableRow
 163                     hover
 164                     key={extractKey ? extractKey(item) : index}
 165                     onClick={(event) => onRowClick && onRowClick(event, item)}
 166                     onContextMenu={this.handleRowContextMenu(item)}
 167                     onDoubleClick={(event) => onRowDoubleClick && onRowDoubleClick(event, item)}
 168                     selected={item === currentItemUuid}
 169                 >
 170                     {this.mapVisibleColumns((column, index) => (
 171                         <TableCell
 172                             key={column.key || index}
 173                             className={currentRoute === '/workflows' ? classes.tableCellWorkflows : index === 0 ? classes.tableCellSelect : classes.tableCell}
 174                         >
 175                             {column.render(item)}
 176                         </TableCell>
 177                     ))}
 178                 </TableRow>
 179             );
 180         };
 181
 182         mapVisibleColumns = (fn: (column: DataColumn<T, any>, index: number) => React.ReactElement<any>) => {
 183             return this.props.columns.filter((column) => column.selected).map(fn);
 184         };
 185
 186         handleRowContextMenu = (item: T) => (event: React.MouseEvent<HTMLElement>) => this.props.onContextMenu(event, item);
 187     }
 188 );