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 } from '@material-ui/core';
   7 import { DataColumn, SortDirection } from './data-column';
   8 import { DataTableFilters,  DataTableFilterItem } from "../data-table-filters/data-table-filters";
   9
  10 export type DataColumns<T, F extends DataTableFilterItem = DataTableFilterItem> = Array<DataColumn<T, F>>;
  11
  12 export interface DataTableDataProps<T> {
  13     items: T[];
  14     columns: DataColumns<T>;
  15     onRowClick: (event: React.MouseEvent<HTMLTableRowElement>, item: T) => void;
  16     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: T) => void;
  17     onRowDoubleClick: (event: React.MouseEvent<HTMLTableRowElement>, item: T) => void;
  18     onSortToggle: (column: DataColumn<T>) => void;
  19     onFiltersChange: (filters: DataTableFilterItem[], column: DataColumn<T>) => void;
  20     extractKey?: (item: T) => React.Key;
  21 }
  22
  23 type CssRules = "tableBody" | "tableContainer" | "noItemsInfo" | 'tableCell';
  24
  25 const styles: StyleRulesCallback<CssRules> = (theme: Theme) => ({
  26     tableContainer: {
  27         overflowX: 'auto',
  28         overflowY: 'hidden'
  29     },
  30     tableBody: {
  31         background: theme.palette.background.paper
  32     },
  33     noItemsInfo: {
  34         textAlign: "center",
  35         padding: theme.spacing.unit
  36     },
  37     tableCell: {
  38         wordWrap: 'break-word'
  39     }
  40 });
  41
  42 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules>;
  43
  44 export const DataTable = withStyles(styles)(
  45     class Component<T> extends React.Component<DataTableProps<T>> {
  46         render() {
  47             const { items, classes } = this.props;
  48             return <div
  49                 className={classes.tableContainer}>
  50                 <Table>
  51                     <TableHead>
  52                         <TableRow>
  53                             {this.mapVisibleColumns(this.renderHeadCell)}
  54                         </TableRow>
  55                     </TableHead>
  56                     <TableBody className={classes.tableBody}>
  57                         {items.map(this.renderBodyRow)}
  58                     </TableBody>
  59                 </Table>
  60             </div>;
  61         }
  62
  63         renderHeadCell = (column: DataColumn<T>, index: number) => {
  64             const { name, key, renderHeader, filters, sortDirection } = column;
  65             const { onSortToggle, onFiltersChange } = this.props;
  66             return <TableCell key={key || index}>
  67                 {renderHeader ?
  68                     renderHeader() :
  69                     filters.length > 0
  70                         ? <DataTableFilters
  71                             name={`${name} filters`}
  72                             onChange={filters =>
  73                                 onFiltersChange &&
  74                                 onFiltersChange(filters, column)}
  75                             filters={filters}>
  76                             {name}
  77                         </DataTableFilters>
  78                         : sortDirection
  79                             ? <TableSortLabel
  80                                 active={sortDirection !== SortDirection.NONE}
  81                                 direction={sortDirection !== SortDirection.NONE ? sortDirection : undefined}
  82                                 onClick={() =>
  83                                     onSortToggle &&
  84                                     onSortToggle(column)}>
  85                                 {name}
  86                             </TableSortLabel>
  87                             : <span>
  88                                 {name}
  89                             </span>}
  90             </TableCell>;
  91         }
  92
  93         renderBodyRow = (item: T, index: number) => {
  94             const { onRowClick, onRowDoubleClick, extractKey, classes } = this.props;
  95             return <TableRow
  96                 hover
  97                 key={extractKey ? extractKey(item) : index}
  98                 onClick={event => onRowClick && onRowClick(event, item)}
  99                 onContextMenu={this.handleRowContextMenu(item)}
 100                 onDoubleClick={event => onRowDoubleClick && onRowDoubleClick(event, item) }>
 101                 {this.mapVisibleColumns((column, index) => (
 102                     <TableCell key={column.key || index} className={classes.tableCell}>
 103                         {column.render(item)}
 104                     </TableCell>
 105                 ))}
 106             </TableRow>;
 107         }
 108
 109         mapVisibleColumns = (fn: (column: DataColumn<T>, index: number) => React.ReactElement<any>) => {
 110             return this.props.columns.filter(column => column.selected).map(fn);
 111         }
 112
 113         handleRowContextMenu = (item: T) =>
 114             (event: React.MouseEvent<HTMLElement>) =>
 115                 this.props.onContextMenu(event, item)
 116
 117     }
 118 );