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, Tooltip } 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     working?: boolean;
  37 }
  38
  39 interface DataExplorerActionProps<T> {
  40     onSetColumns: (columns: DataColumns<T>) => void;
  41     onSearch: (value: string) => void;
  42     onRowClick: (item: T) => void;
  43     onRowDoubleClick: (item: T) => void;
  44     onColumnToggle: (column: DataColumn<T>) => void;
  45     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: T) => void;
  46     onSortToggle: (column: DataColumn<T>) => void;
  47     onFiltersChange: (filters: DataTableFilterItem[], column: DataColumn<T>) => void;
  48     onChangePage: (page: number) => void;
  49     onChangeRowsPerPage: (rowsPerPage: number) => void;
  50     extractKey?: (item: T) => React.Key;
  51 }
  52
  53 type DataExplorerProps<T> = DataExplorerDataProps<T> & DataExplorerActionProps<T> & WithStyles<CssRules>;
  54
  55 export const DataExplorer = withStyles(styles)(
  56     class DataExplorerGeneric<T> extends React.Component<DataExplorerProps<T>> {
  57         componentDidMount() {
  58             if (this.props.onSetColumns) {
  59                 this.props.onSetColumns(this.props.columns);
  60             }
  61         }
  62         render() {
  63             const {
  64                 columns, onContextMenu, onFiltersChange, onSortToggle, working, extractKey,
  65                 rowsPerPage, rowsPerPageOptions, onColumnToggle, searchValue, onSearch,
  66                 items, itemsAvailable, onRowClick, onRowDoubleClick, classes,
  67                 dataTableDefaultView
  68             } = this.props;
  69             return <Paper>
  70                 <Toolbar className={classes.toolbar}>
  71                     <Grid container justify="space-between" wrap="nowrap" alignItems="center">
  72                         <div className={classes.searchBox}>
  73                             <SearchInput
  74                                 value={searchValue}
  75                                 onSearch={onSearch} />
  76                         </div>
  77                         <ColumnSelector
  78                             columns={columns}
  79                             onColumnToggle={onColumnToggle} />
  80                     </Grid>
  81                 </Toolbar>
  82                 <DataTable
  83                     columns={this.props.contextMenuColumn ? [...columns, this.contextMenuColumn] : columns}
  84                     items={items}
  85                     onRowClick={(_, item: T) => onRowClick(item)}
  86                     onContextMenu={onContextMenu}
  87                     onRowDoubleClick={(_, item: T) => onRowDoubleClick(item)}
  88                     onFiltersChange={onFiltersChange}
  89                     onSortToggle={onSortToggle}
  90                     extractKey={extractKey}
  91                     working={working}
  92                     defaultView={dataTableDefaultView}
  93                 />
  94                 <Toolbar>
  95                     <Grid container justify="flex-end">
  96                         <TablePagination
  97                             count={itemsAvailable}
  98                             rowsPerPage={rowsPerPage}
  99                             rowsPerPageOptions={rowsPerPageOptions}
 100                             page={this.props.page}
 101                             onChangePage={this.changePage}
 102                             onChangeRowsPerPage={this.changeRowsPerPage}
 103                             component="div" />
 104                     </Grid>
 105                 </Toolbar>
 106             </Paper>;
 107         }
 108
 109         changePage = (event: React.MouseEvent<HTMLButtonElement>, page: number) => {
 110             this.props.onChangePage(page);
 111         }
 112
 113         changeRowsPerPage: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement> = (event) => {
 114             this.props.onChangeRowsPerPage(parseInt(event.target.value, 10));
 115         }
 116
 117         renderContextMenuTrigger = (item: T) =>
 118             <Grid container justify="flex-end">
 119                 <Tooltip title="More options">
 120                     <IconButton onClick={event => this.props.onContextMenu(event, item)}>
 121                         <MoreVertIcon />
 122                     </IconButton>
 123                 </Tooltip>
 124             </Grid>
 125
 126         contextMenuColumn: DataColumn<any> = {
 127             name: "Actions",
 128             selected: true,
 129             configurable: false,
 130             sortDirection: SortDirection.NONE,
 131             filters: [],
 132             key: "context-actions",
 133             render: this.renderContextMenuTrigger
 134         };
 135     }
 136 );