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 * as 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 } 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';
  39
  40 const styles: StyleRulesCallback<CssRules> = (theme: Theme) => ({
  41     root: {
  42         overflowX: 'auto',
  43         overflowY: 'auto',
  44         height: 'calc(100vh - 280px)',
  45     },
  46     content: {
  47         display: 'inline-block',
  48         width: '100%'
  49     },
  50     tableBody: {
  51         background: theme.palette.background.paper
  52     },
  53     noItemsInfo: {
  54         textAlign: "center",
  55         padding: theme.spacing.unit
  56     },
  57     tableCell: {
  58         wordWrap: 'break-word',
  59         paddingRight: '24px'
  60     },
  61     tableCellWorkflows: {
  62         '&:nth-last-child(2)': {
  63             padding: '0px',
  64             maxWidth: '48px'
  65         },
  66         '&:last-child': {
  67             padding: '0px',
  68             paddingRight: '24px',
  69             width: '48px'
  70         }
  71     },
  72     arrow: {
  73         margin: 0
  74     },
  75     arrowButton: {
  76         color: theme.palette.text.primary
  77     }
  78 });
  79
  80 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules>;
  81
  82 export const DataTable = withStyles(styles)(
  83     class Component<T> extends React.Component<DataTableProps<T>> {
  84         render() {
  85             const { items, classes } = this.props;
  86             return <div className={classes.root}>
  87                 <div className={classes.content}>
  88                     <Table>
  89                         <TableHead>
  90                             <TableRow>
  91                                 {this.mapVisibleColumns(this.renderHeadCell)}
  92                             </TableRow>
  93                         </TableHead>
  94                         <TableBody className={classes.tableBody}>
  95                             {items.map(this.renderBodyRow)}
  96                         </TableBody>
  97                     </Table>
  98                     {items.length === 0 && this.props.working !== undefined && !this.props.working && this.renderNoItemsPlaceholder()}
  99                 </div>
 100             </div>;
 101         }
 102
 103         renderNoItemsPlaceholder = () => {
 104             return this.props.defaultView
 105                 ? this.props.defaultView
 106                 : <DataTableDefaultView />;
 107         }
 108
 109         renderHeadCell = (column: DataColumn<T>, index: number) => {
 110             const { name, key, renderHeader, filters, sortDirection } = column;
 111             const { onSortToggle, onFiltersChange, classes } = this.props;
 112             return <TableCell className={classes.tableCell} key={key || index}>
 113                 {renderHeader ?
 114                     renderHeader() :
 115                     countNodes(filters) > 0
 116                         ? <DataTableFiltersPopover
 117                             name={`${name} filters`}
 118                             mutuallyExclusive={column.mutuallyExclusiveFilters}
 119                             onChange={filters =>
 120                                 onFiltersChange &&
 121                                 onFiltersChange(filters, column)}
 122                             filters={filters}>
 123                             {name}
 124                         </DataTableFiltersPopover>
 125                         : sortDirection
 126                             ? <TableSortLabel
 127                                 active={sortDirection !== SortDirection.NONE}
 128                                 direction={sortDirection !== SortDirection.NONE ? sortDirection : undefined}
 129                                 IconComponent={this.ArrowIcon}
 130                                 hideSortIcon
 131                                 onClick={() =>
 132                                     onSortToggle &&
 133                                     onSortToggle(column)}>
 134                                 {name}
 135                             </TableSortLabel>
 136                             : <span>
 137                                 {name}
 138                             </span>}
 139             </TableCell>;
 140         }
 141
 142         ArrowIcon = ({ className, ...props }: SvgIconProps) => (
 143             <IconButton component='span' className={this.props.classes.arrowButton} tabIndex={-1}>
 144                 <ArrowDownwardIcon {...props} className={classnames(className, this.props.classes.arrow)} />
 145             </IconButton>
 146         )
 147
 148         renderBodyRow = (item: any, index: number) => {
 149             const { onRowClick, onRowDoubleClick, extractKey, classes, currentItemUuid, currentRoute } = this.props;
 150             return <TableRow
 151                 hover
 152                 key={extractKey ? extractKey(item) : index}
 153                 onClick={event => onRowClick && onRowClick(event, item)}
 154                 onContextMenu={this.handleRowContextMenu(item)}
 155                 onDoubleClick={event => onRowDoubleClick && onRowDoubleClick(event, item)}
 156                 selected={item === currentItemUuid}>
 157                 {this.mapVisibleColumns((column, index) => (
 158                     <TableCell key={column.key || index} className={currentRoute === '/workflows' ? classes.tableCellWorkflows : classes.tableCell}>
 159                         {column.render(item)}
 160                     </TableCell>
 161                 ))}
 162             </TableRow>;
 163         }
 164
 165         mapVisibleColumns = (fn: (column: DataColumn<T>, index: number) => React.ReactElement<any>) => {
 166             return this.props.columns.filter(column => column.selected).map(fn);
 167         }
 168
 169         handleRowContextMenu = (item: T) =>
 170             (event: React.MouseEvent<HTMLElement>) =>
 171                 this.props.onContextMenu(event, item)
 172
 173     }
 174 );