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