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