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 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' | 'tableCellWorkflows' | 'loader';
  39
  40 const styles: StyleRulesCallback<CssRules> = (theme: Theme) => ({
  41     root: {
  42         width: '100%',
  43     },
  44     content: {
  45         display: 'inline-block',
  46         width: '100%',
  47     },
  48     tableBody: {
  49         background: theme.palette.background.paper
  50     },
  51     loader: {
  52         top: '50%',
  53         left: '50%',
  54         marginTop: '-15px',
  55         marginLeft: '-15px',
  56         position: 'absolute'
  57     },
  58     noItemsInfo: {
  59         textAlign: "center",
  60         padding: theme.spacing.unit
  61     },
  62     tableCell: {
  63         wordWrap: 'break-word',
  64         paddingRight: '24px'
  65     },
  66     tableCellWorkflows: {
  67         '&:nth-last-child(2)': {
  68             padding: '0px',
  69             maxWidth: '48px'
  70         },
  71         '&:last-child': {
  72             padding: '0px',
  73             paddingRight: '24px',
  74             width: '48px'
  75         }
  76     },
  77     arrow: {
  78         margin: 0
  79     },
  80     arrowButton: {
  81         color: theme.palette.text.primary
  82     }
  83 });
  84
  85 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules>;
  86
  87 export const DataTable = withStyles(styles)(
  88     class Component<T> extends React.Component<DataTableProps<T>> {
  89         render() {
  90             const { items, classes } = this.props;
  91             return <div className={classes.root}>
  92                 <div className={classes.content}>
  93                     <Table>
  94                         <TableHead>
  95                             <TableRow>
  96                                 {this.mapVisibleColumns(this.renderHeadCell)}
  97                             </TableRow>
  98                         </TableHead>
  99                         <TableBody className={classes.tableBody}>
 100                             {
 101                                 this.props.working ?
 102                                     null :
 103                                     items.map(this.renderBodyRow)
 104                             }
 105                         </TableBody>
 106                     </Table>
 107                     {items.length === 0 && this.props.working !== undefined && !this.props.working && this.renderNoItemsPlaceholder()}
 108                 </div>
 109             </div>;
 110         }
 111
 112         renderNoItemsPlaceholder = () => {
 113             return this.props.defaultView
 114                 ? this.props.defaultView
 115                 : <DataTableDefaultView />;
 116         }
 117
 118         renderHeadCell = (column: DataColumn<T>, index: number) => {
 119             const { name, key, renderHeader, filters, sortDirection } = column;
 120             const { onSortToggle, onFiltersChange, classes } = this.props;
 121             return <TableCell className={classes.tableCell} key={key || index}>
 122                 {renderHeader ?
 123                     renderHeader() :
 124                     countNodes(filters) > 0
 125                         ? <DataTableFiltersPopover
 126                             name={`${name} filters`}
 127                             mutuallyExclusive={column.mutuallyExclusiveFilters}
 128                             onChange={filters =>
 129                                 onFiltersChange &&
 130                                 onFiltersChange(filters, column)}
 131                             filters={filters}>
 132                             {name}
 133                         </DataTableFiltersPopover>
 134                         : sortDirection
 135                             ? <TableSortLabel
 136                                 active={sortDirection !== SortDirection.NONE}
 137                                 direction={sortDirection !== SortDirection.NONE ? sortDirection : undefined}
 138                                 IconComponent={this.ArrowIcon}
 139                                 hideSortIcon
 140                                 onClick={() =>
 141                                     onSortToggle &&
 142                                     onSortToggle(column)}>
 143                                 {name}
 144                             </TableSortLabel>
 145                             : <span>
 146                                 {name}
 147                             </span>}
 148             </TableCell>;
 149         }
 150
 151         ArrowIcon = ({ className, ...props }: SvgIconProps) => (
 152             <IconButton component='span' className={this.props.classes.arrowButton} tabIndex={-1}>
 153                 <ArrowDownwardIcon {...props} className={classnames(className, this.props.classes.arrow)} />
 154             </IconButton>
 155         )
 156
 157         renderBodyRow = (item: any, index: number) => {
 158             const { onRowClick, onRowDoubleClick, extractKey, classes, currentItemUuid, currentRoute } = this.props;
 159             return <TableRow
 160                 hover
 161                 key={extractKey ? extractKey(item) : index}
 162                 onClick={event => onRowClick && onRowClick(event, item)}
 163                 onContextMenu={this.handleRowContextMenu(item)}
 164                 onDoubleClick={event => onRowDoubleClick && onRowDoubleClick(event, item)}
 165                 selected={item === currentItemUuid}>
 166                 {this.mapVisibleColumns((column, index) => (
 167                     <TableCell key={column.key || index} className={currentRoute === '/workflows' ? classes.tableCellWorkflows : classes.tableCell}>
 168                         {column.render(item)}
 169                     </TableCell>
 170                 ))}
 171             </TableRow>;
 172         }
 173
 174         mapVisibleColumns = (fn: (column: DataColumn<T>, index: number) => React.ReactElement<any>) => {
 175             return this.props.columns.filter(column => column.selected).map(fn);
 176         }
 177
 178         handleRowContextMenu = (item: T) =>
 179             (event: React.MouseEvent<HTMLElement>) =>
 180                 this.props.onContextMenu(event, item)
 181
 182     }
 183 );