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";
  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 });
  43
  44 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules>;
  45
  46 export const DataTable = withStyles(styles)(
  47     class Component<T> extends React.Component<DataTableProps<T>> {
  48         render() {
  49             const { items, classes } = this.props;
  50             return <div className={classes.root}>
  51                 <div className={classes.content}>
  52                     <Table>
  53                         <TableHead>
  54                             <TableRow>
  55                                 {this.mapVisibleColumns(this.renderHeadCell)}
  56                             </TableRow>
  57                         </TableHead>
  58                         <TableBody className={classes.tableBody}>
  59                             {items.map(this.renderBodyRow)}
  60                         </TableBody>
  61                     </Table>
  62                     {items.length === 0 && this.renderNoItemsPlaceholder()}
  63                 </div>
  64             </div>;
  65         }
  66
  67         renderNoItemsPlaceholder = () => {
  68             return this.props.defaultView
  69                 ? this.props.defaultView
  70                 : <DataTableDefaultView />;
  71         }
  72
  73         renderHeadCell = (column: DataColumn<T>, index: number) => {
  74             const { name, key, renderHeader, filters, sortDirection } = column;
  75             const { onSortToggle, onFiltersChange } = this.props;
  76             return <TableCell key={key || index} style={{ width: column.width, minWidth: column.width }}>
  77                 {renderHeader ?
  78                     renderHeader() :
  79                     filters.length > 0
  80                         ? <DataTableFilters
  81                             name={`${name} filters`}
  82                             onChange={filters =>
  83                                 onFiltersChange &&
  84                                 onFiltersChange(filters, column)}
  85                             filters={filters}>
  86                             {name}
  87                         </DataTableFilters>
  88                         : sortDirection
  89                             ? <TableSortLabel
  90                                 active={sortDirection !== SortDirection.NONE}
  91                                 direction={sortDirection !== SortDirection.NONE ? sortDirection : undefined}
  92                                 onClick={() =>
  93                                     onSortToggle &&
  94                                     onSortToggle(column)}>
  95                                 {name}
  96                             </TableSortLabel>
  97                             : <span>
  98                                 {name}
  99                             </span>}
 100             </TableCell>;
 101         }
 102
 103         renderBodyRow = (item: T, index: number) => {
 104             const { onRowClick, onRowDoubleClick, extractKey } = this.props;
 105             return <TableRow
 106                 hover
 107                 key={extractKey ? extractKey(item) : index}
 108                 onClick={event => onRowClick && onRowClick(event, item)}
 109                 onContextMenu={this.handleRowContextMenu(item)}
 110                 onDoubleClick={event => onRowDoubleClick && onRowDoubleClick(event, item)}>
 111                 {this.mapVisibleColumns((column, index) => (
 112                     <TableCell key={column.key || index}>
 113                         {column.render(item)}
 114                     </TableCell>
 115                 ))}
 116             </TableRow>;
 117         }
 118
 119         mapVisibleColumns = (fn: (column: DataColumn<T>, index: number) => React.ReactElement<any>) => {
 120             return this.props.columns.filter(column => column.selected).map(fn);
 121         }
 122
 123         handleRowContextMenu = (item: T) =>
 124             (event: React.MouseEvent<HTMLElement>) =>
 125                 this.props.onContextMenu(event, item)
 126
 127     }
 128 );