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