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     defaultIcon: IconType;
  49     defaultMessages: string[];
  50     contextMenuColumn: boolean;
  51     noItemsPlaceholder?: React.ReactNode;
  52 }
  53
  54 interface DataExplorerActionProps<T> {
  55     onSetColumns: (columns: DataColumns<T>) => void;
  56     onSearch: (value: string) => void;
  57     onRowClick: (item: T) => void;
  58     onRowDoubleClick: (item: T) => void;
  59     onColumnToggle: (column: DataColumn<T>) => void;
  60     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: T) => void;
  61     onSortToggle: (column: DataColumn<T>) => void;
  62     onFiltersChange: (filters: DataTableFilterItem[], column: DataColumn<T>) => void;
  63     onChangePage: (page: number) => void;
  64     onChangeRowsPerPage: (rowsPerPage: number) => void;
  65     extractKey?: (item: T) => React.Key;
  66 }
  67
  68 type DataExplorerProps<T> = DataExplorerDataProps<T> & DataExplorerActionProps<T> & WithStyles<CssRules>;
  69
  70 export const DataExplorer = withStyles(styles)(
  71     class DataExplorerGeneric<T> extends React.Component<DataExplorerProps<T>> {
  72         componentDidMount() {
  73             if (this.props.onSetColumns) {
  74                 this.props.onSetColumns(this.props.columns);
  75             }
  76         }
  77         render() {
  78             const {
  79                 columns, onContextMenu, onFiltersChange, onSortToggle, extractKey,
  80                 rowsPerPage, rowsPerPageOptions, onColumnToggle, searchValue, onSearch,
  81                 items, itemsAvailable, onRowClick, onRowDoubleClick, defaultIcon, defaultMessages, classes,
  82                 noItemsPlaceholder
  83             } = this.props;
  84             return <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={this.props.contextMenuColumn ? [...columns, this.contextMenuColumn] : columns}
  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                     noItemsPlaceholder={noItemsPlaceholder}
 107                 />
 108                 <Toolbar>
 109                     <Grid container justify="flex-end">
 110                         <TablePagination
 111                             count={itemsAvailable}
 112                             rowsPerPage={rowsPerPage}
 113                             rowsPerPageOptions={rowsPerPageOptions}
 114                             page={this.props.page}
 115                             onChangePage={this.changePage}
 116                             onChangeRowsPerPage={this.changeRowsPerPage}
 117                             component="div" />
 118                     </Grid>
 119                 </Toolbar>
 120             </Paper>;
 121         }
 122
 123         changePage = (event: React.MouseEvent<HTMLButtonElement>, page: number) => {
 124             this.props.onChangePage(page);
 125         }
 126
 127         changeRowsPerPage: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement> = (event) => {
 128             this.props.onChangeRowsPerPage(parseInt(event.target.value, 10));
 129         }
 130
 131         renderContextMenuTrigger = (item: T) =>
 132             <Grid container justify="flex-end">
 133                 <IconButton onClick={event => this.props.onContextMenu(event, item)}>
 134                     <MoreVertIcon />
 135                 </IconButton>
 136             </Grid>
 137
 138         contextMenuColumn: DataColumn<any> = {
 139             name: "Actions",
 140             selected: true,
 141             configurable: false,
 142             sortDirection: SortDirection.NONE,
 143             filters: [],
 144             key: "context-actions",
 145             render: this.renderContextMenuTrigger,
 146             width: "auto"
 147         };
 148     }
 149 );