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, getTreeDirty } from 'models/tree';
  13 import { IconType, PendingIcon } from 'components/icon/icon';
  14 import { SvgIconProps } from '@material-ui/core/SvgIcon';
  15 import ArrowDownwardIcon from '@material-ui/icons/ArrowDownward';
  16
  17 export type DataColumns<T> = Array<DataColumn<T>>;
  18
  19 export enum DataTableFetchMode {
  20     PAGINATED,
  21     INFINITE
  22 }
  23
  24 export interface DataTableDataProps<T> {
  25     items: T[];
  26     columns: DataColumns<T>;
  27     onRowClick: (event: React.MouseEvent<HTMLTableRowElement>, item: T) => void;
  28     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: T) => void;
  29     onRowDoubleClick: (event: React.MouseEvent<HTMLTableRowElement>, item: T) => void;
  30     onSortToggle: (column: DataColumn<T>) => void;
  31     onFiltersChange: (filters: DataTableFilters, column: DataColumn<T>) => void;
  32     extractKey?: (item: T) => React.Key;
  33     working?: boolean;
  34     defaultViewIcon?: IconType;
  35     defaultViewMessages?: string[];
  36     currentItemUuid?: string;
  37     currentRoute?: string;
  38 }
  39
  40 type CssRules = "tableBody" | "root" | "content" | "noItemsInfo" | 'tableCell' | 'arrow' | 'arrowButton' | 'tableCellWorkflows' | 'loader';
  41
  42 const styles: StyleRulesCallback<CssRules> = (theme: Theme) => ({
  43     root: {
  44         width: '100%',
  45     },
  46     content: {
  47         display: 'inline-block',
  48         width: '100%',
  49     },
  50     tableBody: {
  51         background: theme.palette.background.paper
  52     },
  53     loader: {
  54         left: '50%',
  55         marginLeft: '-84px',
  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, working } = 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                             { !working && items.map(this.renderBodyRow) }
 101                         </TableBody>
 102                     </Table>
 103                     { !!working &&
 104                         <div className={classes.loader}>
 105                             <DataTableDefaultView
 106                                 icon={PendingIcon}
 107                                 messages={['Loading data, please wait.']} />
 108                         </div> }
 109                     {items.length === 0 && !working && this.renderNoItemsPlaceholder(this.props.columns)}
 110                 </div>
 111             </div>;
 112         }
 113
 114         renderNoItemsPlaceholder = (columns: DataColumns<T>) => {
 115             const dirty = columns.some((column) => getTreeDirty('')(column.filters));
 116             return <DataTableDefaultView
 117                 icon={this.props.defaultViewIcon}
 118                 messages={this.props.defaultViewMessages}
 119                 filtersApplied={dirty} />;
 120         }
 121
 122         renderHeadCell = (column: DataColumn<T>, index: number) => {
 123             const { name, key, renderHeader, filters, sortDirection } = column;
 124             const { onSortToggle, onFiltersChange, classes } = this.props;
 125             return <TableCell className={classes.tableCell} key={key || index}>
 126                 {renderHeader ?
 127                     renderHeader() :
 128                     countNodes(filters) > 0
 129                         ? <DataTableFiltersPopover
 130                             name={`${name} filters`}
 131                             mutuallyExclusive={column.mutuallyExclusiveFilters}
 132                             onChange={filters =>
 133                                 onFiltersChange &&
 134                                 onFiltersChange(filters, column)}
 135                             filters={filters}>
 136                             {name}
 137                         </DataTableFiltersPopover>
 138                         : sortDirection
 139                             ? <TableSortLabel
 140                                 active={sortDirection !== SortDirection.NONE}
 141                                 direction={sortDirection !== SortDirection.NONE ? sortDirection : undefined}
 142                                 IconComponent={this.ArrowIcon}
 143                                 hideSortIcon
 144                                 onClick={() =>
 145                                     onSortToggle &&
 146                                     onSortToggle(column)}>
 147                                 {name}
 148                             </TableSortLabel>
 149                             : <span>
 150                                 {name}
 151                             </span>}
 152             </TableCell>;
 153         }
 154
 155         ArrowIcon = ({ className, ...props }: SvgIconProps) => (
 156             <IconButton component='span' className={this.props.classes.arrowButton} tabIndex={-1}>
 157                 <ArrowDownwardIcon {...props} className={classnames(className, this.props.classes.arrow)} />
 158             </IconButton>
 159         )
 160
 161         renderBodyRow = (item: any, index: number) => {
 162             const { onRowClick, onRowDoubleClick, extractKey, classes, currentItemUuid, currentRoute } = this.props;
 163             return <TableRow
 164                 hover
 165                 key={extractKey ? extractKey(item) : index}
 166                 onClick={event => onRowClick && onRowClick(event, item)}
 167                 onContextMenu={this.handleRowContextMenu(item)}
 168                 onDoubleClick={event => onRowDoubleClick && onRowDoubleClick(event, item)}
 169                 selected={item === currentItemUuid}>
 170                 {this.mapVisibleColumns((column, index) => (
 171                     <TableCell key={column.key || index} className={currentRoute === '/workflows' ? classes.tableCellWorkflows : classes.tableCell}>
 172                         {column.render(item)}
 173                     </TableCell>
 174                 ))}
 175             </TableRow>;
 176         }
 177
 178         mapVisibleColumns = (fn: (column: DataColumn<T>, index: number) => React.ReactElement<any>) => {
 179             return this.props.columns.filter(column => column.selected).map(fn);
 180         }
 181
 182         handleRowContextMenu = (item: T) =>
 183             (event: React.MouseEvent<HTMLElement>) =>
 184                 this.props.onContextMenu(event, item)
 185
 186     }
 187 );