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