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