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