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