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<I, R> = Array<DataColumn<I, R>>;
  18
  19 export enum DataTableFetchMode {
  20     PAGINATED,
  21     INFINITE
  22 }
  23
  24 export interface DataTableDataProps<I> {
  25     items: I[];
  26     columns: DataColumns<I, any>;
  27     onRowClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
  28     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: I) => void;
  29     onRowDoubleClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
  30     onSortToggle: (column: DataColumn<I, any>) => void;
  31     onFiltersChange: (filters: DataTableFilters, column: DataColumn<I, any>) => void;
  32     extractKey?: (item: I) => 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         color: '#737373'
  66
  67     },
  68     tableCellWorkflows: {
  69         '&:nth-last-child(2)': {
  70             padding: '0px',
  71             maxWidth: '48px'
  72         },
  73         '&:last-child': {
  74             padding: '0px',
  75             paddingRight: '24px',
  76             width: '48px'
  77         }
  78     },
  79     arrow: {
  80         margin: 0
  81     },
  82     arrowButton: {
  83         color: theme.palette.text.primary
  84     }
  85 });
  86
  87 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules>;
  88
  89 export const DataTable = withStyles(styles)(
  90     class Component<T> extends React.Component<DataTableProps<T>> {
  91         render() {
  92             const { items, classes, working } = this.props;
  93             return <div className={classes.root}>
  94                 <div className={classes.content}>
  95                     <Table>
  96                         <TableHead>
  97                             <TableRow>
  98                                 {this.mapVisibleColumns(this.renderHeadCell)}
  99                             </TableRow>
 100                         </TableHead>
 101                         <TableBody className={classes.tableBody}>
 102                             { !working && items.map(this.renderBodyRow) }
 103                         </TableBody>
 104                     </Table>
 105                     { !!working &&
 106                         <div className={classes.loader}>
 107                             <DataTableDefaultView
 108                                 icon={PendingIcon}
 109                                 messages={['Loading data, please wait.']} />
 110                         </div> }
 111                     {items.length === 0 && !working && this.renderNoItemsPlaceholder(this.props.columns)}
 112                 </div>
 113             </div>;
 114         }
 115
 116         renderNoItemsPlaceholder = (columns: DataColumns<T, any>) => {
 117             const dirty = columns.some((column) => getTreeDirty('')(column.filters));
 118             return <DataTableDefaultView
 119                 icon={this.props.defaultViewIcon}
 120                 messages={this.props.defaultViewMessages}
 121                 filtersApplied={dirty} />;
 122         }
 123
 124         renderHeadCell = (column: DataColumn<T, any>, index: number) => {
 125             const { name, key, renderHeader, filters, sort } = column;
 126             const { onSortToggle, onFiltersChange, classes } = this.props;
 127             return <TableCell className={classes.tableCell} key={key || index}>
 128                 {renderHeader ?
 129                     renderHeader() :
 130                     countNodes(filters) > 0
 131                         ? <DataTableFiltersPopover
 132                             name={`${name} filters`}
 133                             mutuallyExclusive={column.mutuallyExclusiveFilters}
 134                             onChange={filters =>
 135                                 onFiltersChange &&
 136                                 onFiltersChange(filters, column)}
 137                             filters={filters}>
 138                             {name}
 139                         </DataTableFiltersPopover>
 140                         : sort
 141                             ? <TableSortLabel
 142                                 active={sort.direction !== SortDirection.NONE}
 143                                 direction={sort.direction !== SortDirection.NONE ? sort.direction : undefined}
 144                                 IconComponent={this.ArrowIcon}
 145                                 hideSortIcon
 146                                 onClick={() =>
 147                                     onSortToggle &&
 148                                     onSortToggle(column)}>
 149                                 {name}
 150                             </TableSortLabel>
 151                             : <span>
 152                                 {name}
 153                             </span>}
 154             </TableCell>;
 155         }
 156
 157         ArrowIcon = ({ className, ...props }: SvgIconProps) => (
 158             <IconButton component='span' className={this.props.classes.arrowButton} tabIndex={-1}>
 159                 <ArrowDownwardIcon {...props} className={classnames(className, this.props.classes.arrow)} />
 160             </IconButton>
 161         )
 162
 163         renderBodyRow = (item: any, index: number) => {
 164             const { onRowClick, onRowDoubleClick, extractKey, classes, currentItemUuid, currentRoute } = this.props;
 165             return <TableRow
 166                 hover
 167                 key={extractKey ? extractKey(item) : index}
 168                 onClick={event => onRowClick && onRowClick(event, item)}
 169                 onContextMenu={this.handleRowContextMenu(item)}
 170                 onDoubleClick={event => onRowDoubleClick && onRowDoubleClick(event, item)}
 171                 selected={item === currentItemUuid}>
 172                 {this.mapVisibleColumns((column, index) => <TableCell key={column.key || index} className={currentRoute === '/workflows' ? classes.tableCellWorkflows : classes.tableCell}>
 173                         {column.render(item)}
 174                     </TableCell>
 175                 )}
 176             </TableRow>;
 177         }
 178
 179         mapVisibleColumns = (fn: (column: DataColumn<T, any>, index: number) => React.ReactElement<any>) => {
 180             return this.props.columns.filter(column => column.selected).map(fn);
 181         }
 182
 183         handleRowContextMenu = (item: T) =>
 184             (event: React.MouseEvent<HTMLElement>) =>
 185                 this.props.onContextMenu(event, item)
 186
 187     }
 188 );