src/components/data-explorer/data-explorer.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 { Grid, Paper, Toolbar, StyleRulesCallback, withStyles, WithStyles, TablePagination, IconButton } from '@material-ui/core';
   7 import MoreVertIcon from "@material-ui/icons/MoreVert";
   8 import { ColumnSelector } from "../column-selector/column-selector";
   9 import { DataTable, DataColumns } from "../data-table/data-table";
  10 import { DataColumn, SortDirection } from "../data-table/data-column";
  11 import { DataTableFilterItem } from '../data-table-filters/data-table-filters';
  12 import { SearchInput } from '../search-input/search-input';
  13 import { ArvadosTheme } from "~/common/custom-theme";
  14
  15 type CssRules = 'searchBox' | "toolbar";
  16
  17 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
  18     searchBox: {
  19         paddingBottom: theme.spacing.unit * 2
  20     },
  21     toolbar: {
  22         paddingTop: theme.spacing.unit * 2
  23     },
  24 });
  25
  26 interface DataExplorerDataProps<T> {
  27     items: T[];
  28     itemsAvailable: number;
  29     columns: DataColumns<T>;
  30     searchValue: string;
  31     rowsPerPage: number;
  32     rowsPerPageOptions: number[];
  33     page: number;
  34     contextMenuColumn: boolean;
  35     dataTableDefaultView?: React.ReactNode;
  36 }
  37
  38 interface DataExplorerActionProps<T> {
  39     onSetColumns: (columns: DataColumns<T>) => void;
  40     onSearch: (value: string) => void;
  41     onRowClick: (item: T) => void;
  42     onRowDoubleClick: (item: T) => void;
  43     onColumnToggle: (column: DataColumn<T>) => void;
  44     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: T) => void;
  45     onSortToggle: (column: DataColumn<T>) => void;
  46     onFiltersChange: (filters: DataTableFilterItem[], column: DataColumn<T>) => void;
  47     onChangePage: (page: number) => void;
  48     onChangeRowsPerPage: (rowsPerPage: number) => void;
  49     extractKey?: (item: T) => React.Key;
  50 }
  51
  52 type DataExplorerProps<T> = DataExplorerDataProps<T> & DataExplorerActionProps<T> & WithStyles<CssRules>;
  53
  54 export const DataExplorer = withStyles(styles)(
  55     class DataExplorerGeneric<T> extends React.Component<DataExplorerProps<T>> {
  56         componentDidMount() {
  57             if (this.props.onSetColumns) {
  58                 this.props.onSetColumns(this.props.columns);
  59             }
  60         }
  61         render() {
  62             const {
  63                 columns, onContextMenu, onFiltersChange, onSortToggle, extractKey,
  64                 rowsPerPage, rowsPerPageOptions, onColumnToggle, searchValue, onSearch,
  65                 items, itemsAvailable, onRowClick, onRowDoubleClick, classes,
  66                 dataTableDefaultView
  67             } = this.props;
  68             return <Paper>
  69                 <Toolbar className={classes.toolbar}>
  70                     <Grid container justify="space-between" wrap="nowrap" alignItems="center">
  71                         <div className={classes.searchBox}>
  72                             <SearchInput
  73                                 value={searchValue}
  74                                 onSearch={onSearch} />
  75                         </div>
  76                         <ColumnSelector
  77                             columns={columns}
  78                             onColumnToggle={onColumnToggle} />
  79                     </Grid>
  80                 </Toolbar>
  81                 <DataTable
  82                     columns={this.props.contextMenuColumn ? [...columns, this.contextMenuColumn] : columns}
  83                     items={items}
  84                     onRowClick={(_, item: T) => onRowClick(item)}
  85                     onContextMenu={onContextMenu}
  86                     onRowDoubleClick={(_, item: T) => onRowDoubleClick(item)}
  87                     onFiltersChange={onFiltersChange}
  88                     onSortToggle={onSortToggle}
  89                     extractKey={extractKey}
  90                     defaultView={dataTableDefaultView}
  91                 />
  92                 <Toolbar>
  93                     <Grid container justify="flex-end">
  94                         <TablePagination
  95                             count={itemsAvailable}
  96                             rowsPerPage={rowsPerPage}
  97                             rowsPerPageOptions={rowsPerPageOptions}
  98                             page={this.props.page}
  99                             onChangePage={this.changePage}
 100                             onChangeRowsPerPage={this.changeRowsPerPage}
 101                             component="div" />
 102                     </Grid>
 103                 </Toolbar>
 104             </Paper>;
 105         }
 106
 107         changePage = (event: React.MouseEvent<HTMLButtonElement>, page: number) => {
 108             this.props.onChangePage(page);
 109         }
 110
 111         changeRowsPerPage: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement> = (event) => {
 112             this.props.onChangeRowsPerPage(parseInt(event.target.value, 10));
 113         }
 114
 115         renderContextMenuTrigger = (item: T) =>
 116             <Grid container justify="flex-end">
 117                 <IconButton onClick={event => this.props.onContextMenu(event, item)}>
 118                     <MoreVertIcon />
 119                 </IconButton>
 120             </Grid>
 121
 122         contextMenuColumn: DataColumn<any> = {
 123             name: "Actions",
 124             selected: true,
 125             configurable: false,
 126             sortDirection: SortDirection.NONE,
 127             filters: [],
 128             key: "context-actions",
 129             render: this.renderContextMenuTrigger
 130         };
 131     }
 132 );