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